Mailchimp Click API

swagger: '2.0'
info:
  version: 3.0.55
  title: Mailchimp Marketing Abuse Click API
  contact:
    name: Mailchimp API Support
    email: apihelp@mailchimp.com
  x-permalink: https://github.com/mailchimp/mailchimp-client-lib-codegen/blob/main/spec/marketing.json
  description: '

    The Mailchimp Marketing API provides programmatic access to Mailchimp data

    and functionality, allowing developers to build custom features to do

    things like sync email activity and campaign analytics with their

    database, manage audiences and campaigns, and more.'
host: server.api.mailchimp.com
basePath: /3.0
schemes:
- https
consumes:
- application/json
produces:
- application/json
- application/problem+json
security:
- basicAuth: []
tags:
- name: Click
paths:
  /reports/{campaign_id}/click-details:
    get:
      summary: Mailchimp List Campaign Details
      description: Get information about clicks on specific links in your Mailchimp campaigns.
      operationId: getReportsIdClickDetails
      parameters:
      - name: fields
        x-title: Fields
        in: query
        description: A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
        required: false
        type: array
        collectionFormat: csv
        items:
          type: string
        example: example_value
      - name: exclude_fields
        x-title: Exclude Fields
        in: query
        description: A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.
        required: false
        type: array
        collectionFormat: csv
        items:
          type: string
        example: example_value
      - name: count
        x-title: Count
        in: query
        description: The number of records to return. Default value is 10. Maximum value is 1000
        required: false
        default: 10
        maximum: 1000
        type: integer
        example: example_value
      - name: offset
        x-title: Offset
        in: query
        description: Used for [pagination](https://mailchimp.com/developer/marketing/docs/methods-parameters/#pagination), this it the number of records from a collection to skip. Default value is 0.
        required: false
        default: 0
        type: integer
        example: example_value
      - in: path
        name: campaign_id
        x-title: Campaign ID
        type: string
        required: true
        description: The unique id for the campaign.
        example: '500123'
      - name: sort_field
        x-title: Sort By Field
        description: Returns click reports sorted by the specified field.
        in: query
        required: false
        type: string
        enum:
        - total_clicks
        - unique_clicks
        example: example_value
      - name: sort_dir
        x-title: Sort Direction
        description: Determines the order direction for sorted results.
        in: query
        required: false
        type: string
        enum:
        - ASC
        - DESC
        example: example_value
      responses:
        '200':
          description: ''
          schema:
            type: object
            title: Click Detail Report
            description: A list of URLs and unique IDs included in HTML and plain-text versions of a campaign.
            properties:
              urls_clicked:
                type: array
                items:
                  type: object
                  title: Click Detail Report
                  description: A report of links clicked in a specific campaign.
                  properties:
                    id:
                      type: string
                      title: URL ID
                      description: The unique id for the link.
                      readOnly: true
                    url:
                      type: string
                      title: URL
                      description: The URL for the link in the campaign.
                      readOnly: true
                    total_clicks:
                      type: integer
                      title: Total Clicks
                      description: The number of total clicks for a link.
                      readOnly: true
                    click_percentage:
                      type: number
                      title: Click Percentage
                      description: The percentage of total clicks a link generated for a campaign.
                      readOnly: true
                    unique_clicks:
                      type: integer
                      title: Unique Clicks
                      description: Number of unique clicks for a link.
                      readOnly: true
                    unique_click_percentage:
                      type: number
                      title: Unique Click Percentage
                      description: The percentage of unique clicks a link generated for a campaign.
                      readOnly: true
                    last_click:
                      type: string
                      title: Last Click
                      description: The date and time for the last recorded click for a link in ISO 8601 format.
                      format: date-time
                      readOnly: true
                    ab_split:
                      type: object
                      title: A/B Split
                      description: A breakdown of clicks by different groups of an A/B Split campaign. Does not return information about Multivariate Campaigns.
                      properties:
                        a:
                          type: object
                          title: Group A
                          description: Stats for Group A.
                          properties:
                            total_clicks_a:
                              type: integer
                              title: Total Clicks Group A
                              description: The total number of clicks for Group A.
                              readOnly: true
                            click_percentage_a:
                              type: number
                              title: Click Percentage Group A
                              description: The percentage of total clicks for Group A.
                              readOnly: true
                            unique_clicks_a:
                              type: integer
                              title: Unique Clicks Group A
                              description: The number of unique clicks for Group A.
                              readOnly: true
                            unique_click_percentage_a:
                              type: number
                              title: Unique Click Percentage Group A
                              description: The percentage of unique clicks for Group A.
                              readOnly: true
                        b:
                          type: object
                          title: Group B
                          description: Stats for Group B.
                          properties:
                            total_clicks_b:
                              type: integer
                              title: Total Clicks Group B
                              description: The total number of clicks for Group B.
                              readOnly: true
                            click_percentage_b:
                              type: number
                              title: Click Percentage Group B
                              description: The percentage of total clicks for Group B.
                              readOnly: true
                            unique_clicks_b:
                              type: integer
                              title: Unique Clicks Group B
                              description: The number of unique clicks for Group B.
                              readOnly: true
                            unique_click_percentage_b:
                              type: number
                              title: Unique Click Percentage Group B
                              description: The percentage of unique clicks for Group B.
                              readOnly: true
                    campaign_id:
                      type: string
                      title: Campaign ID
                      description: The campaign id.
                      readOnly: true
                    _links:
                      title: Links
                      description: A list of link types and descriptions for the API schema documents.
                      type: array
                      items:
                        type: object
                        title: Resource Link
                        description: This object represents a link from the resource where it is found to another resource or action that may be performed.
                        properties:
                          rel:
                            type: string
                            title: Rel
                            description: As with an HTML 'rel' attribute, this describes the type of link.
                            readOnly: true
                          href:
                            type: string
                            title: Href
                            description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action.
                            readOnly: true
                          method:
                            type: string
                            title: Method
                            description: The HTTP method that should be used when accessing the URL defined in 'href'.
                            enum:
                            - GET
                            - POST
                            - PUT
                            - PATCH
                            - DELETE
                            - OPTIONS
                            - HEAD
                            readOnly: true
                          targetSchema:
                            type: string
                            title: Target Schema
                            description: For GETs, this is a URL representing the schema that the response should conform to.
                            readOnly: true
                          schema:
                            type: string
                            title: Schema
                            description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to.
                            readOnly: true
                      readOnly: true
                title: URLs Clicked
                description: An array of objects, each representing a specific URL contained in the campaign.
              campaign_id:
                type: string
                title: Campaign ID
                description: The campaign id.
                readOnly: true
              total_items:
                type: integer
                title: Item Count
                description: The total number of items matching the query regardless of pagination.
                readOnly: true
              _links:
                title: Links
                description: A list of link types and descriptions for the API schema documents.
                type: array
                items:
                  type: object
                  title: Resource Link
                  description: This object represents a link from the resource where it is found to another resource or action that may be performed.
                  properties:
                    rel:
                      type: string
                      title: Rel
                      description: As with an HTML 'rel' attribute, this describes the type of link.
                      readOnly: true
                    href:
                      type: string
                      title: Href
                      description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action.
                      readOnly: true
                    method:
                      type: string
                      title: Method
                      description: The HTTP method that should be used when accessing the URL defined in 'href'.
                      enum:
                      - GET
                      - POST
                      - PUT
                      - PATCH
                      - DELETE
                      - OPTIONS
                      - HEAD
                      readOnly: true
                    targetSchema:
                      type: string
                      title: Target Schema
                      description: For GETs, this is a URL representing the schema that the response should conform to.
                      readOnly: true
                    schema:
                      type: string
                      title: Schema
                      description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to.
                      readOnly: true
                readOnly: true
        default:
          description: An error generated by the Mailchimp API.
          schema:
            type: object
            title: Problem Detail Document
            description: An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'.
            required:
            - type
            - title
            - status
            - detail
            - instance
            properties:
              type:
                type: string
                title: Problem Type
                description: An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type.
                example: https://mailchimp.com/developer/marketing/docs/errors/
              title:
                type: string
                title: Error Title
                description: 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.
                example: Resource Not Found
              status:
                type: integer
                title: HTTP Status Code
                description: The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem.
                example: 404
              detail:
                type: string
                title: Error Message
                description: A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors).
                example: The requested resource could not be found.
              instance:
                type: string
                title: Instance ID
                description: A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support.
                example: 995c5cb0-3280-4a6e-808b-3b096d0bb219
      deprecated: false
      tags:
      - Click
      x-custom-config:
        methodNameSnake: get_campaign_click_details
        methodNameCamel: getCampaignClickDetails
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /reports/{campaign_id}/click-details/{link_id}:
    get:
      summary: Mailchimp Get Campaign Link Details
      description: Get click details for a specific link in a campaign.
      operationId: getReportsIdClickDetailsId
      parameters:
      - name: fields
        x-title: Fields
        in: query
        description: A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
        required: false
        type: array
        collectionFormat: csv
        items:
          type: string
        example: example_value
      - name: exclude_fields
        x-title: Exclude Fields
        in: query
        description: A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.
        required: false
        type: array
        collectionFormat: csv
        items:
          type: string
        example: example_value
      - in: path
        name: campaign_id
        x-title: Campaign ID
        type: string
        required: true
        description: The unique id for the campaign.
        example: '500123'
      - name: link_id
        x-title: Link ID
        description: The id for the link.
        in: path
        required: true
        type: string
        example: '500123'
      responses:
        '200':
          description: ''
          schema:
            type: object
            title: Click Detail Report
            description: A report of links clicked in a specific campaign.
            properties:
              id:
                type: string
                title: URL ID
                description: The unique id for the link.
                readOnly: true
              url:
                type: string
                title: URL
                description: The URL for the link in the campaign.
                readOnly: true
              total_clicks:
                type: integer
                title: Total Clicks
                description: The number of total clicks for a link.
                readOnly: true
              click_percentage:
                type: number
                title: Click Percentage
                description: The percentage of total clicks a link generated for a campaign.
                readOnly: true
              unique_clicks:
                type: integer
                title: Unique Clicks
                description: Number of unique clicks for a link.
                readOnly: true
              unique_click_percentage:
                type: number
                title: Unique Click Percentage
                description: The percentage of unique clicks a link generated for a campaign.
                readOnly: true
              last_click:
                type: string
                title: Last Click
                description: The date and time for the last recorded click for a link in ISO 8601 format.
                format: date-time
                readOnly: true
              ab_split:
                type: object
                title: A/B Split
                description: A breakdown of clicks by different groups of an A/B Split campaign. Does not return information about Multivariate Campaigns.
                properties:
                  a:
                    type: object
                    title: Group A
                    description: Stats for Group A.
                    properties:
                      total_clicks_a:
                        type: integer
                        title: Total Clicks Group A
                        description: The total number of clicks for Group A.
                        readOnly: true
                      click_percentage_a:
                        type: number
                        title: Click Percentage Group A
                        description: The percentage of total clicks for Group A.
                        readOnly: true
                      unique_clicks_a:
                        type: integer
                        title: Unique Clicks Group A
                        description: The number of unique clicks for Group A.
                        readOnly: true
                      unique_click_percentage_a:
                        type: number
                        title: Unique Click Percentage Group A
                        description: The percentage of unique clicks for Group A.
                        readOnly: true
                  b:
                    type: object
                    title: Group B
                    description: Stats for Group B.
                    properties:
                      total_clicks_b:
                        type: integer
                        title: Total Clicks Group B
                        description: The total number of clicks for Group B.
                        readOnly: true
                      click_percentage_b:
                        type: number
                        title: Click Percentage Group B
                        description: The percentage of total clicks for Group B.
                        readOnly: true
                      unique_clicks_b:
                        type: integer
                        title: Unique Clicks Group B
                        description: The number of unique clicks for Group B.
                        readOnly: true
                      unique_click_percentage_b:
                        type: number
                        title: Unique Click Percentage Group B
                        description: The percentage of unique clicks for Group B.
                        readOnly: true
              campaign_id:
                type: string
                title: Campaign ID
                description: The campaign id.
                readOnly: true
              _links:
                title: Links
                description: A list of link types and descriptions for the API schema documents.
                type: array
                items:
                  type: object
                  title: Resource Link
                  description: This object represents a link from the resource where it is found to another resource or action that may be performed.
                  properties:
                    rel:
                      type: string
                      title: Rel
                      description: As with an HTML 'rel' attribute, this describes the type of link.
                      readOnly: true
                    href:
                      type: string
                      title: Href
                      description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action.
                      readOnly: true
                    method:
                      type: string
                      title: Method
                      description: The HTTP method that should be used when accessing the URL defined in 'href'.
                      enum:
                      - GET
                      - POST
                      - PUT
                      - PATCH
                      - DELETE
                      - OPTIONS
                      - HEAD
                      readOnly: true
                    targetSchema:
                      type: string
                      title: Target Schema
                      description: For GETs, this is a URL representing the schema that the response should conform to.
                      readOnly: true
                    schema:
                      type: string
                      title: Schema
                      description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to.
                      readOnly: true
                readOnly: true
        default:
          description: An error generated by the Mailchimp API.
          schema:
            type: object
            title: Problem Detail Document
            description: An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'.
            required:
            - type
            - title
            - status
            - detail
            - instance
            properties:
              type:
                type: string
                title: Problem Type
                description: An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type.
                example: https://mailchimp.com/developer/marketing/docs/errors/
              title:
                type: string
                title: Error Title
                description: 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.
                example: Resource Not Found
              status:
                type: integer
                title: HTTP Status Code
                description: The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem.
                example: 404
              detail:
                type: string
                title: Error Message
                description: A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors).
                example: The requested resource could not be found.
              instance:
                type: string
                title: Instance ID
                description: A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support.
                example: 995c5cb0-3280-4a6e-808b-3b096d0bb219
      deprecated: false
      tags:
      - Click
      x-custom-config:
        methodNameSnake: get_campaign_click_details_for_link
        methodNameCamel: getCampaignClickDetailsForLink
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /reports/{campaign_id}/click-details/{link_id}/members:
    get:
      summary: Mailchimp List Clicked Link Subscribers
      description: Get information about list members who clicked on a specific link in a campaign.
      operationId: getReportsIdClickDetailsIdMembers
      parameters:
      - name: fields
        x-title: Fields
        in: query
        description: A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
        required: false
        type: array
        collectionFormat: csv
        items:
          type: string
        example: example_value
      - name: exclude_fields
        x-title: Exclude Fields
        in: query
        description: A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.
        required: false
        type: array
        collectionFormat: csv
        items:
          type: string
        example: example_value
      - name: count
        x-title: Count
        in: query
        description: The number of records to return. Default value is 10. Maximum value is 1000
        required: false
        default: 10
        maximum: 1000
        type: integer
        example: example_value
      - name: offset
        x-title: Offset
        in: query
        description: Used for [pagination](https://mailchimp.com/developer/marketing/docs/methods-parameters/#pagination), this it the number of records from a collection to skip. Default value is 0.
        required: false
        default: 0
        type: integer
        example: example_value
      - in: path
        name: campaign_id
        x-title: Campaign ID
        type: string
        required: true
        description: The unique id for the campaign.
        example: '500123'
      - name: link_id
        x-title: Link ID
        description: The id for the link.
        in: path
        required: true
        type: string
        example: '500123'
      responses:
        '200':
          description: ''
          schema:
            type: object
            title: Click Detail Members
            description: A collection of members who clicked on a specific link within a campaign.
            properties:
              members:
                type: array
                items:
                  type: object
                  title: Click Detail Member
                  description: A subscriber who clicked a specific URL in a specific campaign.
                  properties:
                    email_id:
                      type: string
                      title: Email Hash
                      description: The MD5 hash of the lowercase version of the list member's email address.
                      readOnly: true
                    email_address:
                      type: string
                      title: Email Address
                      description: Email address for a subscriber.
                      readOnly: true
                    merge_fields:
                      type: object
                      title: Merge Fields
                      description: A dictionary of merge fields where the keys are the merge tags. See the [Merge Fields documentation](https://mailchimp.com/developer/marketing/docs/merge-fields/#structure) for more about the structure.
                      additionalProperties:
                        description: This object's keys are merge tags (like FNAME). It's values are the values to be added to the merge field.
                    vip:
                      type: boolean
                      title: VIP
                      description: '[VIP status](https://mailchimp.com/help/designate-and-send-to-vip-contacts/) for subscriber.'
                      readOnly: true
                    clicks:
                      type: integer
                      title: Total Clicks
                      description: The total number of times the subscriber clicked on the link.
                      readOnly: true
                    campaign_id:
                      type: string
                      title: Campaign ID
                      description: The campaign id.
                      readOnly: true
                    url_id:
                      type: string
                      title: URL ID
                      description: The id for the tracked URL in the campaign.
                      readOnly: true
                    list_id:
                      type: string
                      title: List ID
                      description: The list id.
                      readOnly: true
                    list_is_active:
                      type: boolean
                      title: List Status
                      description: The status of the list used, namely if it's deleted or disabled.
                      readOnly: true
                    contact_status:
                      type: string
                      title: Member Status
                      description: The status of the member, namely if they are subscribed, unsubscribed, deleted, non-subscribed, transactional, pending, or need reconfirmation.
                      readOnly: true
                    _links:
                      title: Links
                      description: A list of link types and descriptions for the API schema documents.
                      type: array
                      items:
                        type: object
                        title: Resource Link
                        description: This object represents a link from the resource where it is found to another resource or action that may be performed.
                        properties:
                          rel:
                            type: string
                            title: Rel
                            description: As with an HTML 'rel' attribute, this describes the type of link.
                            readOnly: true
                          href:
                            type: string
                            title: Href
                            description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action.
                            readOnly: true
                          method:
                            type: string
                            title: Method
                            description: The HTTP method that should be used when accessing the URL defined in 'href'.
                            enum:
                            - GET
                            - POST
                            - PUT
                            - PATCH
                            - DELETE
                            - OPTIONS
                            - HEAD
                            readOnly: true
                          targetSchema:
                            type: string
                            title: Target Schema
                            description: For GETs, this is a URL representing the schema that the response should conform to.
   

# --- truncated at 32 KB (71 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/mailchimp/refs/heads/main/openapi/mailchimp-click-api-openapi.yml