List the contacts who opened a campaign

One row per contact who opened the campaign, with how many times they opened it and when they last did, newest open first unless orders[tstamp]=ASC is sent. The v3 counterpart of the v1 campaign_report_open_list action, built from the same rows. The response carries no total: page with limit and offset until a page comes back shorter than limit. Answers 404 when the campaign does not exist or the user may not see it, and 422 when a query parameter is invalid.

Path Params
integer
required
^(?:\d+)$

ID of the campaign to report on

Query Params
orders
object

Sort direction by open time, sent as orders[tstamp]=ASC or orders[tstamp]=DESC (case-insensitive). tstamp is the only field accepted. Defaults to DESC, newest open first.

string
Defaults to 20

Number of rows to return, from 1 to 1000. Defaults to 20.

string
Defaults to 0

Number of rows to skip before the first one returned. Defaults to 0.

string
Defaults to 0

ID of the campaign message to report on. 0, the default, reports the campaign's own message the way the v1 report does, not every message of a split campaign.

Responses

404

No campaign with this id, or the user may not see it: a campaign the user cannot see is reported as missing. Body: errors, a list with one item carrying status "404" and detail "Campaign not found.".

422

A query parameter is invalid: limit not a whole number from 1 to 1000, offset or messageid not a whole number of 0 or more, or orders naming a field other than tstamp or a direction other than ASC or DESC. Body: errors, one item per failed rule, each carrying status 422, title "Invalid attribute", detail naming the rule and source.pointer naming the parameter (for example /data/attributes/limit).

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