Click Reports

Get detailed information about links clicked in campaigns.

Subresources

Available methods

    • GET /reports/{campaign_id}/click-details Get campaign click details
      GET /reports/{campaign_id}/click-details/{link_id} Get click details for a specific link

      Get campaign click details

      GET /reports/{campaign_id}/click-details

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

      Path parameters

      campaign_id The unique id for the campaign.

      Query string parameters

      fields Type: Array Title: Fields Read only: false A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
      exclude_fields Type: Array Title: Exclude Fields Read only: false A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.
      count Type: Integer Title: Count Read only: true The number of records to return. Default value is 10.
      offset Type: Integer Title: Offset Read only: false The number of records from a collection to skip. Iterating over large collections with this parameter can be slow. Default value is 0.

      Response body parameters

      urls_clicked Type: Array Title: Abuse Reports Read only: false An array of objects, each representing a specific URL contained in the campaign.
      Show properties
      id Type: String Title: URL ID Read only: true The unique id for the link.
      url Type: String Title: URL Read only: true The URL for the link in the campaign.
      total_clicks Type: Integer Title: Total Clicks Read only: true The number of total clicks for a link.
      click_percentage Type: Number Title: Click Percentage Read only: true The percentage of total clicks a link generated for a campaign.
      unique_clicks Type: Integer Title: Unique Clicks Read only: true Number of unique clicks for a link.
      unique_click_percentage Type: Number Title: Unique Click Percentage Read only: true The percentage of unique clicks a link generated for a campaign.
      last_click Type: String Title: Last Click Read only: true The date and time for the last recorded click for a link.
      ab_split Type: Object Title: A/B Split Read only: false A breakdown of clicks by different groups of an A/B Split campaign. Does not return information about MailChimp Pro’s Multivariate Campaigns.
      Show properties
      a Type: Object Title: Group A Read only: false Stats for Group A.
      Show properties
      total_clicks_a Type: Integer Title: Total Clicks Group A Read only: true The total number of clicks for Group A.
      click_percentage_a Type: Number Title: Click Percentage Group A Read only: true The percentage of total clicks for Group A.
      unique_clicks_a Type: Integer Title: Unique Clicks Group A Read only: true The number of unique clicks for Group A.
      unique_click_percentage_a Type: Number Title: Unique Click Percentage Group A Read only: true The percentage of unique clicks for Group A.
      b Type: Object Title: Group B Read only: false Stats for Group B.
      Show properties
      total_clicks_b Type: Integer Title: Total Clicks Group B Read only: true The total number of clicks for Group B.
      click_percentage_b Type: Number Title: Click Percentage Group B Read only: true The percentage of total clicks for Group B.
      unique_clicks_b Type: Integer Title: Unique Clicks Group B Read only: true The number of unique clicks for Group B.
      unique_click_percentage_b Type: Number Title: Unique Click Percentage Group B Read only: true The percentage of unique clicks for Group B.
      campaign_id Type: String Title: Campaign ID Read only: true The campaign id.
      _links Type: Array Title: Links Read only: true A list of link types and descriptions for the API schema documents.
      Show properties
      rel Type: String Title: Rel Read only: true As with an HTML ‘rel’ attribute, this describes the type of link.
      href Type: String Title: Href Read only: true This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action.
      method Type: String Title: Method Read only: true The HTTP method that should be used when accessing the URL defined in ‘href’.
      Possible Values:
      • GET
      • POST
      • PUT
      • PATCH
      • DELETE
      • OPTIONS
      • HEAD
      targetSchema Type: String Title: Target Schema Read only: true For GETs, this is a URL representing the schema that the response should conform to.
      schema Type: String Title: Schema Read only: true For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to.
      campaign_id Type: String Title: Campaign ID Read only: true The campaign id.
      total_items Type: Integer Title: Item Count Read only: false The total number of items matching the query regardless of pagination.
      _links Type: Array Title: Links Read only: true A list of link types and descriptions for the API schema documents.
      Show properties
      rel Type: String Title: Rel Read only: true As with an HTML ‘rel’ attribute, this describes the type of link.
      href Type: String Title: Href Read only: true This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action.
      method Type: String Title: Method Read only: true The HTTP method that should be used when accessing the URL defined in ‘href’.
      Possible Values:
      • GET
      • POST
      • PUT
      • PATCH
      • DELETE
      • OPTIONS
      • HEAD
      targetSchema Type: String Title: Target Schema Read only: true For GETs, this is a URL representing the schema that the response should conform to.
      schema Type: String Title: Schema Read only: true For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to.

      Example request

      
      curl --request GET \
      --url 'https://usX.api.mailchimp.com/3.0/reports/42694e9e57/click-details' \
      --user 'anystring:apikey' \
      --include
                                      

      Example response

      
      HTTP/1.1 200 OK
      Server: nginx
      Content-Type: application/json; charset=utf-8
      Content-Length: 1550
      Vary: Accept-Encoding
      X-Request-Id: 0d2a23c7-b54a-47ca-adc7-95dff2fd4dcc
      Link: <https://api.mailchimp.com/schema/3.0/Reports/ClickDetails/Collection.json>; rel="describedBy"
      Date: Thu, 17 Sep 2015 14:56:01 GMT
      Connection: keep-alive
      
      
      {
        "urls_clicked": [
          {
            "id": "54debc3673",
            "url": "http://inspiration.mailchimp.com?goal=0_57afe96172-42694e9e57-[LIST_EMAIL_ID]&mc_cid=42694e9e57&mc_eid=[UNIQID]",
            "total_clicks": 0,
            "click_percentage": 0,
            "unique_clicks": 0,
            "unique_click_percentage": 0,
            "last_click": "",
            "campaign_id": "42694e9e57",
            "_links": [
              {
                "rel": "parent",
                "href": "https://usX.api.mailchimp.com/3.0/reports/42694e9e57/click-details",
                "method": "GET",
                "targetSchema": "https://api.mailchimp.com/schema/3.0/Reports/ClickDetails/Collection.json"
              },
              {
                "rel": "self",
                "href": "https://usX.api.mailchimp.com/3.0/reports/42694e9e57/click-details/54debc3673",
                "method": "GET",
                "targetSchema": "https://api.mailchimp.com/schema/3.0/Reports/ClickDetails/Instance.json"
              },
              {
                "rel": "members",
                "href": "https://usX.api.mailchimp.com/3.0/reports/42694e9e57/click-details/54debc3673/members",
                "method": "GET",
                "targetSchema": "https://api.mailchimp.com/schema/3.0/Reports/ClickDetails/Members/Collection.json"
              },
              {
                "rel": "campaign",
                "href": "https://usX.api.mailchimp.com/3.0/campaigns/42694e9e57",
                "method": "GET",
                "targetSchema": "https://api.mailchimp.com/schema/3.0/Campaigns/Instance.json"
              }
            ]
          }
        ],
        "campaign_id": "42694e9e57",
        "_links": [
          {
            "rel": "parent",
            "href": "https://usX.api.mailchimp.com/3.0/reports/42694e9e57/",
            "method": "GET",
            "targetSchema": "https://api.mailchimp.com/schema/3.0/Reports/Instance.json"
          },
          {
            "rel": "self",
            "href": "https://usX.api.mailchimp.com/3.0/reports/42694e9e57/click-details",
            "method": "GET",
            "targetSchema": "https://api.mailchimp.com/schema/3.0/Reports/ClickDetails/Collection.json"
          }
        ],
        "total_items": 1
      }
                                      

      Error response

      type Type: String Title: Problem Type Read only: false An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type.
      title Type: String Title: Error Title Read only: false A short, human-readable summary of the problem type. It shouldn’t change based on the occurrence of the problem, except for purposes of localization.
      status Type: Integer Title: HTTP Status Code Read only: false The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem.
      detail Type: String Title: Error Message Read only: false A human-readable explanation specific to this occurrence of the problem. Learn more about errors.
      instance Type: String Title: Instance ID Read only: false A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support.

      GET /reports/{campaign_id}/click-details/{link_id}

      Get click details for a specific link in a campaign.

      Path parameters

      campaign_id The unique id for the campaign.
      link_id The id for the link.

      Query string parameters

      fields Type: Array Title: Fields Read only: false A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
      exclude_fields Type: Array Title: Exclude Fields Read only: false A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.

      Response body parameters

      id Type: String Title: URL ID Read only: true The unique id for the link.
      url Type: String Title: URL Read only: true The URL for the link in the campaign.
      total_clicks Type: Integer Title: Total Clicks Read only: true The number of total clicks for a link.
      click_percentage Type: Number Title: Click Percentage Read only: true The percentage of total clicks a link generated for a campaign.
      unique_clicks Type: Integer Title: Unique Clicks Read only: true Number of unique clicks for a link.
      unique_click_percentage Type: Number Title: Unique Click Percentage Read only: true The percentage of unique clicks a link generated for a campaign.
      last_click Type: String Title: Last Click Read only: true The date and time for the last recorded click for a link.
      ab_split Type: Object Title: A/B Split Read only: false A breakdown of clicks by different groups of an A/B Split campaign. Does not return information about MailChimp Pro’s Multivariate Campaigns.
      Show properties
      a Type: Object Title: Group A Read only: false Stats for Group A.
      Show properties
      total_clicks_a Type: Integer Title: Total Clicks Group A Read only: true The total number of clicks for Group A.
      click_percentage_a Type: Number Title: Click Percentage Group A Read only: true The percentage of total clicks for Group A.
      unique_clicks_a Type: Integer Title: Unique Clicks Group A Read only: true The number of unique clicks for Group A.
      unique_click_percentage_a Type: Number Title: Unique Click Percentage Group A Read only: true The percentage of unique clicks for Group A.
      b Type: Object Title: Group B Read only: false Stats for Group B.
      Show properties
      total_clicks_b Type: Integer Title: Total Clicks Group B Read only: true The total number of clicks for Group B.
      click_percentage_b Type: Number Title: Click Percentage Group B Read only: true The percentage of total clicks for Group B.
      unique_clicks_b Type: Integer Title: Unique Clicks Group B Read only: true The number of unique clicks for Group B.
      unique_click_percentage_b Type: Number Title: Unique Click Percentage Group B Read only: true The percentage of unique clicks for Group B.
      campaign_id Type: String Title: Campaign ID Read only: true The campaign id.
      _links Type: Array Title: Links Read only: true A list of link types and descriptions for the API schema documents.
      Show properties
      rel Type: String Title: Rel Read only: true As with an HTML ‘rel’ attribute, this describes the type of link.
      href Type: String Title: Href Read only: true This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action.
      method Type: String Title: Method Read only: true The HTTP method that should be used when accessing the URL defined in ‘href’.
      Possible Values:
      • GET
      • POST
      • PUT
      • PATCH
      • DELETE
      • OPTIONS
      • HEAD
      targetSchema Type: String Title: Target Schema Read only: true For GETs, this is a URL representing the schema that the response should conform to.
      schema Type: String Title: Schema Read only: true For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to.

      Example request

      
      curl --request GET \
      --url 'https://usX.api.mailchimp.com/3.0/reports/42694e9e57/click-details/54debc3673' \
      --user 'anystring:apikey' \
      --include
                                      

      Example response

      
      HTTP/1.1 200 OK
      Server: nginx
      Content-Type: application/json; charset=utf-8
      Content-Length: 1101
      Vary: Accept-Encoding
      X-Request-Id: 0d86d663-7018-44db-83f9-8bc889d19e2d
      Link: <https://api.mailchimp.com/schema/3.0/Reports/ClickDetails/Instance.json>; rel="describedBy"
      Date: Thu, 17 Sep 2015 15:06:24 GMT
      Connection: keep-alive
      
      
      {
        "id": "54debc3673",
        "url": "http://inspiration.mailchimp.com?goal=0_57afe96172-42694e9e57-[LIST_EMAIL_ID]&mc_cid=42694e9e57&mc_eid=[UNIQID]",
        "total_clicks": 0,
        "click_percentage": 0,
        "unique_clicks": 0,
        "unique_click_percentage": 0,
        "last_click": "",
        "campaign_id": "42694e9e57",
        "_links": [
          {
            "rel": "parent",
            "href": "https://usX.api.mailchimp.com/3.0/reports/42694e9e57/click-details",
            "method": "GET",
            "targetSchema": "https://api.mailchimp.com/schema/3.0/Reports/ClickDetails/Collection.json"
          },
          {
            "rel": "self",
            "href": "https://usX.api.mailchimp.com/3.0/reports/42694e9e57/click-details/54debc3673",
            "method": "GET",
            "targetSchema": "https://api.mailchimp.com/schema/3.0/Reports/ClickDetails/Instance.json"
          },
          {
            "rel": "members",
            "href": "https://usX.api.mailchimp.com/3.0/reports/42694e9e57/click-details/54debc3673/members",
            "method": "GET",
            "targetSchema": "https://api.mailchimp.com/schema/3.0/Reports/ClickDetails/Members/Collection.json"
          },
          {
            "rel": "campaign",
            "href": "https://usX.api.mailchimp.com/3.0/campaigns/42694e9e57",
            "method": "GET",
            "targetSchema": "https://api.mailchimp.com/schema/3.0/Campaigns/Instance.json"
          }
        ]
      }
                                      

      Error response

      type Type: String Title: Problem Type Read only: false An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type.
      title Type: String Title: Error Title Read only: false A short, human-readable summary of the problem type. It shouldn’t change based on the occurrence of the problem, except for purposes of localization.
      status Type: Integer Title: HTTP Status Code Read only: false The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem.
      detail Type: String Title: Error Message Read only: false A human-readable explanation specific to this occurrence of the problem. Learn more about errors.
      instance Type: String Title: Instance ID Read only: false A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support.