For AI agents: a documentation index is available at the root level at /llms.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Get detailed information about any campaign emails that were opened by a list member.
Authentication
AuthorizationBearer
Authorization using a Mailchimp API key (a.k.a. Bearer token)
OR
AuthorizationBearer
Authorization using OAuth
Path parameters
campaign_idstringRequired
The unique id for the campaign.
Query parameters
fieldslist of stringsOptional
A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
exclude_fieldslist of stringsOptional
A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.
countintegerOptional<=1000Defaults to 10
The number of records to return. Default value is 10. Maximum value is 1000
offsetintegerOptionalDefaults to 0
Used for pagination, this is the number of records from a collection to skip. Default value is 0.
sincestringOptional
Restrict results to campaign open events that occur after a specific time. Uses ISO 8601 time format: 2015-10-21T15:41:36+00:00.
sort_fieldenumOptional
Returns open reports sorted by the specified field.
Allowed values:
sort_direnumOptional
Determines the order direction for sorted results.
Allowed values:
filter_botsbooleanOptionalDefaults to false
When true, exclude automated (proxy/bot) opens so the returned open counts reflect human opens only, matching the in-app Recipient Activity view. A member whose opens are all automated is excluded from the human-only view. Defaults to false (all opens).
Response
This endpoint returns an object.
_linkslist of objectsOptionalRead-only
A list of link types and descriptions for the API schema documents.
campaign_idstringOptionalRead-only
The campaign id.
memberslist of objectsOptional
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.
total_itemsintegerOptionalRead-only
The total number of items matching the query regardless of pagination.
total_opensintegerOptional
The total number of opens matching the query regardless of pagination.
total_proxy_excluded_opensintegerOptional
The total number of opens excluding opens from email clients that use proxies regardless of pagination.
