Sign in

v51

latestOpenAPI 3.0.3raw.githubusercontent.com2026-08-02172186551.1 KB

Get broadcast progress

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

get/v1/broadcasts/{broadcastId}/progress

Path parameters

broadcastIdstring required

Response

Broadcast progress.

broadcastIdstring required
status'draft' | 'pending_review' | 'approved' | 'rejected' | 'escalated' | 'rejected_final' | 'scheduled' | 'sending' | 'paused' | 'completed' | 'cancelled' | 'failed' required

Current status of the broadcast.

totalinteger required

Total contacts in broadcast.

pendinginteger required

Not yet queued for sending.

sendinginteger required

Currently being sent.

deliveredinteger required

Successfully delivered.

failedinteger required

Failed to deliver.

skippedinteger required

Skipped (broadcast cancelled).

percentCompletenumber required

Percentage complete (0-100).

estimatedCostnumber nullable

Estimated total cost in USD.

reservedAmountnumber nullable

Amount reserved from balance in USD.

actualCostnumber nullable

Actual cost so far in USD.

startedAtstring date-time
estimatedCompletionAtstring date-time