job_id to poll. Use this instead of
Export CSV when the sheet is large enough that a
synchronous download would time out, or when you want several sheets in one
ZIP rather than a request per sheet.
The trade-off is simple: GET .../exports/{slug}.csv is one call and streams
immediately but holds the connection for the whole download; this is two calls
plus polling but doesn’t.
Authentication
Requires anx-api-key header. See Authentication.
Queue the export
string
One template slug — produces a CSV.
string[]
Several template slugs — produces a ZIP, one CSV per sheet. Wins if both
fields are sent.
string[]
Column names to export, in the order you give them. Omit to export every
column. Matched exactly and case-sensitive; an unrecognised name returns
400 rather than being ignored, so a typo can’t quietly leave data out.Applied to each sheet in the job, so a name must exist on every template you
asked for.boolean
default:"false"
Drop columns that hold no data. A column is dropped only when it’s empty in
every row, so each CSV keeps a consistent shape. Empty means an empty
string,
null, or an absent value; whitespace counts as data.Answered from the completed import’s stored per-column coverage, so it
reflects the whole sheet. If that coverage isn’t available — an older import,
or one where profiling didn’t run — the request returns 409
(coverage_unavailable) rather than quietly exporting every column.202 Accepted:
total_rows is known up front, so you can show a progress bar from the first
response.
Poll the job
200 OK. Poll until status is completed or failed.
string
pending → running → completed, or failed.integer | null
Rows written so far. With
total_rows, this drives a progress indicator.integer | null
Size in bytes, once known.
string | null
A time-limited link, present once the job completes. Fetch it promptly and
don’t store it — mint a fresh one by polling again if it lapses.
string
When the export file is deleted. After this the job returns nothing to
download; queue a new one.
string | null
Why the export failed, when it did.
Errors
Example
Next
- Export CSV — the synchronous, single-sheet download.
- Session log — the record of what was imported.