v3

latestOpenAPI 3.1.02026-07-318648277.6 KB
Bulk Jobs

Get Bulk Job Status

Retrieve the current status and progress of a specific bulk job. Accepts progress-token auth from the submit response.

get/bulk/jobs/{jobId}

Path parameters

jobIdstring uuid required

UUID identifier of the bulk job.

Response

Current status of the requested bulk job.

job_idstring uuid required
statusstring required
productsstring[] nullable
submission_productstring nullable
submission_endpointstring nullable
execution_modestring nullable
total_rowsinteger required
processed_itemsinteger required
succeeded_itemsinteger required
failed_itemsinteger required
skipped_itemsinteger required
total_credits_consumedstring nullable
total_duration_msinteger nullable
created_atstring date-time required
started_atstring date-time nullable
completed_atstring date-time nullable
last_progress_atstring date-time nullable
file_namestring nullable
callback_urlstring nullable
callback_eventstring nullable
priorityinteger nullable
{"stackTrail":"components:schemas:JobDetailResponse:allOf:properties:output_transform","oasType":"schema","type":"unknown","nullable":true}