Skip to main content
POST
Start an async results export

Authorizations

X-API-Key
string
header
required

Batch, Crawl, the Extract endpoints and the account endpoint read the same key from the X-API-Key header.

Path Parameters

job_id
string
required

Assigned by the server on submit.

Pattern: ^[0-9A-HJKMNP-TV-Z]{26}$
run_id
string
required

Assigned by the server when a run is created (submit or rerun).

Pattern: ^[0-9A-HJKMNP-TV-Z]{26}$

Response

Export accepted; the zip is produced asynchronously.

Returned by createBatchExport.

export_id
string
required

Identifies this export. Use it for getBatchExport.

Pattern: ^[0-9A-HJKMNP-TV-Z]{26}$
status
enum<string>
required

Lifecycle state of a results export.

  • pending: export accepted, not started yet.
  • running: the zip is being produced.
  • completed: download_url will be present.
  • failed : error carries the reason.

Clients must accept values not listed here.

Available options:
pending,
running,
completed,
failed
created_at
string<date-time>
required
expires_at
string<date-time>
required

12 h after created_at. After it, polling the export answers 410 result_expired; once it is cleaned up, 404.