reports

Get campaign link details

Get click details for a specific link in a campaign.

get/3.0/reports/{campaign_id}/click-details/{link_id}

Request

Path parameters

campaign_idstring required

The unique id for the campaign.

link_idstring required

The id for the link.

Query parameters

fieldsstring[]

A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.

exclude_fieldsstring[]

A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.

filter_botsboolean

When true, exclude automated bot clicks so the returned click counts reflect human clicks only, matching the in-app Recipient Activity view. Filtering changes a link's counts, but never removes a link from the response. Defaults to false (all clicks).

Response

campaign_idstring

The campaign id.

click_percentagenumber

The percentage of total clicks a link generated for a campaign.

idstring

The unique id for the link.

last_clickstring date-time

The date and time for the last recorded click for a link in ISO 8601 format.

total_clicksinteger

The number of total clicks for a link.

unique_click_percentagenumber

The percentage of unique clicks a link generated for a campaign.

unique_clicksinteger

Number of unique clicks for a link.

urlstring

The URL for the link in the campaign.

Changes

No recorded changes to this operation across all 1 revision of this API.