Sign in

v1

latestOpenAPI 3.0.02026-07-26492143.5 KB
Organization

Get data export status

This endpoint retrieves the status of a data export job and optionally downloads the export file (as CSV) if the export has completed successfully.

Use the data_export_id returned by the Export data endpoint to check progress.

get/export_status

Query parameters

user_idstring required

The ID of the user requesting the export status.

data_export_idstring required

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

downloadboolean

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_idstring

The unique identifier of the data export job.

state'REQUESTED' | 'IN_PROGRESS' | 'COMPLETED' | 'FAILED'

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.
created_tsstring date-time

Timestamp when the export was created (ISO 8601).

finished_tsstring date-time

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