swagger: '2.0' info: version: 3.0.55 title: Mailchimp Marketing Abuse Reports 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: Reports paths: /lists/{list_id}/abuse-reports: get: summary: Mailchimp List Abuse Reports description: Get all abuse reports for a specific list. operationId: getListsIdAbuseReports 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 - 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: Abuse Complaints description: A collection of abuse complaints for a specific list. An abuse complaint occurs when your recipient clicks to 'report spam' in their email program. properties: abuse_reports: type: array items: type: object title: Abuse Complaint description: Details of abuse complaints for a specific list. An abuse complaint occurs when your recipient clicks to 'report spam' in their email program. properties: id: type: integer title: Abuse Report ID description: The id for the abuse report readOnly: true campaign_id: type: string title: Campaign ID description: The campaign id for the abuse report readOnly: true list_id: type: string title: List ID description: The list id for the abuse report. readOnly: true 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 date: type: string title: Date description: Date for the abuse report 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: Abuse Reports description: An array of objects, each representing an abuse report resource. list_id: type: string title: List ID description: The list id for the abuse report. 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: - Reports x-custom-config: methodNameSnake: get_list_abuse_reports methodNameCamel: getListAbuseReports x-microcks-operation: delay: 0 dispatcher: FALLBACK /lists/{list_id}/abuse-reports/{report_id}: get: summary: Mailchimp Get Abuse Report description: Get details about a specific abuse report. operationId: getListsIdAbuseReportsId 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 - name: list_id x-title: List ID in: path description: The unique ID for the list. required: true type: string example: '500123' - name: report_id in: path required: true type: string description: The id for the abuse report. example: '500123' responses: '200': description: '' schema: type: object title: Abuse Complaint description: Details of abuse complaints for a specific list. An abuse complaint occurs when your recipient clicks to 'report spam' in their email program. properties: id: type: integer title: Abuse Report ID description: The id for the abuse report readOnly: true campaign_id: type: string title: Campaign ID description: The campaign id for the abuse report readOnly: true list_id: type: string title: List ID description: The list id for the abuse report. readOnly: true 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 date: type: string title: Date description: Date for the abuse report 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: - Reports x-custom-config: methodNameSnake: get_list_abuse_report_details methodNameCamel: getListAbuseReportDetails x-microcks-operation: delay: 0 dispatcher: FALLBACK /reports: get: summary: Mailchimp List Campaign Reports description: Get campaign reports. operationId: getReports 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 - name: type x-title: Campaign Type in: query description: The campaign type. required: false type: string enum: - regular - plaintext - absplit - rss - variate example: example_value - name: before_send_time x-title: Before Send Time in: query description: 'Restrict the response to campaigns sent before the set time. Uses ISO 8601 time format: 2015-10-21T15:41:36+00:00.' type: string format: date-time required: false example: example_value - name: since_send_time x-title: Since Send Time in: query description: 'Restrict the response to campaigns sent after the set time. Uses ISO 8601 time format: 2015-10-21T15:41:36+00:00.' type: string format: date-time required: false example: example_value responses: '200': description: '' schema: type: object title: Campaign Reports description: A list of reports containing campaigns marked as Sent. properties: reports: type: array items: type: object title: Campaign Report description: Report details about a sent campaign. properties: id: type: string title: Campaign ID description: A string that uniquely identifies this campaign. campaign_title: type: string title: Campaign Title description: The title of the campaign. readOnly: true type: type: string title: Campaign Type description: The type of campaign (regular, plain-text, ab_split, rss, automation, variate, or auto). list_id: type: string title: List ID description: The unique 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 list_name: type: string title: List Name description: The name of the list. readOnly: true subject_line: type: string title: Campaign Subject Line description: The subject line for the campaign. readOnly: true preview_text: type: string title: Campaign Preview Text description: The preview text for the campaign. emails_sent: type: integer title: Emails Sent description: The total number of emails sent for this campaign. abuse_reports: type: integer title: Abuse Reports description: The number of abuse reports generated for this campaign. unsubscribed: type: integer title: Unsubscribe Count description: The total number of unsubscribed members for this campaign. readOnly: true send_time: type: string format: date-time title: Send Time description: The date and time a campaign was sent in ISO 8601 format. readOnly: true rss_last_send: type: string format: date-time title: RSS Last Send description: For RSS campaigns, the date and time of the last send in ISO 8601 format. readOnly: true bounces: type: object title: Bounces description: An object describing the bounce summary for the campaign. properties: hard_bounces: type: integer title: Hard Bounces description: The total number of hard bounced email addresses. soft_bounces: type: integer title: Soft Bounces description: The total number of soft bounced email addresses. syntax_errors: type: integer title: Syntax Errors description: The total number of addresses that were syntax-related bounces. forwards: type: object title: Forwards description: An object describing the forwards and forward activity for the campaign. properties: forwards_count: type: integer title: Total Forwards description: How many times the campaign has been forwarded. forwards_opens: type: integer title: Forward Opens description: How many times the forwarded campaign has been opened. opens: type: object title: Opens description: An object describing the open activity for the campaign. properties: opens_total: type: integer title: Total Opens description: The total number of opens for a campaign. unique_opens: type: integer title: Unique Opens description: The total number of unique opens. open_rate: type: number title: Open Rate description: The number of unique opens divided by the total number of successful deliveries. last_open: type: string format: date-time title: Last Open description: The date and time of the last recorded open in ISO 8601 format. clicks: type: object title: Clicks description: An object describing the click activity for the campaign. properties: clicks_total: type: integer title: Total Clicks description: The total number of clicks for the campaign. unique_clicks: type: integer title: Unique Clicks description: The total number of unique clicks for links across a campaign. unique_subscriber_clicks: type: integer title: Unique Subscriber Clicks description: The total number of subscribers who clicked on a campaign. click_rate: type: number title: Click Rate description: The number of unique clicks divided by the total number of successful deliveries. last_click: type: string format: date-time title: Last Click description: The date and time of the last recorded click for the campaign in ISO 8601 format. facebook_likes: type: object title: Facebook Likes description: An object describing campaign engagement on Facebook. properties: recipient_likes: type: integer title: Recipient Likes description: The number of recipients who liked the campaign on Facebook. unique_likes: type: integer title: Unique Likes description: The number of unique likes. facebook_likes: type: integer title: Facebook Likes description: The number of Facebook likes for the campaign. industry_stats: type: object title: Industry Stats description: The average campaign statistics for your industry. properties: type: type: string title: Industry Type description: 'The type of business industry associated with your account. For example: retail, education, etc.' open_rate: type: number title: Open Rate description: The industry open rate. click_rate: type: number title: Click Rate description: The industry click rate. bounce_rate: type: number title: Bounce Rate description: The industry bounce rate. unopen_rate: type: number title: Unopened Rate description: The industry unopened rate. unsub_rate: type: number title: Unsubscribe Rate description: The industry unsubscribe rate. abuse_rate: type: number title: Abuse Rate description: The industry abuse rate. list_stats: type: object title: List Stats description: The average campaign statistics for your list. This won't be present if we haven't calculated it yet for this list. properties: sub_rate: type: number title: Average Subscription Rate description: The average number of subscriptions per month for the list. readOnly: true unsub_rate: type: number title: Average Unsubscription Rate description: The average number of unsubscriptions per month for the list. readOnly: true open_rate: type: number title: Open Rate description: The average open rate (a percentage represented as a number between 0 and 100) per campaign for the list. readOnly: true click_rate: type: number title: Click Rate description: The average click rate (a percentage represented as a number between 0 and 100) per campaign for the list. readOnly: true ab_split: type: object title: A/B Split Stats description: General stats about different groups of an A/B Split campaign. Does not return information about Multivariate Campaigns. properties: a: type: object title: Campaign A description: Stats for Campaign A. properties: bounces: type: integer title: Bounces description: Bounces for Campaign A. abuse_reports: type: integer title: Abuse Reports description: Abuse reports for Campaign A. unsubs: type: integer title: Unsubscribes description: Unsubscribes for Campaign A. recipient_clicks: type: integer title: Recipient Clicks description: Recipient Clicks for Campaign A. forwards: type: integer title: Forwards description: Forwards for Campaign A. forwards_opens: type: integer title: Forward Opens description: Opens from forwards for Campaign A. opens: type: integer title: Opens description: Opens for Campaign A. last_open: type: string title: Last Open description: The last open for Campaign A. unique_opens: type: integer title: Unique Opens description: Unique opens for Campaign A. b: type: object title: Campaign B description: Stats for Campaign B. properties: bounces: type: integer title: Bounces description: Bounces for Campaign B. abuse_reports: type: integer title: Abuse Reports description: Abuse reports for Campaign B. unsubs: type: integer title: Unsubscribes description: Unsubscribes for Campaign B. recipient_clicks: type: integer title: Recipient Clicks description: Recipients clicks for Campaign B. forwards: type: integer title: Forwards description: Forwards for Campaign B. forwards_opens: type: integer title: Forward Opens description: Opens for forwards from Campaign B. opens: type: integer title: Opens description: Opens for Campaign B. last_open: type: string title: Last Open description: The last open for Campaign B. unique_opens: type: integer title: Unique Opens description: Unique opens for Campaign B. timewarp: type: array title: Timewarp Stats description: An hourly breakdown of sends, opens, and clicks if a campaign is sent using timewarp. items: type: object properties: gmt_offset: type: integer title: GMT Offset description: For campaigns sent with timewarp, the time zone group the member is apart of. opens: type: integer title: Opens description: The number of opens. last_open: type: string format: date-time title: Last Open description: The date and time of the last open in ISO 8601 format. unique_opens: type: integer title: Unique Opens description: The number of unique opens. clicks: type: integer title: Clicks description: The number of clicks. last_click: type: string format: date-time title: Last Click description: The date and time of the last click in ISO 8601 format. unique_clicks: type: integer title: Unique Clicks description: The number of unique clicks. bounces: type: integer title: Bounces description: The number of bounces. timeseries: type: array title: Timeseries description: An hourly breakdown of the performance of the campaign over the first 24 hours. items: type: object properties: timestamp: type: string format: date-time title: Timestamp description: The date and time for the series in ISO 8601 format. emails_sent: type: integer title: Emails Sent description: The number of emails sent in the timeseries. unique_opens: type: integer title: Unique Opens description: The number of unique opens in the timeseries. recipients_clicks: type: integer title: Recipient Clicks description: The number of clicks in the timeseries. share_report: type: object title: Share Report description: The url and password for the [VIP report](https://mailchimp.com/help/share-a-campaign-report/). properties: share_url: type: string title: Report URL description: The URL for the VIP report. readOnly: true share_password: type: string title: Report Password description: If password protected, the password for the VIP report. readOnly: true ecommerce: type: object title: E-Commerce Report description: E-Commerce stats for a campaign. properties: total_orders: type: integer title: Total Orders description: The total orders for a campaign. readOnly: true total_spent: type: number title: Total Spent description: The total spent for a campaign. Calculated as the sum of all order totals with no deductions. readOnly: true total_revenue: type: number title: Total Revenue description: The total revenue for a campaign. Calculated as the sum of all order totals minus shipping and tax totals. readOnly: true currency_code: type: string title: Three letter currency code for this user readOnly: true example: USD delivery_status: type: object title: Campaign Delivery Status description: Updates on campaigns in the process of sending. properties: enabled: type: boolean title: Delivery Status Enabled description: Whether Campaign Delivery Status is enabled for this account and campaign. readOnly: true can_cancel: type: boolean title: Campaign Cancelable description: Whether a campaign send can be canceled. readOnly: true status: type: string title: Campaign Delivery Status description: The current state of a campaign delivery. enum: - delivering - delivered - canceling - canceled readOnly: true emails_sent: type: integer title: Emails Sent description: The total number of emails confirmed sent for this campaign so far. readOnly: true emails_canceled: type: integer title: Emails Canceled description: The total number of emails canceled for this campaign. 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: Lists description: An array of objects, each representing a report resource. 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: - Reports x-custom-config: methodNameSnake: get_all_campaign_reports methodNameCamel: getAllCampaignReports x-microcks-operation: delay: 0 dispatcher: FALLBACK /reports/{campaign_id}: get: summary: Mailchimp Get Campaign Report description: Get report details for a specific sent campaign. operationId: getReportsId 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' responses: '200': description: '' schema: type: object title: Campaign Report description: Report details about a sent campaign. properties: id: type: string title: Campaign ID description: A string that uniquely identifies this campaign. campaign_title: type: string title: Campaign Title description: The title of the campaign. readOnly: true type: type: string title: Campaign Type description: The type of campaign (regular, plain-text, ab_split, rss, automation, variate, or auto). list_id: type: string title: List ID description: The unique 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 list_name: type: string title: List Name description: The name of the list. readOnly: true subject_line: type: string title: Campaign Subject Line description: The subject line for the campaign. readOnly: true preview_text: type: string title: Campaign Preview Text description: The preview text for the campaign. emails_sent: type: integer title: Emails Sent description: The total number of emails sent for this campaign. abuse_reports: type: integer title: Abuse Reports description: The number of abuse reports generated for this campaign. unsubscribed: type: integer title: Unsubscribe Count description: The total number of unsubscribed members for this campaign. readOnly: true send_time: type: string format: date-time title: Send Time description: The date and time a campaign was sent in ISO 8601 format. readOnly: true rss_last_send: type: string format: date-time title: RSS Last Send description: For RSS campaigns, the date and time of the last send in ISO 8601 format. readOnly: true bounces: type: object title: Bounces description: An object describing the bounce summary for the campaign. properties: hard_bounces: type: integer title: Hard Bounces description: The total number of hard bounced email addresses. soft_bounces: type: integer title: Soft Bounces description: The total number of soft bounced email addresses. syntax_errors: type: integer title: Syntax Errors description: The total number of addresses that were syntax-related bounces. forwards: type: object title: Forwards description: An object describing the forwards and forward activity for the campaign. properties: forwards_count: type: integer title: Total Forwards description: How many times the campaign has been forwarded. forwards_opens: type: integer title: Forward Opens description: How many times the forwarded campaign has been opened. opens: type: object title: Opens description: An object describing the open activity for the campaign. properties: opens_total: type: integer title: Total Opens description: The total number of opens for a campaign. unique_opens: type: integer title: Unique Opens description: The total number of unique opens. open_rate: type: number title: Open Rate description: The number of unique opens divided by the total number of successful deliveries. last_open: type: string format: date-time title: Last Open description: The date and time of the last recorded open in ISO 8601 format. clicks: type: object title: Clicks description: An object describing the click activity for the campaign. properties: clicks_total: type: integer title: Total Clicks description: The total number of clicks for the campaign. unique_clicks: type: integer title: Unique Clicks description: The total number of unique clicks for links across a campaign. unique_subscriber_clicks: type: integer title: Unique Subscriber Clicks description: The total number of subscribers who clicked on a campaign. click_rate: type: number title: Click Rate description: The number of unique clicks divided by the total number of successful deliveries. last_click: type: string format: date-time title: Last Click description: The date and time of the last recorded click for the campaign in ISO 8601 format. facebook_likes: type: object title: Facebook Likes description: An object describing campaign engagement on Facebook. properties: recipient_likes: type: integer title: Recipient Likes description: The number of recipients who liked the campaign on Facebook. unique_likes: type: integer title: Unique Likes description: The number of unique likes. facebook_likes: type: integer title: Facebook Likes description: The number of Facebook likes for the campaign. industry_stats: type: object title: Industry Stats description: The average campaign statistics for your industry. properties: type: type: string title: Industry Type description: 'The type of business industry associated with your account. For example: retail, education, etc.' open_rate: type: number title: Open Rate description: The industry open rate. click_rate: type: number title: Click Rate description: The industry click rate. bounce_rate: type: number title: Bounce Rate description: The industry bounce rate. unopen_rate: type: number title: Unopened Rate description: The industry unopened rate. unsub_rate: type: number title: Unsubscribe Rate description: The industry unsubscribe rate. abuse_rate: type: number title: Abuse Rate description: The industry abuse rate. list_stats: type: object title: List Stats description: The average campaign statistics for your list. This won't be present if we haven't calculated it yet for this list. properties: sub_rate: type: number title: Average Subscription Rate description: The average number of subscriptions per month for the list. readOnly: true unsub_rate: type: number title: Average Unsubscription Rate description: The average number of unsubscriptions per month for the list. readOnly: true open_rate: type: number title: Open Rate description: The average open rate (a percentage represented as a number between 0 and 100) per campaign for the list. readOnly: true click_rate: type: number title: Click Rate description: The average click rate (a percentage represented as a number between 0 and 100) per campaign for the list. readOnly: true ab_split: type: object title: A/B Split Stats description: General stats about different groups of an A/B Split campaign. Does not return information about Multivariate Campaigns. properties: a: type: object title: Campaign A description: Stats for Campaign A. properties: bounces: type: integer title: Bounces description: Bounces for Campaign A. abuse_reports: type: integer title: Abuse Reports description: Abuse reports for Campaign A. unsubs: type: integer title: Unsubscribes description: Unsubscribes for Campaign A. recipient_clicks: type: integer title: Recipient Clicks description: Recipient Clicks for Campaign A. forwards: type: integer title: Forwards description: Forwards for Campaign A. forwards_opens: type: integer title: Forward Opens description: Opens from forwards for Campaign A. opens: type: integer title: Opens description: Opens for Campaign A. last_open: type: string title: Last Open description: The last open for Campaign A. unique_opens: type: integer title: Unique Opens description: Unique opens for Campaign A. b: type: object title: Campaign B description: Stats for Campaign B. properties: bounces: type: integer title: Bounces description: Bounces for Campaign B. abuse_reports: type: integer title: Abuse Reports description: Abuse reports for Campaign B. unsubs: type: integer title: Unsubscribes description: Unsubscribes for Campaign B. recipient_clicks: type: integer title: Recipient Clicks description: Recipients clicks for Campaign B. forwards: type: integer title: Forwards description: Forwards for Campaign B. forwards_opens: type: integer title: Forward Opens description: Opens for forwards from Campaign B. opens: type: integer title: Opens description: Opens for Campaign B. last_open: type: string title: Last Open description: The last open for Campaign B. unique_opens: type: integer title: Unique Opens description: Unique opens for Campaign B. timewarp: type: array title: Timewarp Stats description: An hourly breakdown of sends, opens, and clicks if a campaign is sent using timewarp. items: type: object properties: gmt_offset: type: integer title: GMT Offset description: For campaigns sent with timewarp, the time zone group the member is apart of. opens: type: integer title: Opens description: The number of opens. last_open: type: string format: date-time title: Last Open description: The date and time of the last open in ISO 8601 format. unique_opens: type: integer title: Unique Opens description: The number of unique opens. clicks: type: integer title: Clicks description: The number of clicks. last_click: type: string format: date-time title: Last Click description: The date and time of the last click in ISO 8601 format. unique_clicks: type: integer title: Unique Clicks description: The number of unique clicks. bounces: type: integer title: Bounces description: The number of bounces. timeseries: type: array title: Timeseries description: An hourly breakdown of the performance of the campaign over the first 24 hours. items: type: object properties: timestamp: type: string format: date-time title: Timestamp description: The date and time for the series in ISO 8601 format. emails_sent: type: integer title: Emails Sent description: The number of emails sent in the timeseries. unique_opens: type: integer title: Unique Opens description: The number of unique opens in the timeseries. recipients_clicks: type: integer title: Recipient Clicks description: The number of clicks in the timeseries. share_report: type: object title: Share Report description: The url and password for the [VIP report](https://mailchimp.com/help/share-a-campaign-report/). properties: share_url: type: string title: Report URL description: The URL for the VIP report. readOnly: true share_password: type: string title: Report Password description: If password protected, the password for the VIP report. readOnly: true ecommerce: type: object title: E-Commerce Report description: E-Commerce stats for a campaign. properties: total_orders: type: integer title: Total Orders description: The total orders for a campaign. readOnly: true total_spent: type: number title: Total Spent description: The total spent for a campaign. Calculated as the sum of all order totals with no deductions. readOnly: true total_revenue: type: number title: Total Revenue description: The total revenue for a campaign. Calculated as the sum of all order totals minus shipping and tax totals. readOnly: true currency_code: type: string title: Three letter currency code for this user readOnly: true example: USD delivery_status: type: object title: Campaign Delivery Status description: Updates on campaigns in the process of sending. properties: enabled: type: boolean title: Delivery Status Enabled description: Whether Campaign Delivery Status is enabled for this account and campaign. readOnly: true can_cancel: type: boolean title: Campaign Cancelable description: Whether a campaign send can be canceled. readOnly: true status: type: string title: Campaign Delivery Status description: The current state of a campaign delivery. enum: - delivering - delivered - canceling - canceled readOnly: true emails_sent: type: integer title: Emails Sent description: The total number of emails confirmed sent for this campaign so far. readOnly: true emails_canceled: type: integer title: Emails Canceled description: The total number of emails canceled for this campaign. 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: - Reports x-custom-config: methodNameSnake: get_campaign_report methodNameCamel: getCampaignReport x-microcks-operation: delay: 0 dispatcher: FALLBACK /reports/{campaign_id}/abuse-reports: get: summary: Mailchimp List Abuse Reports description: Get a list of abuse complaints for a specific campaign. operationId: getReportsIdAbuseReportsId 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' responses: '200': description: '' schema: type: object title: Abuse Complaints description: A list of abuse complaints for a specific list. properties: abuse_reports: type: array items: type: object title: Abuse Complaint description: Details of abuse complaints for a specific list. An abuse complaint occurs when your recipient clicks to 'report spam' in their email program. properties: id: type: integer title: Abuse Report ID description: The id for the abuse report readOnly: true campaign_id: type: string title: Campaign ID description: The campaign id for the abuse report readOnly: true list_id: type: string title: List ID description: The unique id of the list for the abuse report. 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 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 date: type: string title: Date description: Date for the abuse report format: date-time 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: Abuse Reports description: An array of objects, each representing an abuse report resource. 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: - Reports x-custom-config: methodNameSnake: get_campaign_abuse_reports methodNameCamel: getCampaignAbuseReports x-microcks-operation: delay: 0 dispatcher: FALLBACK /reports/{campaign_id}/abuse-reports/{report_id}: get: summary: Mailchimp Get Abuse Report description: Get information about a specific abuse report for a campaign. operationId: getReportsIdAbuseReportsIdId 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: report_id in: path required: true type: string description: The id for the abuse report. example: '500123' responses: '200': description: '' schema: type: object title: Abuse Complaint description: Details of abuse complaints for a specific list. An abuse complaint occurs when your recipient clicks to 'report spam' in their email program. properties: id: type: integer title: Abuse Report ID description: The id for the abuse report readOnly: true campaign_id: type: string title: Campaign ID description: The campaign id for the abuse report readOnly: true list_id: type: string title: List ID description: The unique id of the list for the abuse report. 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 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 date: type: string title: Date description: Date for the abuse report format: date-time 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: - Reports x-custom-config: methodNameSnake: get_campaign_abuse_report methodNameCamel: getCampaignAbuseReport x-microcks-operation: delay: 0 dispatcher: FALLBACK /reports/{campaign_id}/advice: get: summary: Mailchimp List Campaign Feedback description: Get feedback based on a campaign's statistics. Advice feedback is based on campaign stats like opens, clicks, unsubscribes, bounces, and more. operationId: getReportsIdAdvice 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' responses: '200': description: '' schema: type: object title: Campaign Advice Report description: A list of feedback based on a campaign's statistics. properties: advice: type: array items: type: object title: Campaign Advice description: Campaign feedback details. properties: type: type: string title: Advice Type description: The sentiment type for a feedback message. enum: - negative - positive - neutral readOnly: true message: type: string title: Advice Message description: The advice message. 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: Campaign Advice description: An array of objects, each representing a point of campaign feedback. 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: - Reports x-custom-config: methodNameSnake: get_campaign_advice methodNameCamel: getCampaignAdvice x-microcks-operation: delay: 0 dispatcher: FALLBACK /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: - Reports 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: - Reports 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. 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: Lists description: An array of objects, each representing a member who clicked a specific link within a 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: - Reports x-custom-config: methodNameSnake: get_subscribers_info methodNameCamel: getSubscribersInfo x-microcks-operation: delay: 0 dispatcher: FALLBACK /reports/{campaign_id}/click-details/{link_id}/members/{subscriber_hash}: get: summary: Mailchimp Get Clicked Link Subscriber description: Get information about a specific subscriber who clicked a link in a specific campaign. operationId: getReportsIdClickDetailsIdMembersId 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' - 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. example: example_value responses: '200': description: '' schema: 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. 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: - Reports x-custom-config: methodNameSnake: get_subscriber_info methodNameCamel: getSubscriberInfo x-microcks-operation: delay: 0 dispatcher: FALLBACK /reports/{campaign_id}/open-details: get: summary: Mailchimp List Campaign Open Details description: Get detailed information about any campaign emails that were opened by a list member. operationId: getReportsIdOpenDetails 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: since x-title: Campaign opens since in: query required: false description: 'Restrict results to campaign open events that occur after a specific time. Uses ISO 8601 time format: 2015-10-21T15:41:36+00:00.' type: string x-example: '2016-04-12 12:00:00' example: example_value - name: sort_field x-title: Sort By Field description: Returns open reports sorted by the specified field. in: query required: false type: string enum: - opens_count 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: Open Detail Report description: A detailed report of any campaign emails that were opened by a list member. properties: members: type: array items: type: object title: Open Activity description: A list of a member's opens activity in a specific campaign. properties: campaign_id: type: string title: Campaign ID description: The unique id for the campaign. readOnly: true list_id: type: string title: List ID description: The unique id for the list. 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 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 opens_count: type: integer title: Opens count description: The total number of times the this campaign was opened by the list member. readOnly: true opens: type: array title: Time series data of opens activity description: An array of timestamps for each time a list member opened the campaign. If a list member opens an email multiple times, this will return a separate timestamp for each open event. items: type: object title: Member Activity description: A summary of the interaction with the campaign. properties: timestamp: type: string title: Timestamp description: The date and time recorded for the action in ISO 8601 format. format: date-time _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: Open Reports description: An array of objects, each representing a list member who opened a campaign email. Each members object will contain information about the number of total opens by a single member, as well as timestamps for each open event. campaign_id: type: string title: Campaign ID description: The campaign id. readOnly: true total_opens: type: integer title: Total opens description: The total number of opens matching the query regardless of pagination. 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: - Reports x-custom-config: methodNameSnake: get_campaign_open_details methodNameCamel: getCampaignOpenDetails x-microcks-operation: delay: 0 dispatcher: FALLBACK /reports/{campaign_id}/open-details/{subscriber_hash}: get: summary: Mailchimp Get Opened Campaign Subscriber description: Get information about a specific subscriber who opened a campaign. operationId: getReportsIdOpenDetailsIdMembersId 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' - 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. example: example_value responses: '200': description: '' schema: type: object title: Open Activity description: A list of a member's opens activity in a specific campaign. properties: campaign_id: type: string title: Campaign ID description: The unique id for the campaign. readOnly: true list_id: type: string title: List ID description: The unique id for the list. 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 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 opens_count: type: integer title: Opens count description: The total number of times the this campaign was opened by the list member. readOnly: true opens: type: array title: Time series data of opens activity description: An array of timestamps for each time a list member opened the campaign. If a list member opens an email multiple times, this will return a separate timestamp for each open event. items: type: object title: Member Activity description: A summary of the interaction with the campaign. properties: timestamp: type: string title: Timestamp description: The date and time recorded for the action in ISO 8601 format. format: date-time _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: - Reports x-custom-config: methodNameSnake: get_subscriber_info_for_opened_campaign methodNameCamel: getSubscriberInfoForOpenedCampaign x-microcks-operation: delay: 0 dispatcher: FALLBACK /reports/{campaign_id}/domain-performance: get: summary: Mailchimp List Domain Performance Stats description: Get statistics for the top-performing email domains in a campaign. operationId: getReportsIdDomainPerformance 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' responses: '200': description: '' schema: type: object title: Domain Performance description: Statistics for the top-performing email domains in a campaign. properties: domains: type: array items: type: object title: Email Domain description: A single email domain's performance properties: domain: type: string title: Domain description: The name of the domain (gmail.com, hotmail.com, yahoo.com). readOnly: true emails_sent: type: integer title: Total Sent description: The number of emails sent to that specific domain. readOnly: true bounces: type: integer title: Bounces description: The number of bounces at a domain. readOnly: true opens: type: integer title: Opens description: The number of opens for a domain. readOnly: true clicks: type: integer title: Clicks description: The number of clicks for a domain. readOnly: true unsubs: type: integer title: Unsubscribes description: The total number of unsubscribes for a domain. readOnly: true delivered: type: integer title: Successful Deliveries description: The number of successful deliveries for a domain. readOnly: true emails_pct: type: number title: Email Percent description: The percentage of total emails that went to this domain. readOnly: true bounces_pct: type: number title: Bounces Percent description: The percentage of total bounces from this domain. readOnly: true opens_pct: type: number title: Opens Percent description: The percentage of total opens from this domain. readOnly: true clicks_pct: type: number title: Clicks Percent description: The percentage of total clicks from this domain. readOnly: true unsubs_pct: type: number title: Unsubscribes Percent description: The percentage of total unsubscribes from this domain. readOnly: true title: Lists description: The top 5 email domains based on total delivered emails. readOnly: true total_sent: type: integer title: Total Sent description: The total number of emails sent for the campaign. readOnly: true campaign_id: type: string title: Campaign ID description: The unique id for the campaign. 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: - Reports x-custom-config: methodNameSnake: get_domain_performance_for_campaign methodNameCamel: getDomainPerformanceForCampaign x-microcks-operation: delay: 0 dispatcher: FALLBACK /reports/{campaign_id}/eepurl: get: summary: Mailchimp List Eepurl Activity description: Get a summary of social activity for the campaign, tracked by EepURL. operationId: getReportsIdEepurl 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' responses: '200': description: '' schema: type: object title: Eepurl Activity description: A summary of social activity for the campaign, tracked by EepURL. properties: twitter: type: object title: Twitter Stats description: A summary of Twitter activity for a campaign. properties: tweets: type: integer title: Tweet Count description: The number of tweets including a link to the campaign. readOnly: true first_tweet: type: string title: First Tweet Timestamp description: The day and time of the first recorded tweet with a link to the campaign. readOnly: true last_tweet: type: string title: Last Tweet Timestamp description: The day and time of the last recorded tweet with a link to the campaign. readOnly: true retweets: type: integer title: Retweet Count description: The number of retweets that include a link to the campaign. readOnly: true statuses: type: array title: Twitter Status description: A summary of tweets that include a link to the campaign. readOnly: true items: type: object title: Twitter Status description: An individual tweet. properties: status: type: string title: Status Body description: The body of the tweet. readOnly: true screen_name: type: string title: Screen Name description: The Twitter handle for the author of the tweet. readOnly: true status_id: type: string title: Status ID description: The individual id for the tweet. readOnly: true datetime: type: string title: Datetime description: A timestamp for the tweet. format: date-time readOnly: true is_retweet: type: boolean title: Is Retweet description: A 'true' or 'false' status of whether the tweet is a retweet. readOnly: true clicks: type: object title: Click Summary description: A summary of the click-throughs on the campaign's URL. readOnly: true properties: clicks: type: integer title: Clicks description: The total number of clicks to the campaign's URL. readOnly: true first_click: type: string title: First Click description: The timestamp for the first click to the URL. format: date-time readOnly: true last_click: type: string title: Last Click description: The timestamp for the last click to the URL. format: date-time readOnly: true locations: type: array title: Click Locations description: A summary of the top click locations. readOnly: true items: type: object title: Location description: An individual click location. properties: country: type: string title: Country description: The two-digit country code for a recorded click. region: type: string title: Region description: If available, a specific region where the click was recorded. example: NY referrers: type: array title: Referrers description: A summary of the top referrers for the campaign. readOnly: true items: type: object title: Referrer description: A single instance of a campaign referral. properties: referrer: type: string title: Referrer description: A referrer (truncated to 100 bytes). clicks: type: integer title: Clicks description: The number of clicks a single referrer generated. first_click: type: string title: First Click description: The timestamp for the first click from this referrer. format: date-time last_click: type: string title: Last Click description: The timestamp for the last click from this referrer. format: date-time x-title: Referrers eepurl: type: string title: Eepurl description: The shortened link used for tracking. readOnly: true campaign_id: type: string title: Campaign ID description: The unique id for the campaign. 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: - Reports x-custom-config: methodNameSnake: get_eepurl_activity_for_campaign methodNameCamel: getEepurlActivityForCampaign x-microcks-operation: delay: 0 dispatcher: FALLBACK /reports/{campaign_id}/email-activity: get: summary: Mailchimp List Email Activity description: Get a list of member's subscriber activity in a specific campaign. operationId: getReportsIdEmailActivity 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: since x-title: Email Activity since in: query required: false description: 'Restrict results to email activity events that occur after a specific time. Uses ISO 8601 time format: 2015-10-21T15:41:36+00:00.' type: string example: example_value responses: '200': description: '' schema: type: object title: Email Activity description: A list of member's subscriber activity in a specific campaign. properties: emails: type: array items: type: object title: Email Activity description: A list of a member's subscriber activity in a specific campaign, including opens, clicks, and bounces. properties: campaign_id: type: string title: Campaign ID description: The unique id for the campaign. readOnly: true list_id: type: string title: List ID description: The unique id for the list. 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 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 activity: type: array title: Member Activity description: An array of objects, each showing an interaction with the email. Member activity limited to 1,000 open activities and 1,000 click activities per member per campaign. items: type: object title: Member Activity description: A summary of the interaction with the campaign. properties: action: type: string title: Action description: 'One of the following actions: ''open'', ''click'', or ''bounce''' type: type: string title: Type description: 'If the action is a ''bounce'', the type of bounce received: ''hard'', ''soft''.' timestamp: type: string title: Timestamp description: The date and time recorded for the action in ISO 8601 format. format: date-time url: type: string title: URL description: If the action is a 'click', the URL on which the member clicked. ip: type: string title: IP description: The IP address recorded for the action. _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: Sent To description: An array of members that were sent the campaign. campaign_id: type: string title: Campaign ID description: The unique id for the sent campaign. 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: - Reports x-custom-config: methodNameSnake: get_email_activity_for_campaign methodNameCamel: getEmailActivityForCampaign x-microcks-operation: delay: 0 dispatcher: FALLBACK /reports/{campaign_id}/email-activity/{subscriber_hash}: get: summary: Mailchimp Get Subscriber Email Activity description: Get a specific list member's activity in a campaign including opens, clicks, and bounces. operationId: getReportsIdEmailActivityId 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' - 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. example: example_value - name: since x-title: Email Activity since in: query required: false description: 'Restrict results to email activity events that occur after a specific time. Uses ISO 8601 time format: 2015-10-21T15:41:36+00:00.' type: string example: example_value responses: '200': description: '' schema: type: object title: Email Activity description: A list of a member's subscriber activity in a specific campaign, including opens, clicks, and bounces. properties: campaign_id: type: string title: Campaign ID description: The unique id for the campaign. readOnly: true list_id: type: string title: List ID description: The unique id for the list. 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 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 activity: type: array title: Member Activity description: An array of objects, each showing an interaction with the email. Member activity limited to 1,000 open activities and 1,000 click activities per member per campaign. items: type: object title: Member Activity description: A summary of the interaction with the campaign. properties: action: type: string title: Action description: 'One of the following actions: ''open'', ''click'', or ''bounce''' type: type: string title: Type description: 'If the action is a ''bounce'', the type of bounce received: ''hard'', ''soft''.' timestamp: type: string title: Timestamp description: The date and time recorded for the action in ISO 8601 format. format: date-time url: type: string title: URL description: If the action is a 'click', the URL on which the member clicked. ip: type: string title: IP description: The IP address recorded for the action. _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: - Reports x-custom-config: methodNameSnake: get_email_activity_for_subscriber methodNameCamel: getEmailActivityForSubscriber x-microcks-operation: delay: 0 dispatcher: FALLBACK /reports/{campaign_id}/locations: get: summary: Mailchimp List Top Open Activities description: Get top open locations for a specific campaign. operationId: getReportsIdLocations 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: 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: '' schema: type: object title: Open Locations description: Top open locations for a specific campaign. properties: locations: type: array items: type: object properties: country_code: type: string title: Country Code description: The ISO 3166 2 digit country code. readOnly: true region: type: string title: Region description: An internal code for the region representing the more specific location area such as city or state. When this is blank, it indicates we know the country, but not the region. readOnly: true region_name: type: string title: Region Name description: The name of the region, if we have one. For blank "region" values, this will be "Rest of Country". readOnly: true opens: type: integer title: Opens description: The number of unique campaign opens for a region. readOnly: true title: Lists description: An array of objects, each representing a top location for opens. 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: - Reports x-custom-config: methodNameSnake: get_locations_for_campaign methodNameCamel: getLocationsForCampaign x-microcks-operation: delay: 0 dispatcher: FALLBACK /reports/{campaign_id}/sent-to: get: summary: Mailchimp List Campaign Recipients description: Get information about campaign recipients. operationId: getReportsIdSentTo 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' responses: '200': description: '' schema: type: object title: Sent-To description: A list of subscribers who were sent a specific campaign. properties: sent_to: type: array items: type: object title: Sent To description: A subscriber's status for 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 status: type: string title: Delivery Status description: The status of the email delivered to this subscriber. `hard` and `soft` refer to different [bounce types](https://mailchimp.com/help/soft-vs-hard-bounces/). enum: - sent - hard - soft open_count: type: integer title: Open Count description: The number of times a campaign was opened by this member. last_open: type: string title: Last Open description: The date and time of the last open for this member in ISO 8601 format. format: date-time absplit_group: type: string title: A/B Split Group description: For A/B Split Campaigns, the group the member was apart of. enum: - a - b - winner gmt_offset: type: integer title: GMT Offset description: For campaigns sent with timewarp, the time zone group the member is apart of. campaign_id: type: string title: Campaign ID description: The campaign id. readOnly: true list_id: type: string title: List ID description: The unique 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 _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: Sent To description: An array of objects, each representing a campaign recipient. 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: - Reports x-custom-config: methodNameSnake: get_campaign_recipients methodNameCamel: getCampaignRecipients x-microcks-operation: delay: 0 dispatcher: FALLBACK /reports/{campaign_id}/sent-to/{subscriber_hash}: get: summary: Mailchimp Get Campaign Recipient Info description: Get information about a specific campaign recipient. operationId: getReportsIdSentToId 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' - 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. example: example_value responses: '200': description: '' schema: type: object title: Sent To description: A subscriber's status for 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 status: type: string title: Delivery Status description: The status of the email delivered to this subscriber. `hard` and `soft` refer to different [bounce types](https://mailchimp.com/help/soft-vs-hard-bounces/). enum: - sent - hard - soft open_count: type: integer title: Open Count description: The number of times a campaign was opened by this member. last_open: type: string title: Last Open description: The date and time of the last open for this member in ISO 8601 format. format: date-time absplit_group: type: string title: A/B Split Group description: For A/B Split Campaigns, the group the member was apart of. enum: - a - b - winner gmt_offset: type: integer title: GMT Offset description: For campaigns sent with timewarp, the time zone group the member is apart of. campaign_id: type: string title: Campaign ID description: The campaign id. readOnly: true list_id: type: string title: List ID description: The unique 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 _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: - Reports x-custom-config: methodNameSnake: get_campaign_recipient methodNameCamel: getCampaignRecipient x-microcks-operation: delay: 0 dispatcher: FALLBACK /reports/{campaign_id}/sub-reports: get: summary: Mailchimp List Child Campaign Reports description: Get a list of reports with child campaigns for a specific parent campaign. operationId: getReportsIdSubReportsId 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' responses: '200': description: '' schema: type: object title: Campaign Sub-Reports description: A list of reports containing child campaigns for a specific campaign. properties: reports: type: array items: type: object title: Campaign Report description: Report details about a sent campaign. properties: id: type: string title: Campaign ID description: A string that uniquely identifies this campaign. campaign_title: type: string title: Campaign Title description: The title of the campaign. readOnly: true type: type: string title: Campaign Type description: The type of campaign (regular, plain-text, ab_split, rss, automation, variate, or auto). list_id: type: string title: List ID description: The unique 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 list_name: type: string title: List Name description: The name of the list. readOnly: true subject_line: type: string title: Campaign Subject Line description: The subject line for the campaign. readOnly: true preview_text: type: string title: Campaign Preview Text description: The preview text for the campaign. emails_sent: type: integer title: Emails Sent description: The total number of emails sent for this campaign. abuse_reports: type: integer title: Abuse Reports description: The number of abuse reports generated for this campaign. unsubscribed: type: integer title: Unsubscribe Count description: The total number of unsubscribed members for this campaign. readOnly: true send_time: type: string format: date-time title: Send Time description: The date and time a campaign was sent in ISO 8601 format. readOnly: true rss_last_send: type: string format: date-time title: RSS Last Send description: For RSS campaigns, the date and time of the last send in ISO 8601 format. readOnly: true bounces: type: object title: Bounces description: An object describing the bounce summary for the campaign. properties: hard_bounces: type: integer title: Hard Bounces description: The total number of hard bounced email addresses. soft_bounces: type: integer title: Soft Bounces description: The total number of soft bounced email addresses. syntax_errors: type: integer title: Syntax Errors description: The total number of addresses that were syntax-related bounces. forwards: type: object title: Forwards description: An object describing the forwards and forward activity for the campaign. properties: forwards_count: type: integer title: Total Forwards description: How many times the campaign has been forwarded. forwards_opens: type: integer title: Forward Opens description: How many times the forwarded campaign has been opened. opens: type: object title: Opens description: An object describing the open activity for the campaign. properties: opens_total: type: integer title: Total Opens description: The total number of opens for a campaign. unique_opens: type: integer title: Unique Opens description: The total number of unique opens. open_rate: type: number title: Open Rate description: The number of unique opens divided by the total number of successful deliveries. last_open: type: string format: date-time title: Last Open description: The date and time of the last recorded open in ISO 8601 format. clicks: type: object title: Clicks description: An object describing the click activity for the campaign. properties: clicks_total: type: integer title: Total Clicks description: The total number of clicks for the campaign. unique_clicks: type: integer title: Unique Clicks description: The total number of unique clicks for links across a campaign. unique_subscriber_clicks: type: integer title: Unique Subscriber Clicks description: The total number of subscribers who clicked on a campaign. click_rate: type: number title: Click Rate description: The number of unique clicks divided by the total number of successful deliveries. last_click: type: string format: date-time title: Last Click description: The date and time of the last recorded click for the campaign in ISO 8601 format. facebook_likes: type: object title: Facebook Likes description: An object describing campaign engagement on Facebook. properties: recipient_likes: type: integer title: Recipient Likes description: The number of recipients who liked the campaign on Facebook. unique_likes: type: integer title: Unique Likes description: The number of unique likes. facebook_likes: type: integer title: Facebook Likes description: The number of Facebook likes for the campaign. industry_stats: type: object title: Industry Stats description: The average campaign statistics for your industry. properties: type: type: string title: Industry Type description: 'The type of business industry associated with your account. For example: retail, education, etc.' open_rate: type: number title: Open Rate description: The industry open rate. click_rate: type: number title: Click Rate description: The industry click rate. bounce_rate: type: number title: Bounce Rate description: The industry bounce rate. unopen_rate: type: number title: Unopened Rate description: The industry unopened rate. unsub_rate: type: number title: Unsubscribe Rate description: The industry unsubscribe rate. abuse_rate: type: number title: Abuse Rate description: The industry abuse rate. list_stats: type: object title: List Stats description: The average campaign statistics for your list. This won't be present if we haven't calculated it yet for this list. properties: sub_rate: type: number title: Average Subscription Rate description: The average number of subscriptions per month for the list. readOnly: true unsub_rate: type: number title: Average Unsubscription Rate description: The average number of unsubscriptions per month for the list. readOnly: true open_rate: type: number title: Open Rate description: The average open rate (a percentage represented as a number between 0 and 100) per campaign for the list. readOnly: true click_rate: type: number title: Click Rate description: The average click rate (a percentage represented as a number between 0 and 100) per campaign for the list. readOnly: true ab_split: type: object title: A/B Split Stats description: General stats about different groups of an A/B Split campaign. Does not return information about Multivariate Campaigns. properties: a: type: object title: Campaign A description: Stats for Campaign A. properties: bounces: type: integer title: Bounces description: Bounces for Campaign A. abuse_reports: type: integer title: Abuse Reports description: Abuse reports for Campaign A. unsubs: type: integer title: Unsubscribes description: Unsubscribes for Campaign A. recipient_clicks: type: integer title: Recipient Clicks description: Recipient Clicks for Campaign A. forwards: type: integer title: Forwards description: Forwards for Campaign A. forwards_opens: type: integer title: Forward Opens description: Opens from forwards for Campaign A. opens: type: integer title: Opens description: Opens for Campaign A. last_open: type: string title: Last Open description: The last open for Campaign A. unique_opens: type: integer title: Unique Opens description: Unique opens for Campaign A. b: type: object title: Campaign B description: Stats for Campaign B. properties: bounces: type: integer title: Bounces description: Bounces for Campaign B. abuse_reports: type: integer title: Abuse Reports description: Abuse reports for Campaign B. unsubs: type: integer title: Unsubscribes description: Unsubscribes for Campaign B. recipient_clicks: type: integer title: Recipient Clicks description: Recipients clicks for Campaign B. forwards: type: integer title: Forwards description: Forwards for Campaign B. forwards_opens: type: integer title: Forward Opens description: Opens for forwards from Campaign B. opens: type: integer title: Opens description: Opens for Campaign B. last_open: type: string title: Last Open description: The last open for Campaign B. unique_opens: type: integer title: Unique Opens description: Unique opens for Campaign B. timewarp: type: array title: Timewarp Stats description: An hourly breakdown of sends, opens, and clicks if a campaign is sent using timewarp. items: type: object properties: gmt_offset: type: integer title: GMT Offset description: For campaigns sent with timewarp, the time zone group the member is apart of. opens: type: integer title: Opens description: The number of opens. last_open: type: string format: date-time title: Last Open description: The date and time of the last open in ISO 8601 format. unique_opens: type: integer title: Unique Opens description: The number of unique opens. clicks: type: integer title: Clicks description: The number of clicks. last_click: type: string format: date-time title: Last Click description: The date and time of the last click in ISO 8601 format. unique_clicks: type: integer title: Unique Clicks description: The number of unique clicks. bounces: type: integer title: Bounces description: The number of bounces. timeseries: type: array title: Timeseries description: An hourly breakdown of the performance of the campaign over the first 24 hours. items: type: object properties: timestamp: type: string format: date-time title: Timestamp description: The date and time for the series in ISO 8601 format. emails_sent: type: integer title: Emails Sent description: The number of emails sent in the timeseries. unique_opens: type: integer title: Unique Opens description: The number of unique opens in the timeseries. recipients_clicks: type: integer title: Recipient Clicks description: The number of clicks in the timeseries. share_report: type: object title: Share Report description: The url and password for the [VIP report](https://mailchimp.com/help/share-a-campaign-report/). properties: share_url: type: string title: Report URL description: The URL for the VIP report. readOnly: true share_password: type: string title: Report Password description: If password protected, the password for the VIP report. readOnly: true ecommerce: type: object title: E-Commerce Report description: E-Commerce stats for a campaign. properties: total_orders: type: integer title: Total Orders description: The total orders for a campaign. readOnly: true total_spent: type: number title: Total Spent description: The total spent for a campaign. Calculated as the sum of all order totals with no deductions. readOnly: true total_revenue: type: number title: Total Revenue description: The total revenue for a campaign. Calculated as the sum of all order totals minus shipping and tax totals. readOnly: true currency_code: type: string title: Three letter currency code for this user readOnly: true example: USD delivery_status: type: object title: Campaign Delivery Status description: Updates on campaigns in the process of sending. properties: enabled: type: boolean title: Delivery Status Enabled description: Whether Campaign Delivery Status is enabled for this account and campaign. readOnly: true can_cancel: type: boolean title: Campaign Cancelable description: Whether a campaign send can be canceled. readOnly: true status: type: string title: Campaign Delivery Status description: The current state of a campaign delivery. enum: - delivering - delivered - canceling - canceled readOnly: true emails_sent: type: integer title: Emails Sent description: The total number of emails confirmed sent for this campaign so far. readOnly: true emails_canceled: type: integer title: Emails Canceled description: The total number of emails canceled for this campaign. 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: Reports description: An array of objects, each representing a report resource. campaign_id: type: string title: Campaign ID description: Unique identifier of the parent campaign 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: - Reports x-custom-config: methodNameSnake: get_sub_reports_for_campaign methodNameCamel: getSubReportsForCampaign x-microcks-operation: delay: 0 dispatcher: FALLBACK /reports/{campaign_id}/unsubscribed: get: summary: Mailchimp List Unsubscribed Members description: Get information about members who have unsubscribed from a specific campaign. operationId: getReportsIdUnsubscribed 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' responses: '200': description: '' schema: type: object title: Unsubscribes description: A list of members who have unsubscribed from a specific campaign. properties: unsubscribes: type: array items: type: object title: Unsubscribes description: A member who unsubscribed from 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 timestamp: type: string title: Timestamp description: The date and time the member opted-out in ISO 8601 format. format: date-time readOnly: true reason: type: string title: Unsubscribe Reason description: If available, the reason listed by the member for unsubscribing. readOnly: true campaign_id: type: string title: Campaign ID description: The campaign id. 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 _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: Lists description: An array of objects, each representing a member who unsubscribed from a 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: - Reports x-custom-config: methodNameSnake: get_unsubscribed_list_for_campaign methodNameCamel: getUnsubscribedListForCampaign x-microcks-operation: delay: 0 dispatcher: FALLBACK /reports/{campaign_id}/unsubscribed/{subscriber_hash}: get: summary: Mailchimp Get Unsubscribed Member description: Get information about a specific list member who unsubscribed from a campaign. operationId: getReportsIdUnsubscribedId 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' - 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. example: example_value responses: '200': description: '' schema: type: object title: Unsubscribes description: A member who unsubscribed from 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 timestamp: type: string title: Timestamp description: The date and time the member opted-out in ISO 8601 format. format: date-time readOnly: true reason: type: string title: Unsubscribe Reason description: If available, the reason listed by the member for unsubscribing. readOnly: true campaign_id: type: string title: Campaign ID description: The campaign id. 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 _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: - Reports x-custom-config: methodNameSnake: get_unsubscribed_list_member methodNameCamel: getUnsubscribedListMember x-microcks-operation: delay: 0 dispatcher: FALLBACK /reports/{campaign_id}/ecommerce-product-activity: get: description: Get breakdown of product activity for a campaign 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 files sorted by the specified field. in: query required: false type: string enum: - title - total_revenue - total_purchased example: example_value responses: '200': description: Ecommerce Product Activity Instance schema: type: object description: A collection of ecommerce products. properties: products: type: array items: type: object properties: title: type: string sku: type: string image_url: type: string total_revenue: type: number total_purchased: type: number currency_code: type: string recommendation_total: type: integer recommendation_purchased: type: integer 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: - Reports x-custom-config: methodNameSnake: get_ecommerce_product_activity_for_campaign methodNameCamel: getEcommerceProductActivityForCampaign summary: Mailchimp List Campaign Product Activity operationId: getReportsIdEcommerceProductActivity x-microcks-operation: delay: 0 dispatcher: FALLBACK securityDefinitions: basicAuth: type: basic externalDocs: description: Learn more with the full Mailchimp API documentation. url: https://mailchimp.com/developer/marketing/ x-doc-structure: resources: root: title: API Root description: The API root resource links to all other resources available in the API. Calling the root directory also returns details about the Mailchimp user account. paths: - / subResources: [] chimp-chatter: title: Chimp Chatter Activity description: Get the latest Chimp Chatter activity from your account. paths: - /activity-feed/chimp-chatter authorized-apps: title: Authorized Apps description: Manage registered, connected apps for your Mailchimp account with the Authorized Apps endpoints. paths: - /authorized-apps - /authorized-apps/{app_id} automation: title: Automations description: Mailchimp's classic automations feature lets you build a series of emails that send to subscribers when triggered by a specific date, activity, or event. Use the API to manage Automation workflows, emails, and queues. Does not include Customer Journeys. paths: - /automations - /automations/{workflow_id} - /automations/{workflow_id}/actions/start-all-emails - /automations/{workflow_id}/actions/pause-all-emails - /automations/{workflow_id}/actions/archive subResources: - automation-email - automation-removed-subscribers automation-email: title: Emails description: Manage individual emails in a classic automation workflow. paths: - /automations/{workflow_id}/emails - /automations/{workflow_id}/emails/{workflow_email_id} - /automations/{workflow_id}/emails/{workflow_email_id}/actions/pause - /automations/{workflow_id}/emails/{workflow_email_id}/actions/start subResources: - automation-email-queue automation-email-queue: title: Queue description: Manage list member queues for classic automation emails. paths: - /automations/{workflow_id}/emails/{workflow_email_id}/queue - /automations/{workflow_id}/emails/{workflow_email_id}/queue/{subscriber_hash} subResources: [] automation-removed-subscribers: title: Removed Subscribers description: Remove subscribers from a classic automation workflow. paths: - /automations/{workflow_id}/removed-subscribers - /automations/{workflow_id}/removed-subscribers/{subscriber_hash} subResources: [] batch-operations: title: Batch Operations description: Use batch operations to complete multiple operations with a single call. paths: - /batches - /batches/{batch_id} batch-webhooks: title: Batch Webhooks description: 'Manage webhooks for batch operations. ' paths: - /batch-webhooks - /batch-webhooks/{batch_webhook_id} account-exports: title: Account Exports description: Generate a new export or download a finished export. paths: - /account-exports - /account-exports/{export_id} campaigns: title: Campaigns description: Campaigns are how you send emails to your Mailchimp list. Use the Campaigns API calls to manage campaigns in your Mailchimp account. paths: - /campaigns - /campaigns/{campaign_id} - /campaigns/{campaign_id}/actions/cancel-send - /campaigns/{campaign_id}/actions/send - /campaigns/{campaign_id}/actions/schedule - /campaigns/{campaign_id}/actions/unschedule - /campaigns/{campaign_id}/actions/pause - /campaigns/{campaign_id}/actions/resume - /campaigns/{campaign_id}/actions/replicate - /campaigns/{campaign_id}/actions/test - /campaigns/{campaign_id}/actions/create-resend subResources: - campaign-feedback - campaign-checklist - campaign-content campaign-feedback: title: Feedback description: Post comments, reply to team feedback, and send test emails while you're working together on a Mailchimp campaign. paths: - /campaigns/{campaign_id}/feedback - /campaigns/{campaign_id}/feedback/{feedback_id} campaign-checklist: title: Send Checklist description: Review the send checklist for your campaign, and resolve any issues before sending. paths: - /campaigns/{campaign_id}/send-checklist campaign-content: title: Content description: Manage the HTML, plain-text, and template content for your Mailchimp campaigns. paths: - /campaigns/{campaign_id}/content connected-sites: title: Connected Sites description: Manage sites you've connected to your Mailchimp account. paths: - /connected-sites - /connected-sites/{connected_site_id} - /connected-sites/{connected_site_id}/actions/verify-script-installation conversations: title: Conversations description: Conversation tracking lets you view subscribers' replies to your campaigns in your Mailchimp account. paths: - /conversations - /conversations/{conversation_id} subResources: - conversation-messages conversation-messages: title: Messages description: Manage messages in a specific campaign conversation. paths: - /conversations/{conversation_id}/messages - /conversations/{conversation_id}/messages/{message_id} customer-journeys-journeys-steps-actions: title: Customer Journeys description: Manage Customer Journey automated workflows paths: - /customer-journeys/journeys/{journey_id}/steps/{step_id}/actions/trigger subResources: [] file-manager: title: File Manager description: Manage files for your Mailchimp account. The File Manager is a place to store images, documents, and other files you include or link to in your campaigns, templates, or signup forms. paths: [] subResources: - file-manager-folders - file-manager-files file-manager-folders: title: File Manager Folders description: Manage specific folders in the File Manager for your Mailchimp account. paths: - /file-manager/folders - /file-manager/folders/{folder_id} subResources: - file-manager-folders-files file-manager-files: title: File Manager Files description: Manage specific files in the File Manager for your Mailchimp account. paths: - /file-manager/files - /file-manager/files/{file_id} file-manager-folders-files: title: Files in Folder description: Manage specific files in a folder. paths: - /file-manager/folders/{folder_id}/files landing-pages: title: Landing Pages description: Manage your Landing Pages, including publishing and unpublishing. paths: - /landing-pages - /landing-pages/{page_id} - /landing-pages/{page_id}/actions/publish - /landing-pages/{page_id}/actions/unpublish subResources: - landing-pages_content landing-pages_content: title: Content description: The HTML content for your Mailchimp landing pages. paths: - /landing-pages/{page_id}/content lists: title: Lists/Audiences description: Your Mailchimp list, also known as your audience, is where you store and manage all of your contacts. paths: - /lists - /lists/{list_id} subResources: - interest-categories - list-segments - abuse-reports - list-activity - list-clients - list-growth-history - list-imports - list-members - list-merges - list-webhooks - list-signup-forms - list-locations - lists-tags-search - prebuilt-segments - list-preview-segment - list-surveys - list-sms-program list-members: title: Members description: Manage members of a specific Mailchimp list, including currently subscribed, unsubscribed, and bounced members. paths: - /lists/{list_id}/members - /lists/{list_id}/members/{subscriber_hash} - /lists/{list_id}/members/{subscriber_hash}/actions/delete-permanent subResources: - list-member-activity - list-member-activity-feed - list-member-goal - list-member-notes - list-member-tags - list-member-events list-merges: title: Merge Fields description: Manage merge fields for an audience. See [Merge Field documentation](https://mailchimp.com/developer/marketing/docs/merge-fields/) for more. paths: - /lists/{list_id}/merge-fields - /lists/{list_id}/merge-fields/{merge_id} subResources: [] abuse-reports: title: Abuse Reports description: Manage abuse complaints for a specific list. An abuse complaint occurs when your recipient reports an email as spam in their mail program. paths: - /lists/{list_id}/abuse-reports - /lists/{list_id}/abuse-reports/{report_id} list-activity: title: Activity description: Get recent daily, aggregated activity stats for your list. For example, view unsubscribes, signups, total emails sent, opens, clicks, and more, for up to 180 days. paths: - /lists/{list_id}/activity list-clients: title: Clients description: Get information about the most popular email clients for subscribers in a specific Mailchimp list. paths: - /lists/{list_id}/clients list-growth-history: title: Growth History description: View a summary of the month-by-month growth activity for a specific list. paths: - /lists/{list_id}/growth-history - /lists/{list_id}/growth-history/{month} list-webhooks: title: Webhooks description: Manage webhooks for a specific Mailchimp list. paths: - /lists/{list_id}/webhooks - /lists/{list_id}/webhooks/{webhook_id} list-surveys: title: Surveys description: Get survey data for this audience. paths: - /lists/{list_id}/surveys - /lists/{list_id}/surveys/{survey_id} - /lists/{list_id}/surveys/{survey_id}/actions/publish - /lists/{list_id}/surveys/{survey_id}/actions/unpublish - /lists/{list_id}/surveys/{survey_id}/actions/create-email interest-categories: title: Interest Categories description: Manage interest categories for a specific list. Interest categories organize interests, which are used to group subscribers based on their preferences. These correspond to 'group titles' in the Mailchimp application. paths: - /lists/{list_id}/interest-categories - /lists/{list_id}/interest-categories/{interest_category_id} subResources: - interests interests: title: Interests description: Manage interests for a specific Mailchimp list. Assign subscribers to interests to group them together. Interests are referred to as 'group names' in the Mailchimp application. paths: - /lists/{list_id}/interest-categories/{interest_category_id}/interests - /lists/{list_id}/interest-categories/{interest_category_id}/interests/{interest_id} lists-tags-search: title: Tag Search description: Search for tags on a list by name. paths: - /lists/{list_id}/tag-search list-segments: title: Segments description: Manage segments and tags for a specific Mailchimp list. A segment is a section of your list that includes only those subscribers who share specific common field information. Tags are labels you create to help organize your contacts. paths: - /lists/{list_id}/segments - /lists/{list_id}/segments/{segment_id} subResources: - list-segment-members list-segment-members: title: Segment Members description: Manage list members in a saved segment. paths: - /lists/{list_id}/segments/{segment_id}/members - /lists/{list_id}/segments/{segment_id}/members/{subscriber_hash} list-member-activity: title: Member Activity description: Get details about a subscriber's recent activity. Use the new activity-feed endpoint to access more events for a given contact. paths: - /lists/{list_id}/members/{subscriber_hash}/activity list-member-activity-feed: title: Member Activity Feed description: Get details about a subscriber's recent activity. paths: - /lists/{list_id}/members/{subscriber_hash}/activity-feed list-member-goal: title: Member Goals description: Get information about recent goal events for a specific list member. paths: - /lists/{list_id}/members/{subscriber_hash}/goals list-member-notes: title: Member Notes description: Retrieve recent notes for a specific list member. paths: - /lists/{list_id}/members/{subscriber_hash}/notes - /lists/{list_id}/members/{subscriber_hash}/notes/{note_id} list-member-tags: title: Member Tags description: Manage all the tags that have been assigned to a contact. paths: - /lists/{list_id}/members/{subscriber_hash}/tags list-member-events: title: Events description: 'Use the Events endpoint to collect website or in-app actions and trigger targeted automations. ' paths: - /lists/{list_id}/members/{subscriber_hash}/events list-signup-forms: title: Signup Forms description: Manage list signup forms. paths: - /lists/{list_id}/signup-forms list-locations: title: Locations description: Get the locations (countries) that the list's subscribers have been tagged to based on geocoding their IP address. paths: - /lists/{list_id}/locations reports: title: Reports description: 'Manage campaign reports for your Mailchimp account. All Reports endpoints are read-only. Mailchimp''s campaign and automation reports analyze clicks, opens, subscribers'' social activity, e-commerce data, and more. Note: Campaign IDs for A/B Testing Campaigns are available through the Campaign API Endpoint''s Read method.' paths: - /reports - /reports/{campaign_id} subResources: - campaign-abuse - campaign-advice - click-reports - domain-performance-reports - eepurl-reports - email-activity-reports - location-reports - sent-to-reports - sub-reports - unsub-reports - open-reports - campaign-ecommerce-product-activity campaign-abuse: title: Campaign Abuse description: Get information about campaign abuse complaints. paths: - /reports/{campaign_id}/abuse-reports - /reports/{campaign_id}/abuse-reports/{report_id} campaign-advice: title: Campaign Advice description: Get recent feedback based on a campaign's statistics. paths: - /reports/{campaign_id}/advice open-reports: title: Campaign Open Reports description: 'Get a detailed report about any emails in a specific campaign that were opened by the recipient. ' paths: - /reports/{campaign_id}/open-details - /reports/{campaign_id}/open-details/{subscriber_hash} click-reports: title: Click Reports description: Get detailed information about links clicked in campaigns. paths: - /reports/{campaign_id}/click-details - /reports/{campaign_id}/click-details/{link_id} subResources: - link-clickers campaign-ecommerce-product-activity: title: Ecommerce Product Activity description: Ecommerce product activity report for a campaign. paths: - /reports/{campaign_id}/ecommerce-product-activity link-clickers: title: Click Reports Members description: Get information about specific subscribers who clicked on links in a campaign. paths: - /reports/{campaign_id}/click-details/{link_id}/members - /reports/{campaign_id}/click-details/{link_id}/members/{subscriber_hash} domain-performance-reports: title: Domain Performance description: Get statistics for the top-performing domains from a campaign. paths: - /reports/{campaign_id}/domain-performance eepurl-reports: title: EepURL Reports description: Get a summary of social activity for the campaign, tracked by EepURL. paths: - /reports/{campaign_id}/eepurl email-activity-reports: title: Email Activity description: Get list member activity for a specific campaign. paths: - /reports/{campaign_id}/email-activity - /reports/{campaign_id}/email-activity/{subscriber_hash} location-reports: title: Location description: Get top open locations for a specific campaign. paths: - /reports/{campaign_id}/locations sent-to-reports: title: Sent To description: Get details about campaign recipients. paths: - /reports/{campaign_id}/sent-to - /reports/{campaign_id}/sent-to/{subscriber_hash} sub-reports: title: Sub-Reports description: A list of reports for child campaigns of a specific parent campaign. For example, use this endpoint to view Multivariate, RSS, and A/B Testing Campaign reports. paths: - /reports/{campaign_id}/sub-reports unsub-reports: title: Unsubscribes description: Get information about list members who unsubscribed from a specific campaign. paths: - /reports/{campaign_id}/unsubscribed - /reports/{campaign_id}/unsubscribed/{subscriber_hash} templates: title: Templates description: 'Manage your Mailchimp templates. A template is an HTML file used to create the layout and basic design for a campaign. ' paths: - /templates - /templates/{template_id} subResources: - template-default-content template-default-content: title: Default Content description: Manage the default content for a Mailchimp template. paths: - /templates/{template_id}/default-content template-folders: title: Template Folders description: Organize your templates using folders. paths: - /template-folders - /template-folders/{folder_id} campaign-folders: title: Campaign Folders description: Organize your campaigns using folders. paths: - /campaign-folders - /campaign-folders/{folder_id} ecommerce-stores: title: E-commerce Stores description: Connect your E-commerce Store to Mailchimp to take advantage of powerful reporting and personalization features and to learn more about your customers. paths: - /ecommerce/stores - /ecommerce/stores/{store_id} subResources: - ecommerce-customers - ecommerce-orders - ecommerce-products - ecommerce-carts - ecommerce-promo-rules ecommerce-customers: title: Customers description: Add Customers to your Store to track their orders and to view E-Commerce Data for your Mailchimp lists and campaigns. Each Customer is connected to a Mailchimp list member, so adding a Customer can also add or update a list member. paths: - /ecommerce/stores/{store_id}/customers - /ecommerce/stores/{store_id}/customers/{customer_id} ecommerce-promo-rules: title: Promo Rules description: Promo Rules help you create promo codes for your campaigns. Promo Rules define generic information about promo codes like expiration time, start time, amount of discount being offered etc. For a given promo rule you can define if it's a percentage discount or a fixed amount and if it applies for the order as a whole or if it's per item or free shipping. You can then create promo codes for this price rule. Promo codes contain the actual code that is applied at checkout along with some other information. Price Rules have one to many relationship with promo codes. paths: - /ecommerce/stores/{store_id}/promo-rules - /ecommerce/stores/{store_id}/promo-rules/{promo_rule_id} subResources: - ecommerce-promo-codes ecommerce-promo-codes: title: Promo Codes description: Promo codes can be created for a given price rule. All the promo codes under a price rule share the generic information defined for that rule like the amount, type, expiration date etc. Promo code defines the more specific information about a promo code like the actual code, redemption_url, usage_count, etc that's unique to a code. Promo Code must be defined under a promo rule. paths: - /ecommerce/stores/{store_id}/promo-rules/{promo_rule_id}/promo-codes - /ecommerce/stores/{store_id}/promo-rules/{promo_rule_id}/promo-codes/{promo_code_id} ecommerce-orders: title: Orders description: Orders represent successful e-commerce transactions, and this data can be used to provide more detailed campaign reports, track sales, and personalize emails to your targeted consumers, and view other e-commerce data in your Mailchimp account. paths: - /ecommerce/orders - /ecommerce/stores/{store_id}/orders - /ecommerce/stores/{store_id}/orders/{order_id} subResources: - ecommerce-order-lines ecommerce-order-lines: title: Order Lines description: Each Order contains one or more Order Lines, which represent a specific Product Variant that a Customer purchases. paths: - /ecommerce/stores/{store_id}/orders/{order_id}/lines - /ecommerce/stores/{store_id}/orders/{order_id}/lines/{line_id} ecommerce-products: title: Products description: E-commerce items for sale in your store need to be created as Products so you can add the items to a Cart or an Order. Each Product requires at least one Product Variant. paths: - /ecommerce/stores/{store_id}/products - /ecommerce/stores/{store_id}/products/{product_id} subResources: - ecommerce-product-variants - ecommerce-product-images ecommerce-product-variants: title: Product Variants description: A Product Variant represents a specific item for purchase, and is contained within a parent Product. At least one Product Variant is required for each Product. paths: - /ecommerce/stores/{store_id}/products/{product_id}/variants - /ecommerce/stores/{store_id}/products/{product_id}/variants/{variant_id} ecommerce-product-images: title: Product Images description: A Product Image represents a specific product image. paths: - /ecommerce/stores/{store_id}/products/{product_id}/images - /ecommerce/stores/{store_id}/products/{product_id}/images/{image_id} ecommerce-carts: title: Carts description: Use Carts to represent unfinished e-commerce transactions. This can be used to create an Abandoned Cart workflow, or to save a consumers shopping cart pending a successful Order. paths: - /ecommerce/stores/{store_id}/carts - /ecommerce/stores/{store_id}/carts/{cart_id} subResources: - ecommerce-cart-lines ecommerce-cart-lines: title: Cart Lines description: Each Cart contains one or more Cart Lines, which represent a specific Product Variant that a Customer has added to their shopping cart. paths: - /ecommerce/stores/{store_id}/carts/{cart_id}/lines - /ecommerce/stores/{store_id}/carts/{cart_id}/lines/{line_id} facebook-ads: title: Facebook Ads description: Get information about Facebook Ads. paths: - /facebook-ads - /facebook-ads/{outreach_id} ping: title: Ping description: A health check endpoint for Mailchimp API 3.0. paths: - /ping reporting: title: Reporting description: Reporting for various campaign types. paths: [] subResources: - reporting-facebook-ads - reporting-google-ads - reporting-landing-pages - reporting-postcards - reporting-social-posts - reporting-surveys - reporting-websites reporting-facebook-ads: title: Facebook Ads description: 'Get information about Facebook Ad reports. ' paths: - /reporting/facebook-ads - /reporting/facebook-ads/{outreach_id} - /reporting/facebook-ads/{outreach_id}/ecommerce-product-activity reporting-landing-pages: title: Landing Pages description: Get information about Landing Page reports. paths: - /reporting/landing-pages - /reporting/landing-pages/{outreach_id} reporting-surveys: title: Surveys description: Get an overall report for a [hosted survey](https://mailchimp.com/help/create-a-survey/). paths: - /reporting/surveys - /reporting/surveys/{survey_id} subResources: - reporting-surveys-questions - reporting-surveys-responses reporting-surveys-questions: title: Survey Questions description: Get reports by question on a [hosted survey](https://mailchimp.com/help/create-a-survey/). paths: - /reporting/surveys/{survey_id}/questions - /reporting/surveys/{survey_id}/questions/{question_id} subResources: - reporting-surveys-questions-answers reporting-surveys-questions-answers: title: Survey Question Answers description: Answers to specific questions on a [hosted survey](https://mailchimp.com/help/create-a-survey/). paths: - /reporting/surveys/{survey_id}/questions/{question_id}/answers reporting-surveys-responses: title: Survey Responses description: Get survey response reports for a [hosted survey](https://mailchimp.com/help/create-a-survey/). paths: - /reporting/surveys/{survey_id}/responses - /reporting/surveys/{survey_id}/responses/{response_id} search-campaigns: title: Search Campaigns description: Search all of an account's campaigns for the specified query terms. paths: - /search-campaigns search-members: title: Search Members description: Search the account or a specific list for members that match the specified query terms. paths: - /search-members verified-domains: x-hidden: false title: Verified Domains description: Manage the domains on your account that can be used for sending email campaigns. paths: - /verified-domains - /verified-domains/{domain_name} - /verified-domains/{domain_name}/actions/verify subresources: []