Retrieve the report totals of a message

Retrieve the report totals of the campaign a message belongs to, with the message applied as the filter. This is the v3 equivalent of calling the v1 campaign_report_totals action with only a messageid.

As in v1, the message only narrows the totals on a split campaign; elsewhere the whole campaign is reported. The response is the same shape as Retrieve a campaign report totals, and the same date window rules apply: startDate and endDate must be sent together.

A message that belongs to no campaign is a 404.

Path Params
int32
required

id of the message to report on

Query Params
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