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

GET

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.

GET: https://api.constantcontact.com/v2/contacts/{contactId}/tracking/opens

Test API

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 limit.

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

activity_type

string

Campaign activity type, always EMAIL_OPEN for this report

campaign_id

string

Unique ID of the email campaign the contact opened

contact_id

string

Unique ID of the contact who opened the email campaign

email_address

string

Email address the campaign was sent to

open_date

string

Date the email campaign was opened, displayed in ISO 8601 format, YYYY-MM-DDThh:mm:ssTZ

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"
      }
    ]
}