Get campaign link details

GET

https://api.mailchimp.com/3.0/reports/:campaign_id/click-details/:link_id

GET

/3.0/reports/:campaign_id/click-details/:link_id

curl https://api.mailchimp.com/3.0/reports/campaign_id/click-details/link_id \
     -H "Authorization: Bearer <token>"

200Retrieved

{
  "_links": [
    {
      "href": "string",
      "method": "GET",
      "rel": "string",
      "schema": "string",
      "targetSchema": "string"
    }
  ],
  "ab_split": {
    "a": {
      "click_percentage_a": 1.1,
      "total_clicks_a": 1,
      "unique_click_percentage_a": 1.1,
      "unique_clicks_a": 1
    },
    "b": {
      "click_percentage_b": 1.1,
      "total_clicks_b": 1,
      "unique_click_percentage_b": 1.1,
      "unique_clicks_b": 1
    }
  },
  "campaign_id": "string",
  "click_percentage": 1.1,
  "id": "string",
  "last_click": "2024-01-15T09:30:00Z",
  "total_clicks": 1,
  "unique_click_percentage": 1.1,
  "unique_clicks": 1,
  "url": "string"
}

Get click details for a specific link in a campaign.

Authentication

AuthorizationBearer

Authorization using a Mailchimp API key (a.k.a. Bearer token)

AuthorizationBearer

Authorization using OAuth

Path parameters

campaign_idstringRequired

The unique id for the campaign.

link_idstringRequired

The id for the link.

Query parameters

fieldslist of stringsOptional

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

exclude_fieldslist of stringsOptional

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

filter_botsbooleanOptionalDefaults to false

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

This endpoint returns an object.

_linkslist of objectsOptionalRead-only

A list of link types and descriptions for the API schema documents.

ab_splitobjectOptional

A breakdown of clicks by different groups of an A/B Split campaign. Does not return information about Multivariate Campaigns.

campaign_idstringOptionalRead-only

The campaign id.

click_percentagedoubleOptionalRead-only

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

idstringOptionalRead-only

The unique id for the link.

last_clickdatetimeOptionalRead-only

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

total_clicksintegerOptionalRead-only

The number of total clicks for a link.

unique_click_percentagedoubleOptionalRead-only

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

unique_clicksintegerOptionalRead-only

Number of unique clicks for a link.

urlstringOptionalRead-only

The URL for the link in the campaign.