v2
latestOpenAPI 3.1.02026-07-273779120.8 KBCampaign Stats
Stats
Campaign Stats
Get aggregated campaign counts grouped by a chosen dimension.
- group_by: Grouping dimension — status (default), source, or campaignType.
- statuses: Repeat to filter by multiple statuses: ?statuses=completed&statuses=processing.
- tags: Filter tag-grouped results by substring match.
- start / end: ISO 8601 date range filter applied to campaign creation date.
get/campaigns/v1/stats/campaigns
Query parameters
group_by'outcome' | 'status' | 'status_outcome' | 'tag' | 'source' | 'campaignType'
Grouping criteria: status, source, campaignType
statusesstring[] nullable
Filter by one or more campaign statuses
Filter by one or more campaign statuses
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 campaign counts grouped by the chosen dimension
Example response
{
"message": "Stats fetched successfully."
}