Preview. Part of the Migration API — in active design and not yet generally
available. Endpoints and payloads may change. See the
overview.
Authentication
Requires anx-api-key header. See Authentication.
Request body
full exports every validated row. canary exports the first row of each
template — a safe smoke test against the destination before a full run.Optional narrowing, e.g.
{ "template_ids": ["..."], "row_filter": { } }. Omit
to export everything validated.Makes export run creation safe to retry. See the duplicate-write note below.
Response
201 Created
GET /api/v1/companies/{id}/exports/{run_id} until terminal. A completed
report partitions every write:
results[]
with its ok flag, the destination’s HTTP status, and an error on the ones
that failed (ok: false). Only job-level problems (bad credentials, destination
down) mark the whole run failed. When the destination’s schema drifts, the fix
is to re-author the writer in the UI, publish a new version, and re-run — not
an in-flight agent.
Hollow writes. When a writer authors a read-back
verify, each row carries
fields_confirmed: true if a mapped field was found in the written record,
false if it came back empty (a hollow write — a 2xx the destination
accepted but that didn’t actually stick), or null when no verify ran. A
2xx with fields_confirmed: false is a silent drop worth alerting on.Next
- Export CSV — pull the validated data out as a file instead.
- Errors & idempotency — the dedup model.