MAmailchimp
reports

List campaign open details

Get detailed information about any campaign emails that were opened by a list member.

get/3.0/reports/{campaign_id}/open-details

Request

Path parameters

campaign_idstring required

The unique id for the campaign.

Query parameters

fieldsstring[]

A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.

exclude_fieldsstring[]

A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.

countinteger

The number of records to return. Default value is 10. Maximum value is 1000

offsetinteger

Used for pagination, this is the number of records from a collection to skip. Default value is 0.

sincestring

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_field'opens_count'

Returns open reports sorted by the specified field.

sort_dir'ASC' | 'DESC'

Determines the order direction for sorted results.

filter_botsboolean

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

campaign_idstring

The campaign id.

total_itemsinteger

The total number of items matching the query regardless of pagination.

total_opensinteger

The total number of opens matching the query regardless of pagination.

total_proxy_excluded_opensinteger

The total number of opens excluding opens from email clients that use proxies regardless of pagination.

Changes

No recorded changes to this operation across all 1 revision of this API.