Sign in
latestSwagger 2.02026-08-10148196271.0 KB

afaab604b58c

export

Get export files

Get the job status and files for an export started with the "Start export" endpoint. <br/><br/>Occasionally, a job status may change from running to enqueued because it had to restart. When this happens, the job maintains progress and begins where it previously stopped. Iterable uses exponential backoff for retries.<br/><br/>Files are added to the list as the export job is running. Paginate through the files by using the last file name in the response as the <code>startAfter</code> value for the next request. Each file is up to 10MB. Exports are limited to 100GB in total size. <br/><br/><b>Rate limit</b>: 1 request/second, per organization. <br/><b>Concurrent request limit</b>: Up to 4 exports process at a time, per organization. Additional requests are queued.

get/api/export/{jobId}/files

Path parameters

jobIdinteger required

The ID of the export job. Use the jobId returned from the "Start export" endpoint.

Query parameters

startAfterstring

Skip file names up to and including this value. Use for paginating over the files in the export.

Response

successful operation

exportTruncatedboolean required

Whether the export was truncated because it exceeded the max allowed export size

jobIdinteger required

The ID of the export job

jobState'Enqueued' | 'Running' | 'Completed' | 'Failed' required

The state of the export job

Example response

{
  "files": [
    {
      "file": "file-1679086247925.csv"
    }
  ],
  "jobId": 3562,
  "jobState": "Running"
}