Batches

Get batch progress

Changed on

Retrieve lightweight progress information for a batch without fetching all task details.

get/v1/batches/{batch_id}/progress

Request

  • Base URL
    https://sdk.nimbleway.com
  • URL
    https://sdk.nimbleway.com/v1/batches/{batch_id}/progress
  • Auth
    HTTP bearer

Path parameters

batch_idstring required

The unique identifier of the batch.

Example:123e4567-e89b-12d3-a456-426614174000

Response

Batch progress returned successfully.

completedboolean required

Whether all tasks in the batch have finished.

completed_atstring

ISO timestamp when the batch completed.

completed_countnumber required

Number of tasks that have completed so far.

idstring required

Unique identifier for the batch.

progressnumber required

Completion ratio between 0 and 1.

status'success' required

Changes