Mailchimp Activity API

swagger: '2.0'
info:
  version: 3.0.55
  title: Mailchimp Marketing Abuse Activity 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: Activity
paths:
  /activity-feed/chimp-chatter:
    get:
      summary: Mailchimp Get Latest Chimp Chatter
      description: Return the Chimp Chatter for this account ordered by most recent.
      parameters:
      - 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
      responses:
        '200':
          description: ChimpChatter Collection
          schema:
            type: object
            description: An array of Chimp Chatter messages. There's a maximum of 200 messages present for an account.
            properties:
              chimp_chatter:
                type: array
                description: An array of Chimp Chatter messages. There's a maximum of 200 messages present for an account.
                readOnly: true
                items:
                  type: object
                  title: ChimpChatter
                  description: A Chimp Chatter message
                  properties:
                    title:
                      type: string
                      title: Title
                      readOnly: true
                      example: 1 new subscriber to Your New Campaign!
                    message:
                      type: string
                      title: Message
                      readOnly: true
                      example: People are telling their friends about your campaign!
                    type:
                      type: string
                      title: Type
                      description: The type of activity
                      enum:
                      - lists:new-subscriber
                      - lists:unsubscribes
                      - lists:profile-updates
                      - campaigns:facebook-likes
                      - campaigns:forward-to-friend
                      - lists:imports
                      readOnly: true
                      example: campaigns:forward-to-friend
                    update_time:
                      type: string
                      title: Update Time
                      format: date-time
                      description: The date and time this activity was updated.
                      readOnly: true
                      example: '2017-08-04T11:09:01+00:00'
                    url:
                      type: string
                      title: URL
                      description: URL to a report that includes this activity
                      readOnly: true
                      example: http://dev.mailchimp.com/reports/summary?id=1
                    list_id:
                      type: string
                      title: List ID
                      description: If it exists, list ID for the associated list
                      readOnly: true
                      example: '2017-08-04T11:09:01+00:00'
                    campaign_id:
                      type: string
                      title: Campaign ID
                      description: If it exists, campaign ID for the associated campaign
                      readOnly: true
                      example: '2017-08-04T11:09:01+00:00'
              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
      tags:
      - Activity
      x-custom-config:
        methodNameSnake: get_chimp_chatter
        methodNameCamel: getChimpChatter
      operationId: getActivityFeedChimpChatter
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /lists/{list_id}/activity:
    get:
      summary: Mailchimp List Recent Activity
      description: Get up to the previous 180 days of daily detailed aggregated activity stats for a list, not including Automation activity.
      operationId: getListsIdActivity
      parameters:
      - 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
      - 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: list_id
        x-title: List ID
        in: path
        description: The unique ID for the list.
        required: true
        type: string
        example: '500123'
      responses:
        '200':
          description: ''
          schema:
            type: object
            title: List Activity
            description: Up to the previous 180 days of daily detailed aggregated activity stats for a specific list. Does not include AutoResponder or Automation activity.
            properties:
              activity:
                type: array
                title: List Activity
                description: Recent list activity.
                items:
                  type: object
                  title: Daily List Activity
                  description: One day's worth of list activity. Doesn't include Automation activity.
                  properties:
                    day:
                      type: string
                      title: Day
                      description: The date for the activity summary.
                      readOnly: true
                    emails_sent:
                      type: integer
                      title: Emails Sent
                      description: The total number of emails sent on the date for the activity summary.
                      readOnly: true
                    unique_opens:
                      type: integer
                      title: Unique Opens
                      description: The number of unique opens.
                      readOnly: true
                    recipient_clicks:
                      type: integer
                      title: Recipient Clicks
                      description: The number of clicks.
                      readOnly: true
                    hard_bounce:
                      type: integer
                      title: Hard Bounces
                      description: The number of hard bounces.
                      readOnly: true
                    soft_bounce:
                      type: integer
                      title: Soft Bounces
                      description: The number of soft bounces
                      readOnly: true
                    subs:
                      type: integer
                      title: Subscribes
                      description: The number of subscribes.
                      readOnly: true
                    unsubs:
                      type: integer
                      title: Unsubscribes
                      description: The number of unsubscribes.
                      readOnly: true
                    other_adds:
                      type: integer
                      title: Other Adds
                      description: The number of subscribers who may have been added outside of the [double opt-in process](https://mailchimp.com/help/about-double-opt-in/), such as imports or API activity.
                      readOnly: true
                    other_removes:
                      type: integer
                      title: Other Removes
                      description: The number of subscribers who may have been removed outside of unsubscribing or reporting an email as spam (for example, deleted subscribers).
                      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
              list_id:
                type: string
                title: List ID
                description: The unique id for the list.
              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:
      - Activity
      x-custom-config:
        methodNameSnake: get_list_recent_activity
        methodNameCamel: getListRecentActivity
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /lists/{list_id}/members/{subscriber_hash}/activity:
    get:
      summary: Mailchimp View Recent Activity 50
      description: Get the last 50 events of a member's activity on a specific list, including opens, clicks, and unsubscribes.
      operationId: getListsIdMembersIdActivity
      parameters:
      - name: list_id
        x-title: List ID
        in: path
        description: The unique ID for the list.
        required: true
        type: string
        example: '500123'
      - in: path
        name: subscriber_hash
        x-title: Subscriber Hash
        type: string
        required: true
        description: The MD5 hash of the lowercase version of the list member's email address. This endpoint also accepts a list member's email address or contact_id.
        example: example_value
      - 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: query
        name: action
        x-title: Action
        type: array
        required: false
        items:
          type: string
        collectionFormat: csv
        enum:
        - - abuse
        - - bounce
        - - click
        - - open
        - - sent
        - - unsub
        - - ecomm
        description: A comma seperated list of actions to return.
        example: example_value
      responses:
        '200':
          description: ''
          schema:
            type: object
            title: Member Activity Events
            description: The last 50 member events for a list.
            properties:
              activity:
                type: array
                title: Activity
                description: An array of objects, each representing a member event.
                items:
                  type: object
                  title: Member Activity
                  description: Member activity events.
                  properties:
                    action:
                      type: string
                      title: Action Type
                      description: The type of action recorded for the subscriber.
                    timestamp:
                      type: string
                      title: Timestamp
                      format: date-time
                      description: The date and time recorded for the action.
                    url:
                      type: string
                      title: URL
                      description: For clicks, the URL the subscriber clicked on.
                    type:
                      type: string
                      title: Campaign Type
                      description: The type of campaign that was sent.
                    campaign_id:
                      type: string
                      title: Campaign ID
                      description: The web-based ID for the campaign.
                    title:
                      type: string
                      title: Campaign Title
                      description: If set, the campaign's title.
                    parent_campaign:
                      type: string
                      title: Parent Campaign ID
                      description: The ID of the parent campaign.
              email_id:
                type: string
                title: Email Hash
                description: The MD5 hash of the lowercase version of the list member's email address.
                readOnly: true
              contact_id:
                type: string
                title: Contact ID
                description: As Mailchimp evolves beyond email, you may eventually have contacts without email addresses. While the `email_id` is the MD5 hash of their email address, this `contact_id` is agnostic of contacts inclusion of an email address.
                readOnly: true
              list_id:
                type: string
                title: List ID
                description: The list 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:
      - Activity
      x-custom-config:
        methodNameSnake: get_list_member_activity
        methodNameCamel: getListMemberActivity
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /lists/{list_id}/members/{subscriber_hash}/activity-feed:
    get:
      summary: Mailchimp View Recent Activity
      description: Get a member's activity on a specific list, including opens, clicks, and unsubscribes.
      operationId: getListsIdMembersIdActivityFeed
      parameters:
      - name: list_id
        x-title: List ID
        in: path
        description: The unique ID for the list.
        required: true
        type: string
        example: '500123'
      - in: path
        name: subscriber_hash
        x-title: Subscriber Hash
        type: string
        required: true
        description: The MD5 hash of the lowercase version of the list member's email address. This endpoint also accepts a list member's email address or contact_id.
        example: example_value
      - 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: query
        name: activity_filters
        x-title: Activity Filters
        type: array
        required: false
        items:
          type: string
        collectionFormat: csv
        enum:
        - - bounce
        - - click
        - - conversation
        - - ecommerce_signup
        - - event
        - - web_engagement
        - - generic_signup
        - - landing_page_signup
        - - marketing_permission
        - - note
        - - open
        - - order
        - - postcard_sent
        - - sent
        - - signup
        - - squatter_signup
        - - unsub
        - - website_signup
        - - survey_response
        - - sms_bulk_sent
        - - inbox_thread
        - - qbo_payment_link
        - - video_call_transcripts
        description: A comma-separated list of activity filters that correspond to a set of activity types, e.g "?activity_filters=open,b

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