Skip to navigation
API ReferenceReports

Get opened campaign subscriber

Get information about a specific subscriber who opened a 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.
subscriber_hashstringRequired
The MD5 hash of the lowercase version of the list member's email address.

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.

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.
campaign_idstringOptionalRead-only
The unique id for the campaign.
contact_statusstringOptionalRead-only

The status of the member, namely if they are subscribed, unsubscribed, deleted, non-subscribed, transactional, pending, or need reconfirmation.

email_addressstringOptionalRead-only
Email address for a subscriber.
email_idstringOptionalRead-only
The MD5 hash of the lowercase version of the list member's email address.
list_idstringOptionalRead-only
The unique id for the list.
list_is_activebooleanOptionalRead-only
The status of the list used, namely if it's deleted or disabled.
merge_fieldsmap from strings to objects or strings or doubles or nullOptional

A dictionary of merge fields where the keys are the merge tags. See the Merge Fields documentation for more about the structure.

openslist of objectsOptional
An array of timestamps for each time a list member opened the campaign. If a list member opens an email multiple times, this will return a separate timestamp for each open event.
opens_countintegerOptionalRead-only
The total number of times the this campaign was opened by the list member.
proxy_excluded_opens_countintegerOptionalRead-only
The total number of times the this campaign was opened by the list member excluding opens from email clients that use proxies .
vipbooleanOptionalRead-only

VIP status for subscriber.