Get Batch Progress

GEThttps://api.trillet.ai/v1/api/batch-calls/{batchId}/status

Headers

x-api-keystringrequired

API key used for authenticating requests to the API.

x-workspace-idstringrequired

Workspace identifier for the API.

Path Parameters

batchIdstringrequired

The unique identifier of the batch call operation

Response

statusstring

Current status of the batch operation

isCompleteboolean

Whether the batch operation has finished

waitingnumber

Number of calls waiting in queue

activenumber

Number of calls currently being processed

completednumber

Number of successfully completed calls

failednumber

Number of failed calls

totalnumber

Total number of calls in the batch

startTimenumber

Timestamp when the batch started processing

lastCompletedTimenumber

Timestamp of the last completed call

completedTimenumber

Timestamp when the batch was completed (if finished)

averageCallDurationnumber

Average duration of completed calls in seconds

recent_callsarray

Array of recent call results for monitoring

Example Usage

curl -X GET "https://api.trillet.ai/v1/api/batch-calls/batch_7891011121314/status" \
  -H "x-api-key: YOUR_API_KEY" \
  -H "x-workspace-id: YOUR_WORKSPACE_ID"

Example Response

{
  "status": "processing",
  "isComplete": false,
  "waiting": 45,
  "active": 5,
  "completed": 95,
  "failed": 5,
  "total": 150,
  "startTime": 1703097600000,
  "lastCompletedTime": 1703101200000,
  "completedTime": null,
  "averageCallDuration": 45.2,
  "recent_calls": [
    {
      "jobId": "call_123",
      "status": "completed",
      "phone_number": "+1234567890",
      "completedAt": 1703101200000,
      "duration": 42
    },
    {
      "jobId": "call_124", 
      "status": "failed",
      "phone_number": "+1987654321",
      "failedAt": 1703101150000,
      "error": "Number busy"
    }
  ]
}

Error Responses

errorstring

Error message describing what went wrong

Common Error Codes:

500 - Server error retrieving batch progress information

Progress Tracking

This endpoint provides real-time progress updates for your batch call operations. Use it to build dashboards or monitor batch completion in your applications.