Skip to main content
GET
/
export_status
Get data export status
curl --request GET \
  --url https://api.gumloop.com/api/v1/export_status \
  --header 'Authorization: Bearer <token>'
{
  "data_export_id": "<string>",
  "state": "REQUESTED",
  "created_ts": "2023-11-07T05:31:56Z",
  "finished_ts": "2023-11-07T05:31:56Z"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

​
user_id
string
required

The ID of the user requesting the export status.

​
data_export_id
string
required

The unique identifier of the data export job to check (returned by the Export data endpoint).

​
download
boolean
default:false

Set to true to download the export file directly when the export is completed. When true and the export state is COMPLETED, the response will be a CSV file download instead of JSON.

Response

Export status retrieved successfully. If download=true and the export state is COMPLETED, the response body will be the CSV file.

​
data_export_id
string

The unique identifier of the data export job.

​
state
enum<string>

Current state of the export job:

  • REQUESTED — The export has been created and is queued for processing.
  • IN_PROGRESS — The export is currently being processed.
  • COMPLETED — The export finished successfully and is available for download.
  • FAILED — The export encountered an error.
Available options:
REQUESTED,
IN_PROGRESS,
COMPLETED,
FAILED
​
created_ts
string<date-time>

Timestamp when the export was created (ISO 8601).

​
finished_ts
string<date-time>

Timestamp when the export finished (ISO 8601). Only present when the state is COMPLETED or FAILED.