List the contacts who did not open a campaign

One row per contact the campaign was sent to who has no recorded open of it. The v3 counterpart of the v1 campaign_report_unopen_list action, built from the same rows: opens is always 0 and sendDate is the campaign send date rather than a per-contact time, so the rows stay comparable with v1. The response carries no total: page with limit and offset until a page comes back shorter than limit; limit plus offset may not exceed 1000. 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
string
Defaults to 20

Number of rows to return, from 1 to 1000; limit plus offset may not exceed 1000. Defaults to 20.

string
Defaults to 0

Number of rows to skip before the first one returned, from 0 to 1000. 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.

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 not a whole number from 0 to 1000, limit plus offset above 1000, or messageid not a whole number of 0 or more. Body: errors, one item per failed rule, each carrying status 422, title "Invalid attribute", detail naming the rule and, for a single parameter, source.pointer naming it (for example /data/attributes/limit).

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