v2

latestOpenAPI 3.1.02026-07-273779120.8 KB
Campaign Stats
Stats

Campaign Call Stats

Get aggregated call counts grouped by a chosen dimension.

  • group_by: Grouping dimension — outcome (default), status, status_outcome, or tag.
  • 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.
get/campaigns/v1/stats/campaigns/calls

Query parameters

group_by'outcome' | 'status' | 'status_outcome' | 'tag' | 'source' | 'campaignType'

Grouping criteria: outcome, status, status_outcome, tag

campaign_idstring
Example:5eb7cf5a86d9755df3a6c593

Filter by campaign ID

statusesstring[] nullable

Filter by one or more call statuses

Filter by one or more call statuses

outcomesstring[] nullable

Filter by one or more outcomes

Filter by one or more outcomes

tagsstring[] nullable

Filter tag stats by tag strings (substring match)

Filter tag stats by tag strings (substring match)

sizeinteger

Number of items per page

Number of items per page

pageinteger

Page number

Page number

searchstring nullable

Search keywords

Search keywords

startstring date-time nullable

Filter by start time (ISO 8601 format)

Filter by start time (ISO 8601 format)

endstring date-time nullable

Filter by end time (ISO 8601 format)

Filter by end time (ISO 8601 format)

Response

Aggregated call counts grouped by the chosen dimension

messagestring required

Result description

Example response

{
  "message": "Stats fetched successfully."
}