Campaign Call Stats
Get aggregated call counts grouped by a chosen dimension.
- group_by: Grouping dimension —
outcome(default),status,status_outcome, ortag. - campaign_id: Scope stats to a single campaign.
- statuses: Repeat to filter by multiple statuses:
?statuses=completed&statuses=failed. - outcomes: Repeat to filter by multiple outcomes:
?outcomes=voicemail&outcomes=conveyed. - tags: Filter tag-grouped results by substring match against tag strings.
- start / end: ISO 8601 date range filter applied to call creation date.
Authorizations
Retrieve your API Key from Dashboard API Keys Section.
Query Parameters
Grouping criteria: outcome, status, status_outcome, tag
outcome, status, status_outcome, tag, source, campaignType Filter by campaign ID
24^[0-9a-f]{24}$"5eb7cf5a86d9755df3a6c593"
Filter by one or more call statuses
Filter by one or more outcomes
Filter tag stats by tag strings (substring match)
Number of items per page
x >= 1Page number
x >= 1Search keywords
Filter by start time (ISO 8601 format)
Filter by end time (ISO 8601 format)
Response
Aggregated call counts grouped by the chosen dimension
Result description
"Stats fetched successfully."
Aggregated counts grouped by the requested dimension ('outcome', 'status', 'status_outcome', 'tag', 'source', 'campaignType'). Each entry contains a 'count' field and a group key field named after the dimension.