Skip to main content
GET
/
v1
/
batches
/
{batch_id}
/
progress
Get batch progress
curl --request GET \
  --url https://sdk.nimbleway.com/v1/batches/{batch_id}/progress \
  --header 'Authorization: Bearer <token>'
{
  "status": "success",
  "id": "string",
  "completed": true,
  "completed_count": 1,
  "completed_at": "string",
  "progress": 1
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
batch_id
string
required

The unique identifier of the batch.

Example:

"123e4567-e89b-12d3-a456-426614174000"

Response

Batch progress returned successfully.

Lightweight batch progress without task details.

​
status
string
required
Allowed value: "success"
​
id
string
required

Unique identifier for the batch.

​
completed
boolean
required

Whether all tasks in the batch have finished.

​
completed_count
number
required

Number of tasks that have completed so far.

​
progress
number
required

Completion ratio between 0 and 1.

​
completed_at
string

ISO timestamp when the batch completed.