List the link clicks of a campaign

List the links of a campaign with their click counts and the contacts that clicked them. This is the v3 equivalent of the v1 campaign_report_link_list action.

Paging applies to the links, not to the contacts nested under them. The nested contact rows are read without the messageid and includeBotClicks restrictions that are applied to the links themselves, so a link's contacts can cover more clicks than its counts do.

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 reports on the whole campaign.

string
enum
Defaults to true

Set to false (or 0) to exclude clicks attributed to bots from the link counts. Defaults to true.

Allowed:
Responses

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