Use this endpoint to retrieve a detailed report of all activities for all campaigns sent to a contact.
Click a method to view its documentation
Privileges required: contacts:read
Retrieves a report of a contact's (specified by the contactId
path parameter) activities for all email campaigns that have been sent to them. Activities are listed in order of the newest to the oldest.
GET: https://api.constantcontact.com/v2/contacts/{contactId}/tracking |
|||
name |
type |
default |
description |
---|---|---|---|
api_key |
query |
REQUIRED; The API key for the application |
|
contactId |
path |
Specifies the contact to retrieve all activities for |
|
created_since |
query |
Use to retrieve only activities that occurred on or after the date/time specified in ISO-8601 format. |
|
limit |
query |
500 |
Specifies the number of results displayed per page of output, from 1 - 500, default = 500. See Paginated Output for more information on using |
code |
description |
---|---|
200 |
Request was successful |
401 |
Authentication failure |
404 |
contact id not found |
406 |
Unsupported accept header value, must be application/json |
500 |
Internal server error occurred |
property |
type(max length) |
description |
---|---|---|
activity_type |
string |
The Email campaign activity type, valid values are:
|
bounce_code |
string |
Code identifying reason for bounce, valid codes are: |
bounce_date |
string |
Date the bounce occurred displayed in |
bounce_description |
string |
Description of
|
bounce_message |
string |
System message received for the email bounce |
bounces |
integer |
Number of email bounces that occurred for this contact |
campaign_id |
string |
Unique ID of the email campaign for which the activities occurred |
click_date |
string |
Date the contact clicked the link in the email campaign, displayed in ISO 8601 format in Zulu time zone. |
clicks |
integer |
Number of unique link clicks the contact made in the email campaign |
contact_id |
string |
Specifies the contact that performed the activity |
email_address |
string |
Email address of the contact the activity applies to |
forward_date |
string |
Date the contact forwarded the email campaign, displayed in ISO 8601 format in Zulu time zone. |
forwards |
integer |
Number of times the contact forwarded the email campaign |
link_id |
string |
Unique ID for the link in the email campaign |
link_uri |
string |
URI of the link the contact clicked on |
open_date |
string |
Date the email campaign was opened, displayed in ISO 8601 format in Zulu time zone. |
opens |
integer |
Number of times the contact opened the email campaign |
send_date |
string |
Date the email campaign was sent, displayed in ISO 8601 format in Zulu time zone. |
unsubscribe_date |
string |
Date the contact unsubscribed from the mailist, displayed in ISO 8601 format |
unsubscribe_reason |
string |
Reason given by the contact for unsubscribing |
unsubscribe_source |
string |
If value is:
|
{ "meta": { "pagination": { "next_link": "/v2/contacts/1/tracking?next=c3RhcnRBdD0zJmxpbWl0PTI" } }, "results": [ { "activity_type": "EMAIL_UNSUBSCRIBE", "campaign_id": "1100394165287", "contact_id": "1", "email_address": "xyz@example.com", "unsubscribe_date": "2013-03-15T14:55:17.103Z", "unsubscribe_source": "ACTION_BY_CONTACT", "unsubscribe_reason": "No longer use this product and service" }, { "activity_type": "EMAIL_FORWARD", "campaign_id": "1100394165287", "contact_id": "1", "email_address": "xyz@example.com", "forward_date": "2013-02-08T10:32:20.554Z" }, { "activity_type": "EMAIL_CLICK", "campaign_id": "1100394165287", "contact_id": "1", "email_address": "xyz@example.com", "link_id": "1100394165682", "link_uri": "http://www.example.com", "click_date": "2013-02-06T09:32:30.236Z" }, { "activity_type": "EMAIL_OPEN", "campaign_id": "1100394165287", "contact_id": "1", "email_address": "xyz@example.com", "open_date": "2013-02-06T08:06:30.641Z" }, { "activity_type": "EMAIL_SEND", "campaign_id": "1100394165287", "contact_id": "1", "send_date": "2013-02-06T18:31:00.000Z" }, { "activity_type": "EMAIL_BOUNCE", "campaign_id": "1100394165290", "contact_id": "1", "email_address": "abc@example.com", "bounce_code": "B", "bounce_description": "Non-existent address", "bounce_message": "", "bounce_date": "2012-12-06T18:06:39.990Z" }, { "activity_type": "EMAIL_SEND", "campaign_id": "1100394165290", "contact_id": "1", "send_date": "2012-12-06T13:31:00.000Z" } ] }