Skip to navigation
API ReferenceReportsEmail activity

Get subscriber email activity

Get a specific list member's activity in a campaign including opens, clicks, and bounces.

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.

sincestringOptional

Restrict results to email activity events that occur after a specific time. Uses ISO 8601 time format: 2015-10-21T15:41:36+00:00.

filter_botsbooleanOptionalDefaults to false

When true, exclude automated bot and Apple Mail Privacy Protection (MPP) proxy activity so the returned activity reflects human-only opens and clicks, matching the in-app Recipient Activity view. Filtering removes events from a member's activity, but never removes the member from the response. Defaults to false (all activity).

Response

This endpoint returns an object.
activitylist of objectsOptional
An array of objects, each showing an interaction with the email. Member activity limited to 1,000 open activities and 1,000 click activities per member per campaign.
campaign_idstringOptionalRead-only
The unique id for the campaign.
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.