get/users/@me/harvest/{harvestId}

Get data harvest status

Retrieves detailed status information for a specific data harvest. Shows progress, completion status, and other metadata about the harvest request.

get_data_harvest_status

Parameters

Name	In	Type	Description
harvestId*	path	SnowflakeType	The ID of the harvest request

Responses

200

Success

json

{
  "type": "object",
  "properties": {
    "harvest_id": {
      "description": "Unique identifier for the harvest request",
      "$ref": "#/components/schemas/SnowflakeStringType"
    },
    "status": {
      "$ref": "#/components/schemas/HarvestStatus"
    },
    "created_at": {
      "type": "string",
      "description": "ISO 8601 timestamp when the harvest request was created"
    },
    "started_at": {
      "description": "ISO 8601 timestamp when the harvest started, or null if pending",
      "type": [
        "string",
        "null"
      ]
    },
    "completed_at": {
      "description": "ISO 8601 timestamp when the harvest completed, or null otherwise",
      "type": [
        "string",
        "null"
      ]
    },
    "failed_at": {
      "description": "ISO 8601 timestamp when the harvest failed, or null otherwise",
      "type": [
        "string",
        "null"
      ]
    },
    "file_size": {
      "description": "Final file size of the downloaded data, expressed as a string, or null if not available",
      "type": [
        "string",
        "null"
      ]
    },
    "progress_percent": {
      "type": "number",
      "description": "Harvest progress as a percentage value between 0 and 100"
    },
    "progress_step": {
      "description": "Textual description of the current harvest step, if available",
      "type": [
        "string",
        "null"
      ]
    },
    "error_message": {
      "description": "Error message when the harvest fails, or null otherwise",
      "type": [
        "string",
        "null"
      ]
    },
    "download_url_expires_at": {
      "description": "ISO 8601 timestamp when the download URL expires, or null if unavailable",
      "type": [
        "string",
        "null"
      ]
    },
    "expires_at": {
      "description": "ISO 8601 timestamp when the harvest download expires, or null if unavailable",
      "type": [
        "string",
        "null"
      ]
    }
  },
  "required": [
    "harvest_id",
    "status",
    "created_at",
    "started_at",
    "completed_at",
    "failed_at",
    "file_size",
    "progress_percent",
    "progress_step",
    "error_message",
    "download_url_expires_at",
    "expires_at"
  ],
  "additionalProperties": false
}

400

Bad Request - The request was malformed or contained invalid data

json

{
  "type": "object",
  "properties": {
    "code": {
      "type": "string",
      "description": "Machine-readable error code"
    },
    "message": {
      "type": "string",
      "description": "Human-readable error message"
    },
    "errors": {
      "description": "Field-specific validation errors",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "path": {
            "type": "string",
            "description": "Field path that failed validation"
          },
          "code": {
            "description": "Machine-readable validation error code",
            "type": "string"
          },
          "message": {
            "type": "string",
            "description": "Human-readable validation error message"
          }
        },
        "required": [
          "path",
          "message"
        ],
        "additionalProperties": false
      }
    }
  },
  "required": [
    "code",
    "message"
  ],
  "additionalProperties": {}
}

401

Unauthorized - Authentication is required or the token is invalid

json

{
  "type": "object",
  "properties": {
    "code": {
      "type": "string",
      "description": "Machine-readable error code"
    },
    "message": {
      "type": "string",
      "description": "Human-readable error message"
    },
    "errors": {
      "description": "Field-specific validation errors",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "path": {
            "type": "string",
            "description": "Field path that failed validation"
          },
          "code": {
            "description": "Machine-readable validation error code",
            "type": "string"
          },
          "message": {
            "type": "string",
            "description": "Human-readable validation error message"
          }
        },
        "required": [
          "path",
          "message"
        ],
        "additionalProperties": false
      }
    }
  },
  "required": [
    "code",
    "message"
  ],
  "additionalProperties": {}
}

403

Forbidden - You do not have permission to perform this action

json

{
  "type": "object",
  "properties": {
    "code": {
      "type": "string",
      "description": "Machine-readable error code"
    },
    "message": {
      "type": "string",
      "description": "Human-readable error message"
    },
    "errors": {
      "description": "Field-specific validation errors",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "path": {
            "type": "string",
            "description": "Field path that failed validation"
          },
          "code": {
            "description": "Machine-readable validation error code",
            "type": "string"
          },
          "message": {
            "type": "string",
            "description": "Human-readable validation error message"
          }
        },
        "required": [
          "path",
          "message"
        ],
        "additionalProperties": false
      }
    }
  },
  "required": [
    "code",
    "message"
  ],
  "additionalProperties": {}
}

429

Too Many Requests - You are being rate limited

json

{
  "type": "object",
  "properties": {
    "code": {
      "type": "string",
      "description": "Machine-readable error code"
    },
    "message": {
      "type": "string",
      "description": "Human-readable error message"
    },
    "errors": {
      "description": "Field-specific validation errors",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "path": {
            "type": "string",
            "description": "Field path that failed validation"
          },
          "code": {
            "description": "Machine-readable validation error code",
            "type": "string"
          },
          "message": {
            "type": "string",
            "description": "Human-readable validation error message"
          }
        },
        "required": [
          "path",
          "message"
        ],
        "additionalProperties": false
      }
    },
    "retry_after": {
      "type": "number",
      "description": "Seconds to wait before retrying"
    },
    "global": {
      "type": "boolean",
      "description": "Whether this is a global rate limit"
    }
  },
  "required": [
    "code",
    "message"
  ],
  "additionalProperties": {}
}

500

Internal Server Error - An unexpected error occurred

json

{
  "type": "object",
  "properties": {
    "code": {
      "type": "string",
      "description": "Machine-readable error code"
    },
    "message": {
      "type": "string",
      "description": "Human-readable error message"
    },
    "errors": {
      "description": "Field-specific validation errors",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "path": {
            "type": "string",
            "description": "Field path that failed validation"
          },
          "code": {
            "description": "Machine-readable validation error code",
            "type": "string"
          },
          "message": {
            "type": "string",
            "description": "Human-readable validation error message"
          }
        },
        "required": [
          "path",
          "message"
        ],
        "additionalProperties": false
      }
    }
  },
  "required": [
    "code",
    "message"
  ],
  "additionalProperties": {}
}