Get campaign analytics

Get deep analytics for a single campaign.

Authentication

AuthorizationBearer

Pass a JWT access token or an API key (prefixed with tif_live_) as a Bearer token.

Path parameters

campaignIdstringRequiredformat: "uuid"
Campaign ID

Response

Campaign analytics
attemptDistributionlist of objects
Distribution of contacts by attempt count
campaignIdstringformat: "uuid"
Campaign identifier
costBreakdownlist of objects
Cost breakdown by service category
durationBucketslist of objects

Call-duration histogram; an average hides a bimodal distribution.

failureCauseslist of objects
Failures grouped by structured cause, most common first.
hourlyVolumelist of objects
Hourly call volume throughout campaign lifetime
outcomeslist of objects
Contact outcome breakdown with percentages
overviewobject
Overview metrics
performanceobject

Performance metrics (latency, conversation, usage, function calls)

voicemailobject

Answering-machine detection outcomes.

Errors

401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
429
Too Many Requests Error
500
Internal Server Error