Get aggregate batch progress
Returns the company-scoped aggregate for sessions created with the same `batchRef`. A session becomes processed when its submission reaches `failed`, `review`, `approved`, `synced`, or `capture_quality_blocked`. Capture-quality blocks are included in `counts.failed`; synced rows are included in `counts.approved`. When `processed` equals `total`, Steve waits until the newest session in the batch is at least five minutes old before marking the batch completed and emitting `batch.completed`. A newer session resets the grace check. A client pause longer than five minutes can therefore complete the batch before later uploads arrive; later sessions increase the counts but do not emit a second completion event.
/api/v1/batches/{batchRef}Authorization
AuthorizationRequiredBearer <token>Steve API key, usually scoped to a company. Legacy keys and keys created by platform administrators may be unscoped; company-scoped endpoints reject unscoped keys with 403 Forbidden. Format: Authorization: Bearer aok_...
In: header
Path Parameters
batchRefRequiredstringClient-chosen batch reference.
1Maximum length: 128Pattern: "^[A-Za-z0-9._-]+$"Header Parameters
X-Request-IdstringOptional caller-supplied request identifier. Maximum length is 128 characters.
128Current batch status and aggregate counts