reports

Get opened campaign subscriber

Get information about a specific subscriber who opened a campaign.

get/3.0/reports/{campaign_id}/open-details/{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.

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 unique id for the campaign.

contact_statusstring

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

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.

merge_fieldsobject nullable

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

opens_countinteger

The total number of times the this campaign was opened by the list member.

proxy_excluded_opens_countinteger

The total number of times the this campaign was opened by the list member excluding opens from email clients that use proxies .

vipboolean

VIP status for subscriber.

Changes

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