List the opens of a campaign

List the contacts that opened a campaign, with how many times each of them opened it. This is the v3 equivalent of the v1 campaign_report_open_list action.

One page of rows is returned and no row count, so page until a short page comes back: the response carries no meta.total.

Requires the Campaigns feature and access to the campaign; a campaign the user cannot see is reported as 404 so the endpoint does not disclose which campaign ids exist.

Path Params
int32
required

id of the campaign to report on

Query Params
int32
≤ 1000
Defaults to 20

Number of rows to return. Digits only, 1 or greater, and no greater than 1000; anything else is a 422.

int32
Defaults to 0

Number of rows to skip. Digits only and non-negative.

int32
Defaults to 0

Report on a single message of a split campaign. Defaults to 0, which carries the v1 meaning of the campaign's single message.

string
enum
Defaults to DESC

Order the rows by the time of the last open. tstamp is the only field that may be ordered by; the default is DESC.

Allowed:
Responses

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