Get broadcast progress

Get real-time progress of a broadcast including delivery counts and estimated completion time.

GET /v1/broadcasts/{broadcastId}/progress

Get broadcast progress

cURL

curl --request GET \
  --url https://api.zavu.dev/v1/broadcasts/{broadcastId}/progress \
  --header 'Authorization: Bearer <token>'

200

{
  "broadcastId": "brd_abc123",
  "status": "sending",
  "total": 5000,
  "pending": 2500,
  "sending": 100,
  "delivered": 2350,
  "failed": 50,
  "skipped": 0,
  "percentComplete": 48,
  "estimatedCost": 75,
  "reservedAmount": 75,
  "actualCost": 35.25,
  "startedAt": "2024-01-15T10:30:00.000Z",
  "estimatedCompletionAt": "2024-01-15T10:45:00.000Z"
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

broadcastId · string · required

Response

200

application/json

Broadcast progress.

broadcastId · string · required

status · enum<string> · required

Current status of the broadcast.

Available options: draft, pending_review, approved, rejected, escalated, rejected_final, scheduled, sending, paused, completed, cancelled, failed

total · integer · required

Total contacts in broadcast.

pending · integer · required

Not yet queued for sending.

sending · integer · required

Currently being sent.

delivered · integer · required

Successfully delivered.

failed · integer · required

Failed to deliver.

skipped · integer · required

Skipped (broadcast cancelled).

percentComplete · number · required

Percentage complete (0-100).

estimatedCost · number | null

Estimated total cost in USD.

reservedAmount · number | null

Amount reserved from balance in USD.

actualCost · number | null

Actual cost so far in USD.

startedAt · string<date-time>

estimatedCompletionAt · string<date-time>