Skip to main content
GET
Get task batch upload status

Authorizations

Authorization
string
header
required

API key authentication. Your API key should start with brb_.

Example: Authorization: Bearer brb_1234567890abcdef

Path Parameters

subnet_id
string
required

The unique identifier of the subnet (ULID format)

Pattern: ^[0-9A-HJKMNP-TV-Z]{26}$
id
string
required

The batch upload ID returned from the upload endpoint

Pattern: ^[0-9A-HJKMNP-TV-Z]{26}$

Response

Batch status retrieved successfully

id
string
required

Batch upload ID

Pattern: ^[0-9A-HJKMNP-TV-Z]{26}$
Example:

"01ARZ3NDEKTSV4RRFFQ69G5FAZ"

status
enum<string>
required

processing while any rows are pending or in progress; completed once all rows have finished

Available options:
processing,
completed
Example:

"processing"

total
integer
required

Total number of rows in the batch

Example:

43

pending
integer
required

Number of rows not yet started

Example:

12

processing
integer
required

Number of rows currently being processed

Example:

3

completed
integer
required

Number of rows successfully processed

Example:

27

failed
integer
required

Number of rows that failed

Example:

1

rows
object[]
required