Skip to main content
GET
Poll a 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}$
export_id
string
required

Assigned by the server when a results export is started.

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

Response

Export state (with download_url once complete).

Polled view of a results export. download_url is presigned fresh on every successful poll: stash the metadata, but re-fetch the URL right before you download.

export_id
string
required
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, the poll answers 410 result_expired with no download_url.

error
string

Non-empty only when status = failed. Stable strings: e.g. "results are larger than N gb" when the combined results exceed the export byte cap (100 GiB in production). Omitted otherwise.

download_url
string<uri>

Presigned download URL for the zipped run results. Present only when status = completed. Valid for 2 hours: the server mints a new one on every poll.