API ReferenceCampaigns
Get Campaign Progress
Get the current progress of a campaign
Returns a real-time snapshot of how many contacts have been processed.
| Field | Description |
|---|---|
total | Total number of contacts in the campaign |
processed | Contacts that have been attempted at least once |
completed | Contacts with a successful call outcome |
failed | Contacts that exhausted all retry attempts without success |
pending | Contacts not yet attempted |
completion_percentage | processed / total × 100 |
Path Parameters
campaign_id*Campaign Id
Header Parameters
X-API-Key?string|null
Response Body
application/json
application/json
curl -X GET "https://example.com/api/v1/campaign/0/progress"{ "campaign_id": 0, "state": "string", "total_rows": 0, "processed_rows": 0, "failed_calls": 0, "progress_percentage": 0, "source_sync": {}, "rate_limit": 0, "started_at": "2019-08-24T14:15:22Z", "completed_at": "2019-08-24T14:15:22Z"}