Skip to navigation

Get clicked link subscriber

Get information about a specific subscriber who clicked a link in a specific 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.

Response

This endpoint returns an object.
campaign_idstringOptionalRead-only
The campaign id.
clicksintegerOptionalRead-only
The total number of times the subscriber clicked on the link.
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 list id.
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.

url_idstringOptionalRead-only
The id for the tracked URL in the campaign.
vipbooleanOptionalRead-only

VIP status for subscriber.