Skip to main content
POST
/
executions
/
batches
/
get
Get batch statistics
curl --request POST \
  --url https://api.kaizenautomation.com/executions/batches/get \
  --header 'Content-Type: application/json' \
  --data '{
  "batchId": "<string>"
}'
{
  "name": "<string>",
  "statistics": {
    "total": 123,
    "completed": 123,
    "failed": 123,
    "inProgress": 123,
    "executionDownloadsCreated": 123,
    "executionDownloadsFinished": 123
  },
  "batchDownload": {
    "status": "<string>"
  }
}

Body

application/json

Request to get a specific batch

batchId
string
required

External ID of the batch to get

Response

Batch statistics retrieved successfully

Batch response

name
string
required

Name of the execution batch

statistics
object
required
batchDownload
object | null
required

Batch download information, null if no batch download exists

  • Pending Batch Download
  • InProgress Batch Download
  • Completed Batch Download
  • Failed Batch Download
I