Skip to content

Jobs

GET /v1/jobs

QueryTypeNotes
statusenumqueued|running|succeeded|failed|timed_out|aborted
typeenumsearch|batch_detail|chained_search_detail|building_units
sinceISO timestampcreated_at >= since
limitintdefault 50, max 500
offsetintdefault 0

200 response

{
"data": [
{ "id": "8c2a...", "type": "batch_detail", "status": "succeeded",
"result_count": 213, "error": null, "chain_stage": null,
"created_at": "...", "started_at": "...", "completed_at": "..." }
],
"meta": { "limit": 50, "offset": 0 },
"request_id": "..."
}

GET /v1/jobs/{id}

{
"data": {
"id": "8c2a...",
"type": "chained_search_detail",
"status": "running",
"result_count": null,
"chain_stage": "detail",
"error": null,
"created_at": "...", "started_at": "...", "completed_at": null
},
"request_id": "..."
}

chain_stage is search or detail for chained jobs, null otherwise. For chained_search_detail, status: succeeded means BOTH stages finished.

GET /v1/jobs/{id}/results

Returns paginated rows once status: succeeded.

QueryTypeNotes
limitintdefault 100, max 1000
offsetintdefault 0
formatenumjson (default), csv, ndjson

200 response (JSON)

{
"data": [{ "zpid": "...", "...": "..." }, ...],
"meta": { "count": 200, "total": 8541, "limit": 200, "offset": 400, "has_more": true },
"request_id": "..."
}

Errors

StatusCodeCause
404job_not_foundWrong UUID, or not your account
409job_not_readystatus is not succeeded
502/504upstream_error/upstream_timeoutResult fetch failed