Use this API retrieve a list of email addresses that opened a sent email campaign.
Click a method to view its documentation
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/emailmarketing/campaigns/{campaignId}/tracking/opens |
|||
name |
type |
default |
description |
---|---|---|---|
api_key |
query |
REQUIRED; The API key for the application |
|
campaignId |
path |
Specifies the email campaign to retrieve tracking data for |
|
created_since |
query |
Use to retrieve only contacts who opened the email campaign 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 |
Campaign ID not found. |
406 |
Unsupported accept header value, must be applicaton/json |
500 |
Internal server error occurred |
property |
type(max length) |
description |
---|---|---|
activity_type |
string |
Campaign activity type, always EMAIL_OPEN |
campaign_id |
string |
Unique ID of the email campaign |
contact_id |
string |
Unique ID of the Contact that opened the email |
email_address |
string |
Email address the email campaign was sent to |
open_date |
string |
Date & time message was opened |
{ "meta": { "pagination": { "next_link": "/v2/emailmarketing/campaigns/1100394165287/tracking/opens?next=c3RhcnRBdD0zJmxpbWl0PTI" } }, "results": [ { "activity_type": "EMAIL_OPEN", "campaign_id": "1100394165287", "contact_id": "51", "email_address": "abc@example.com", "open_date": "2012-12-06T13:06:35.661Z" }, { "activity_type": "EMAIL_OPEN", "campaign_id": "1100394165287", "contact_id": "50", "email_address": "def@example.com", "open_date": "2012-12-06T13:06:35.561Z" } ] }