Skip to main content
GET
Campaign Stats

Authorizations

Authorization
string
header
required

Retrieve your API Key from Dashboard API Keys Section.

Query Parameters

group_by
enum<string>
default:status

Grouping criteria: status, source, campaignType

Available options:
outcome,
status,
status_outcome,
tag,
source,
campaignType
statuses
string[] | null

Filter by one or more campaign statuses

tags
string[] | null

Filter tag stats by tag strings (substring match)

size
integer
default:300

Number of items per page

Required range: x >= 1
page
integer
default:1

Page number

Required range: x >= 1
search
string | null

Search keywords

start
string<date-time> | null

Filter by start time (ISO 8601 format)

end
string<date-time> | null

Filter by end time (ISO 8601 format)

Response

Aggregated campaign counts grouped by the chosen dimension

message
string
required

Result description

Example:

"Stats fetched successfully."

data
StatEntry · object[]
required

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.