Contact Tracking Opens Report
Use this endpoint to retrieve a report of all email campaigns that a contact opened.
Methods:
Click a method to view its documentation
DescriptionTOP
Privileges required: contacts:read
Retrieves a report showing email campaigns that a contact opened. Use the contactId path parameter to specify the contact for which to retrieve the report. Use the created_since query parameter to retrieve only activity that occurred on or after the date/time specified. This is useful for syncing tracking data across applications.
DescriptionTOP
Privileges required: contacts:read
Retrieves the email campaign forwarding activites for the contact specified by the contactId path parameter (REQUIRED). Use the created_since query parameter to retrieve only activity that occurred on or after the date/time specified. This is useful for syncing tracking data across applications.
DescriptionTOP
Privileges required: contacts:read
Retrieves a list of email addresses that opened the email campaign specified by campaignId path parameter (REQUIRED). Use the created_since query parameter to retrieve only those opens that occurred on or after the date/time specified. This is useful for sync'ing tracking data across applications.
NOTE: Tracking information is only available for SENT email campaigns.
|
GET: https://api.constantcontact.com/v2/contacts/{contactId}/tracking/opens |
|||
name |
type |
default |
description |
|---|---|---|---|
api_key |
query |
REQUIRED; The API key for the application |
|
contactId |
path |
Specifies the contact to retrieve open events for |
|
created_since |
query |
Use to retrieve only opens 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 |
Response CodesTOP
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 |
StructureTOP
|
property |
type(max length) |
description |
|---|
Example ResponseTOP
{
"meta": {
"pagination": {
"next_link": "/v2/contacts/39/tracking/opens?next=c3RhcnRBdD0zJmxpbWl0PTI"
}
},
"results": [
{
"activity_type": "EMAIL_OPEN",
"campaign_id": "1100394165287",
"contact_id": "39",
"email_address": "xyz@example.com",
"open_date": "2012-12-06T08:06:30.641Z"
},
{
"activity_type": "EMAIL_OPEN",
"campaign_id": "1100394165288",
"contact_id": "39",
"email_address": "xyz@example.com",
"open_date": "2012-12-06T08:06:30.531Z"
}
]
}