Get Campaign Progress

Get the current progress of a campaign

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

Get Campaign Progress

cURL

curl --request GET \
  --url https://app.dograh.com/api/v1/campaign/{campaign_id}/progress

200

{
  "campaign_id": 123,
  "state": "<string>",
  "total_rows": 123,
  "processed_rows": 123,
  "failed_calls": 123,
  "progress_percentage": 123,
  "source_sync": {},
  "rate_limit": 123,
  "started_at": "2023-11-07T05:31:56Z",
  "completed_at": "2023-11-07T05:31:56Z"
}

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

Headers

authorization · string | null

X-API-Key · string | null

Path Parameters

campaign_id · integer · required

Response

200

application/json

Successful Response

campaign_id · integer · required

state · string · required

total_rows · integer · required

processed_rows · integer · required

failed_calls · integer · required

progress_percentage · number · required

source_sync · Source Sync · object · required

rate_limit · integer · required

started_at · string<date-time> | null · required

completed_at · string<date-time> | null · required