Guides

Export large results

Get access to the full results using an asynchronous task.

Sometimes you need to get access to the full list of documents, the full list of your entities or any large result.
To do that, you can either make multiple requests using the Pagination or use an asynchronous task.

This asynchronous task will be faster than doing multiple requests.

The download urls are valid for the next 5 minutes.

You can only have one running export task at a time.

Task results are deleted after 1 week.

loop [Polling status] POST /[endpoint]/export Create task 202 Accepted {task_id} GET /tasks/{task_id}/status Task status Save results. Update status POST /tasks/{task_id}/download 200 OK {urls} Use the download urls to get the results Client API Task
Sequence diagram showing a successful export

Exporting a large result consists of three steps:

  1. Asking for a export task, using POST /[endpoint]/export.
  2. Polling the status of the task, using GET /tasks/{task_id}/status.
  3. Retrieving download urls, using POST /tasks/{task_id}/download.

Exports consists of one or multiple csv files. Columns order might change between releases.