Skip to main content

Get Campaign Progress

Get the current progress of a campaign
1 min read
get/api/v1/campaign/{campaign_id}/progress
Request example
Response
get/api/v1/campaign/{campaign_id}/progress

Returns a real-time snapshot of how many contacts have been processed.

FieldDescription
totalTotal number of contacts in the campaign
processedContacts that have been attempted at least once
completedContacts with a successful call outcome
failedContacts that exhausted all retry attempts without success
pendingContacts not yet attempted
completion_percentageprocessed / total × 100

Path parameters

campaign_idintegerrequired#

Headers

authorizationstring · null#
X-API-Keystring · null#

Responses

application/json
Successful Response
campaign_idintegerrequired#
statestringrequired#
total_rowsintegerrequired#
processed_rowsintegerrequired#
failed_callsintegerrequired#
progress_percentagenumberrequired#
source_syncobjectrequired#
rate_limitintegerrequired#
started_atstring · nullrequired#
Show child attributes
completed_atstring · nullrequired#
Show child attributes