ExportJob

An export job. Poll Get Export until `status` is `completed` or `failed`.

Properties

export_idstringrequired

ID of this export. Pass it to Get Export to poll. Valid for 24 hours, after which the job is forgotten.

statusstringrequired

`running` — queued or building. `completed` — `file_url` is ready. `failed` — see `error`. There is no separate queued state; a job is `running` from the moment it is accepted.

"running""completed""failed"

progressintegerrequired

Percent complete, 0-100. Reaches 100 only when `status` is `completed`.

row_countintegerrequired

Rows the export will contain, resolved against the sheet when the job was accepted — a count of rows that actually matched, never an echo of how many `row_ids` were sent.

file_urlstring

Time-limited download link, present only when `status` is `completed`. Minted fresh on every poll and valid for 15 minutes — it is a signed URL, so treat it as a secret and do not log or forward it. Re-poll for a new one after it expires.

expires_atstring <date-time>

When `file_url` stops working (UTC, ISO 8601). Present only alongside `file_url`.

errorstring

Why the export failed. Present only when `status` is `failed`.

createdboolean

Export Sheet only. `true` when this call started the job; `false` when an export was already building for you on this sheet and you were handed that one instead.

started_atstring <date-time>required

When the job was accepted (UTC, ISO 8601).

completed_atnull | string <date-time>required

When the job reached a terminal state (UTC, ISO 8601). `null` while still running.

Example

ExportJob example

{
  "export_id": "string",
  "status": "running",
  "progress": 0,
  "row_count": 0,
  "file_url": "string",
  "expires_at": "1970-01-01T00:00:00.000Z",
  "error": "string",
  "created": false,
  "started_at": "1970-01-01T00:00:00.000Z",
  "completed_at": null
}