campaigns.progress

Dialled, answered, remaining.

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`

Reference

GET/api/v1/campaigns/{campaign_id}/progress

Auth: API key in X-API-Key
Content: none
Returns: 200 · CampaignProgressResponse

Get current campaign progress and statistics

Arguments

Argument	In	Type	Required	Description
`campaign_id`	path	`integer`	required

Example request

curl -X GET "https://api.decibyl.ai/api/v1/campaigns/<campaign_id>/progress" \
  -H "X-API-Key: dcb_your_key"

Response

{
  "campaign_id": 1,
  "state": "string",
  "total_rows": 1,
  "processed_rows": 1,
  "failed_calls": 1,
  "progress_percentage": 1.5,
  "source_sync": {},
  "rate_limit": 1,
  "started_at": "2026-09-14T09:30:00Z",
  "completed_at": "2026-09-14T09:30:00Z"
}

Errors

Status	When
`404`	Not found
`422`	Validation Error