Skip to navigation
API ReferenceReports

List top open activities

Get top open locations for a specific campaign.

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.

Response

This endpoint returns an object.
campaign_idstringOptionalRead-only
The campaign id.
locationslist of objectsOptional
An array of objects, each representing a top location for opens.
total_itemsintegerOptionalRead-only
The total number of items matching the query regardless of pagination.