List campaign details

GET

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

GET

/3.0/reports/:campaign_id/click-details

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

200Retrieved

{
  "_links": [
    {
      "href": "string",
      "method": "GET",
      "rel": "string",
      "schema": "string",
      "targetSchema": "string"
    }
  ],
  "campaign_id": "string",
  "total_items": 1,
  "urls_clicked": [
    {
      "_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 information about clicks on specific links in your Mailchimp campaigns.

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.

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.

countintegerOptional<=1000Defaults to 10

The number of records to return. Default value is 10. Maximum value is 1000

offsetintegerOptionalDefaults to 0

Used for pagination, this is the number of records from a collection to skip. Default value is 0.

sort_fieldenumOptional

Returns click reports sorted by the specified field.

Allowed values:

sort_direnumOptional

Determines the order direction for sorted results.

Allowed values:

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.

campaign_idstringOptionalRead-only

The campaign id.

total_itemsintegerOptionalRead-only

The total number of items matching the query regardless of pagination.

urls_clickedlist of objectsOptional

An array of objects, each representing a specific URL contained in the campaign.