SDK ReferenceBatch

Get Batch

Get a batch summary, including runtime progress when the batch has been processed.

Path parameters

batchIdstringRequired
The batch ID.

Response

Batch summary
batch_idstringOptional
completed_atstringOptional
created_atstringOptional
ignore_roleslist of enumsOptional
item_countintegerOptional
metadatamap from strings to anyOptional
processed_atstringOptional
progressobjectOptional
statusenumOptional
updated_atstringOptional

Errors

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