Skip to main content
GET
/
users
/
@me
/
harvest
/
{harvestId}
Get data harvest status
curl --request GET \
  --url https://api.fluxer.app/v1/users/@me/harvest/{harvestId} \
  --header 'Authorization: <api-key>'
{
  "harvest_id": "<string>",
  "status": "pending",
  "created_at": "<string>",
  "started_at": "<string>",
  "completed_at": "<string>",
  "failed_at": "<string>",
  "file_size": "<string>",
  "progress_percent": 123,
  "progress_step": "<string>",
  "error_message": "<string>",
  "download_url_expires_at": "<string>",
  "expires_at": "<string>"
}

Authorizations

​
Authorization
string
header
required

Bot token: Authorization: Bot <token>. This is the primary authentication method for bot applications.

Path Parameters

​
harvestId
string
required

The harvestId

Response

Success

​
harvest_id
string
required

Unique identifier for the harvest request

​
status
enum<string>
required

Current status of the harvest request

Available options:
pending,
processing,
completed,
failed
​
created_at
string
required

ISO 8601 timestamp when the harvest request was created

​
started_at
string | null
required

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

​
completed_at
string | null
required

ISO 8601 timestamp when the harvest completed, or null otherwise

​
failed_at
string | null
required

ISO 8601 timestamp when the harvest failed, or null otherwise

​
file_size
string | null
required

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

​
progress_percent
number
required

Harvest progress as a percentage value between 0 and 100

​
progress_step
string | null
required

Textual description of the current harvest step, if available

​
error_message
string | null
required

Error message when the harvest fails, or null otherwise

​
download_url_expires_at
string | null
required

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

​
expires_at
string | null
required

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