Skip to main content
GET
Get Campaign Progress
Requires a Labs OAuth user access token with the super_user role. API keys are not accepted for this endpoint. See authentication. Returns a real-time snapshot of how many contacts have been processed.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

campaign_id
integer
required

Response

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