Retrieve a campaign report totals

Retrieve the aggregate performance totals for a campaign. This is the v3 equivalent of the v1 campaign_report_totals action.

Totals are lifetime by default. Supply startDate and endDate together to restrict them to a date window; supplying only one of the two, or an endDate earlier than the startDate, returns 422.

Every field of the response is always present, and is null when the underlying report does not provide it, so the shape does not change between the lifetime and the date-windowed variants.

Requires the Campaigns module and permission to access the campaign.

Path Params
int32
required

id of the campaign to report on

Query Params
int32
Defaults to 0

Report on a single message of a split campaign. Defaults to 0, which reports on the campaign as a whole. A message that does not belong to the campaign returns 400.

string

Start of the reporting window, inclusive. One of YYYY-MM-DD, YYYY-MM-DD HH:MM:SS, or YYYY-MM-DDTHH:MM:SS. A date without a time starts at midnight. Must be sent together with endDate.

string

End of the reporting window, inclusive. Same formats as startDate, and must be sent together with it.

string
enum
Defaults to true

Set to false to exclude opens and clicks attributed to bots. Defaults to true.

Allowed:
Responses

Language
Credentials
Header
URL
LoadingLoading…
Response
Choose an example:
application/json