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 |
GET
/api/v1/campaign/{campaign_id}/progressParameters#
| Name | Located in | Type | Required | Description |
|---|---|---|---|---|
campaign_id | path | integer | Yes | — |
Responses#
200 — Successful Response
{
"campaign_id": 0,
"state": "string",
"total_rows": 0,
"processed_rows": 0,
"failed_calls": 0,
"progress_percentage": 0,
"source_sync": {},
"rate_limit": 0,
"started_at": "2026-01-15T10:30:00Z",
"completed_at": "2026-01-15T10:30:00Z"
}404 — Not found
422 — Validation Error
{
"detail": [
{
"loc": [
"string"
],
"msg": "string",
"type": "string"
}
]
}