reports

Get subscriber email activity

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

get/3.0/reports/{campaign_id}/email-activity/{subscriber_hash}

Request

Path parameters

campaign_idstring required

The unique id for the campaign.

subscriber_hashstring required

The MD5 hash of the lowercase version of the list member's email address.

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.

sincestring

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_botsboolean

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

campaign_idstring

The unique id for the campaign.

email_addressstring

Email address for a subscriber.

email_idstring

The MD5 hash of the lowercase version of the list member's email address.

list_idstring

The unique id for the list.

list_is_activeboolean

The status of the list used, namely if it's deleted or disabled.

Changes

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