Clicks-by-link Activity Report

Use this API to retrieve a list of contacts who clicked on links in a SENT email campaign.

Methods:

Click a method to view its documentation

GET

DescriptionTOP

Privileges required: contacts:read

Retrieves a list of all contacts that clicked the email campaign link specified by the linkId and campaignId path parameters (REQUIRED). Use the created_since query parameter to retrieve only the contacts who clicked links 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/clicks/{linkId}

Test API

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 email campaign link clicks 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.

linkId

path

Specifies the link in the email campaign to retrieve click data for - linkId is the same as the url_id in the email campaign object

Response CodesTOP

code

description

200

Request was successful

401

Authentication failure

404

campaign 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_CLICK for this report

campaign_id

string

Unique ID of the email campaign in which the activity occurred

click_date

string

Date and time that click occurred, displayed in ISO 8601 format, YYYY-MM-DDThh:mm:ssTZD

contact_id

string

Unique ID of the Contact who clicked on the link

email_address

string

Email address the campaign was sent to

link_id

string

Unique ID for the link in the email campaign - - link_id is the same as the url_id in the email campaign object

Example ResponseTOP

{
    "meta": {
      "pagination": {
		"next_link": "/v2/emailmarketing/campaigns/1100394165287/tracking/clicks?next=c3RhcnRBdD0zJmxpbWl0PTI"
		        }
    },
    "results": [
        {
            "activity_type": "EMAIL_CLICK",
            "campaign_id": "1100394165287",
            "contact_id": "36",
            "email_address": "abc@example.com",
            "link_id": "1",
            "click_date": "2012-12-06T13:06:25.732Z"
        },
        {
            "activity_type": "EMAIL_CLICK",
            "campaign_id": "1100394165287",
            "contact_id": "35",
            "email_address": "def@example.com",
            "link_id": "1",
            "click_date": "2012-12-06T13:06:25.633Z"
        }
    ]
}