Skip to navigation
Runtype APIBatch

Get batch execution status

Returns the current status and progress of a batch execution.

Authentication

AuthorizationBearer
API key or Clerk session token

Path parameters

idstringRequired
Batch execution ID

Response

Batch status
batchExecutionIdstring
failedRecordsinteger
flowIdstring
processedRecordsinteger
startedAtstring
statusstring
totalRecordsinteger
completedAtstringOptional
executionEngineSummaryenumOptional

Run-level engine summary derived from the batch’s per-record executionEngine values: ‘runtime’ or ‘legacy’ when every attributed record ran on that engine, ‘mixed’ when the batch spans both (e.g. a mid-flight fallback), and null when the run has no attributed records (runs recorded before attribution shipped).

Allowed values:
progressintegerOptional
resultslist of anyOptional
successCountintegerOptional

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
500
Internal Server Error