Skip to navigation
API ReferenceReports

List campaign reports

Get campaign reports.

Authentication

AuthorizationBearer

Authorization using a Mailchimp API key (a.k.a. Bearer token)

OR
AuthorizationBearer
Authorization using OAuth

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.

typeenumOptional
The campaign type.
Allowed values:
before_send_timedatetimeOptional

Restrict the response to campaigns sent before the set time. Uses ISO 8601 time format: 2015-10-21T15:41:36+00:00.

since_send_timedatetimeOptional

Restrict the response to campaigns sent after the set time. Uses ISO 8601 time format: 2015-10-21T15:41:36+00:00.

Response

This endpoint returns an object.
reportslist of objectsOptional
An array of objects, each representing a report resource.
total_itemsintegerOptionalRead-only
The total number of items matching the query regardless of pagination.