Skip to main content
Many list endpoints (e.g. /projects, /events) can export their full result as a file through the response_mode query parameter, without paging through it. Supported Endpoints lists them.

​
Response Modes

The response_mode query parameter controls the response format of a list endpoint: Here’s an example query string: /api/v1/projects?response_mode=summary_with_export.

​
Export Format

The export_format query parameter controls the file format when using summary_with_export: Here’s an example: /api/v1/projects?response_mode=summary_with_export&export_format=json.

​
Export Flow

When you request response_mode=summary_with_export, the response includes an export object:
Poll the status_url until status changes to completed. The response will then include a download_url:
The download_url is a temporary URL valid for 24 hours.

​
Supported Endpoints

The list endpoints below can produce a file with response_mode=summary_with_export:
response_mode=summary (count plus 10 samples) works on more list endpoints than the ones above. On a list endpoint that cannot produce a file, such as data point types, project locations, batch evidence or report maps, summary_with_export returns 400.
To export deliveries, call POST /exports with resource_type: "Delivery".
Export creation is restricted to account-level tokens. Customer- and partner-scoped tokens receive a 403 when requesting summary_with_export.

​
Limits

  • Max 5 concurrent exports per account.
  • Max 500 MB file size per export.
  • Download URLs expire after 24 hours.
  • Export records are cleaned up after 7 days.