Download campaign results

Export campaign contact outcomes as CSV, including partial exports while the campaign is still running.

GET /api/v1/account/{account_id}/campaigns/{campaign_id}/results

Download campaign results

cURL

curl --request GET \
  --url https://api.vobiz.ai/api/v1/account/{account_id}/campaigns/{campaign_id}/results \
  --header 'X-Auth-ID: <x-auth-id>' \
  --header 'X-Auth-Token: <api-key>'

GET https://api.vobiz.ai/api/v1/account/{account_id}/campaigns/{campaign_id}/results

Returns contact outcomes as text/csv. Results are available while the campaign is running, so partial exports are supported.

Authentication required

• X-Auth-ID — your Vobiz account ID
• X-Auth-Token — your Vobiz auth token

account_id · string · required

Your Vobiz account ID. Use the same value in X-Auth-ID.

X-Auth-ID · string · required

Your Vobiz account ID, for example MA_XXXXXXXX.

campaign_id · string · required

The campaign to export.

Example

cURL

curl "https://api.vobiz.ai/api/v1/account/{account_id}/campaigns/{campaign_id}/results" \
  -H "X-Auth-ID: {account_id}" \
  -H "X-Auth-Token: {auth_token}" \
  -o campaign-results.csv

CSV columns

row_number,to_number,from_number_used,status,call_uuid,duration,hangup_cause,attempt_number,answered_at

Contact statuses are pending, dialling, answered, no_answer, busy, failed, retry_pending, and expired.