Campaigns

Export campaign results grouped by audience member

View as Markdown

Returns one row per contact in the campaign audience with the outcome of every call attempt for that contact (status, disposition, duration, cost, call ID). Use this to reconcile a campaign run against a CRM, or to identify contacts that never connected. The response streams as CSV.

Authentication

AuthorizationBearer

API key from the console ApiKey collection, sent as Bearer token. Also accepts session cookies for browser-based auth.

Path parameters

idstringRequiredformat: "^[a-f\d]{24}$"
The campaign ID.

Query parameters

formatenumOptionalDefaults to json

Output format. Defaults to json.

Allowed values:

Response

The grouped export. The default json returns the structured object below; format=csv streams text/csv with one row per audience-member contact. The CSV column set matches your dashboard’s campaign export for this campaign.

campaignstringOptional
The campaign name.
exportedAtdatetimeOptional
totalAudienceMembersintegerOptional
datalist of objectsOptional

Errors

404
Not Found Error