---
title: "List campaign details"
method: GET
path: "/3.0/reports/{campaign_id}/click-details"
tags: ["reports"]
---

# List campaign details

`GET /3.0/reports/{campaign_id}/click-details`

## Request

- Base URL: `https://api.mailchimp.com`
- URL: `https://api.mailchimp.com/3.0/reports/{campaign_id}/click-details`
- Auth: one of:
  - HTTP bearer
  - OAuth 2
    - Authorization code: `https://login.mailchimp.com/oauth2/authorize`
    - Token URL: `https://login.mailchimp.com/oauth2/token`
- TypeScript: <https://skmtc.dev/mailchimp/apis/mailchimp-api/docs/3.0/reports/:campaign_id/click-details/get.ts> (a function with typed inputs; its response is checked against the schema)

Get information about clicks on specific links in your Mailchimp campaigns.

## Path parameters

- `campaign_id` string, required

## Query parameters

- `fields` string[]
- `exclude_fields` string[]
- `count` integer
- `offset` integer
- `sort_field` 'total_clicks' | 'unique_clicks'
- `sort_dir` 'ASC' | 'DESC'
- `filter_bots` boolean

## Response `200`

- object: A list of URLs and unique IDs included in HTML and plain-text versions of a campaign.
  - `_links` object[]: A list of link types and descriptions for the API schema documents.
    - `href` string: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action.
    - `method` 'GET' | 'POST' | 'PUT' | 'PATCH' | 'DELETE' | 'OPTIONS' | 'HEAD': The HTTP method that should be used when accessing the URL defined in 'href'.
    - `rel` string: As with an HTML 'rel' attribute, this describes the type of link.
    - `schema` string: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to.
    - `targetSchema` string: For GETs, this is a URL representing the schema that the response should conform to.
  - `campaign_id` string: The campaign id.
  - `total_items` integer: The total number of items matching the query regardless of pagination.
  - `urls_clicked` object[]: An array of objects, each representing a specific URL contained in the campaign.
    - `_links` object[]: A list of link types and descriptions for the API schema documents.
      - `href` string: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action.
      - `method` 'GET' | 'POST' | 'PUT' | 'PATCH' | 'DELETE' | 'OPTIONS' | 'HEAD': The HTTP method that should be used when accessing the URL defined in 'href'.
      - `rel` string: As with an HTML 'rel' attribute, this describes the type of link.
      - `schema` string: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to.
      - `targetSchema` string: For GETs, this is a URL representing the schema that the response should conform to.
    - `ab_split` object: A breakdown of clicks by different groups of an A/B Split campaign. Does not return information about Multivariate Campaigns.
      - `a` object: Stats for Group A.
        - `click_percentage_a` number: The percentage of total clicks for Group A.
        - `total_clicks_a` integer: The total number of clicks for Group A.
        - `unique_click_percentage_a` number: The percentage of unique clicks for Group A.
        - `unique_clicks_a` integer: The number of unique clicks for Group A.
      - `b` object: Stats for Group B.
        - `click_percentage_b` number: The percentage of total clicks for Group B.
        - `total_clicks_b` integer: The total number of clicks for Group B.
        - `unique_click_percentage_b` number: The percentage of unique clicks for Group B.
        - `unique_clicks_b` integer: The number of unique clicks for Group B.
    - `campaign_id` string: The campaign id.
    - `click_percentage` number: The percentage of total clicks a link generated for a campaign.
    - `id` string: The unique id for the link.
    - `last_click` string, date-time: The date and time for the last recorded click for a link in ISO 8601 format.
    - `total_clicks` integer: The number of total clicks for a link.
    - `unique_click_percentage` number: The percentage of unique clicks a link generated for a campaign.
    - `unique_clicks` integer: Number of unique clicks for a link.
    - `url` string: The URL for the link in the campaign.

## Other responses

- `default`: An error generated by the Mailchimp API.

---

[API](https://skmtc.dev/mailchimp/apis/mailchimp-api.md) - [All operations](https://skmtc.dev/mailchimp/apis/mailchimp-api/llms.txt) - [OpenAPI document](https://skmtc.dev/mailchimp/apis/mailchimp-api/revisions/53bf4b156855?raw)