Campaign Stats
Get aggregated campaign counts grouped by a chosen dimension.
- group_by: Grouping dimension —
status(default),source, orcampaignType. - 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.
Authorizations
Retrieve your API Key from Dashboard API Keys Section.
Query Parameters
Grouping criteria: status, source, campaignType
outcome, status, status_outcome, tag, source, campaignType Filter by one or more campaign statuses
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 campaign 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.