HomeGuidesAPI Reference
ChangelogHelp CenterCommunityContact Us
API Reference

Query Campaign Values

Returns the requested campaign analytics values data

Rate limits:
Burst: 1/s
Steady: 2/m
Daily: 225/d

Scopes:
campaigns:read

Query Params
Body Params
object
required
string
required
object
required
array of strings
required

List of statistics to query for. All rate statistics will be returned in fractional form [0.0, 1.0]

statistics*
required

The timeframe to query for data within. The max length a timeframe can be is 1 year

date-time
required
date-time
required
string
required

ID of the metric to be used for conversion statistics

string

API filter string used to filter the query.
Allowed filters are send_channel, campaign_id.
Allowed operators are equals, contains-any.
Only one filter can be used per attribute, only AND can be used as a combination operator.
Max of 100 messages per ANY filter.
When filtering on send_channel, allowed values are email, push-notification, sms, whatsapp.

Headers
string
required
Defaults to 2025-01-15

API endpoint revision (format: YYYY-MM-DD[.suffix])

Responses

Language
Credentials