Tone docs
API referenceCampaigns

Outcome tallies for the campaign funnel

Counts by disposition, plus the tallies of your declared output variables — how many said yes, how many rescheduled — which is usually the number the campaign existed to produce.

Open in ClaudeOpen in ChatGPTView as Markdown

Requires the read scope. A key with less gets 403 insufficient_scope.

GET
/v1/campaigns/{id}/outcomes

Authorization

AuthorizationBearer <token>

Authorization: Bearer tone_live_… or tone_test_…. The prefix IS the environment: a test key reaches only the sandbox, and no request field bridges the two.

In: header

Path Parameters

id*string

The campaign's id.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/v1/campaigns/string/outcomes"
{  "data": {    "agentOutcome": {},    "disposition": "answered",    "excludedReason": "invalid_number",    "status": "running"  }}
Was this page helpful?

List a campaign's recipients and their outcomes

A recipient row names its LAST attempt. For every call the campaign placed, retries included, filter GET /v1/calls by campaign_id instead.

Stop dialling; resumable

Calls already in flight finish. The campaign also pauses itself if the wallet falls below autoPauseBelowPaise, with pausedReason saying so.