List the forwards of a campaign

One row per contact and campaign message the contact forwarded: how many times they forwarded it, with the sender, recipient and note of one of those forwards. The v3 counterpart of the v1 campaign_report_forward_list action, built from the same query. 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
string
Defaults to 20

Number of rows to return, from 1 to 100. 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 whole 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 100, offset not a whole number of 0 or more, or messageid not digits-only. 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