Skip to main content
GET
/
batches
/
{batch_id}
cURL
curl --request GET \
  --url https://api.example.com/batches/{batch_id}
{
  "batch": {
    "completed_jobs": 1,
    "config_hash": "<string>",
    "created_at": "2023-11-07T05:31:56Z",
    "failed_jobs": 1,
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "<string>",
    "status": "Pending",
    "total_jobs": 1
  },
  "jobs_by_status": {},
  "throughput_jobs_per_minute": 123,
  "estimated_completion_time_mins": 1
}

Path Parameters

batch_id
string<uuid>
required

Batch identifier

Response

Fetch batch status summary

batch
object
required
jobs_by_status
object
required
throughput_jobs_per_minute
number<double>
required
estimated_completion_time_mins
integer<int32> | null
Required range: x >= 0