Users

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/users/@me/harvest/{harvestId}

Path parameters

harvestIdstring required

The harvestId

Success

harvest_idstring required

Unique identifier for the harvest request

status'pending' | 'processing' | 'completed' | 'failed' required

Current status of the harvest request

created_atstring required

ISO 8601 timestamp when the harvest request was created

started_atstring nullable required

ISO 8601 timestamp when the harvest started, or null if pending

completed_atstring nullable required

ISO 8601 timestamp when the harvest completed, or null otherwise

failed_atstring nullable required

ISO 8601 timestamp when the harvest failed, or null otherwise

file_sizestring nullable required

Final file size of the downloaded data, expressed as a string, or null if not available

progress_percentnumber required

Harvest progress as a percentage value between 0 and 100

progress_stepstring nullable required

Textual description of the current harvest step, if available

error_messagestring nullable required

Error message when the harvest fails, or null otherwise

download_url_expires_atstring nullable required

ISO 8601 timestamp when the download URL expires, or null if unavailable

expires_atstring nullable required

ISO 8601 timestamp when the harvest download expires, or null if unavailable

No recorded changes to this endpoint across all 1 revision of this API.