swagger: '2.0'
info:
version: 3.0.55
title: Mailchimp Marketing Abuse Locations 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: Locations
paths:
/lists/{list_id}/locations:
get:
summary: Mailchimp List Locations
description: Get the locations (countries) that the list's subscribers have been tagged to based on geocoding their IP address.
operationId: getListsIdLocations
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: list_id
x-title: List ID
in: path
description: The unique ID for the list.
required: true
type: string
example: '500123'
responses:
'200':
description: ''
schema:
type: object
title: List Locations
description: A summary of List's locations.
properties:
locations:
type: array
items:
type: object
title: List Location
properties:
country:
type: string
title: Country Name
description: The name of the country.
readOnly: true
cc:
type: string
title: cc
description: The ISO 3166 2 digit country code.
readOnly: true
percent:
type: number
title: percent
description: The percent of subscribers in the country.
readOnly: true
total:
type: integer
title: total
description: The total number of subscribers in the country.
readOnly: true
title: Locations
description: An array of objects, each representing a list's top subscriber locations.
list_id:
type: string
title: List ID
description: The unique id for the list.
total_items:
type: integer
title: Item Count
description: The total number of items matching the query regardless of pagination.
readOnly: true
_links:
title: Links
description: A list of link types and descriptions for the API schema documents.
type: array
items:
type: object
title: Resource Link
description: This object represents a link from the resource where it is found to another resource or action that may be performed.
properties:
rel:
type: string
title: Rel
description: As with an HTML 'rel' attribute, this describes the type of link.
readOnly: true
href:
type: string
title: Href
description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action.
readOnly: true
method:
type: string
title: Method
description: The HTTP method that should be used when accessing the URL defined in 'href'.
enum:
- GET
- POST
- PUT
- PATCH
- DELETE
- OPTIONS
- HEAD
readOnly: true
targetSchema:
type: string
title: Target Schema
description: For GETs, this is a URL representing the schema that the response should conform to.
readOnly: true
schema:
type: string
title: Schema
description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to.
readOnly: true
readOnly: true
default:
description: An error generated by the Mailchimp API.
schema:
type: object
title: Problem Detail Document
description: An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'.
required:
- type
- title
- status
- detail
- instance
properties:
type:
type: string
title: Problem Type
description: An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type.
example: https://mailchimp.com/developer/marketing/docs/errors/
title:
type: string
title: Error Title
description: A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization.
example: Resource Not Found
status:
type: integer
title: HTTP Status Code
description: The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem.
example: 404
detail:
type: string
title: Error Message
description: A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors).
example: The requested resource could not be found.
instance:
type: string
title: Instance ID
description: A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support.
example: 995c5cb0-3280-4a6e-808b-3b096d0bb219
deprecated: false
tags:
- Locations
x-custom-config:
methodNameSnake: get_list_locations
methodNameCamel: getListLocations
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:
- Locations
x-custom-config:
methodNameSnake: get_locations_for_campaign
methodNameCamel: getLocationsForCampaign
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
# --- truncated at 32 KB (41 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/mailchimp/refs/heads/main/openapi/mailchimp-locations-api-openapi.yml