Contact Link Clicks Report

Use this endpoint to retrieve a report of all links a contact clicked for all campaigns sent to them.

Methods:

Click a method to view its documentation

GET

DescriptionTOP

Privileges required: contacts:read

Retrieves a list of all email campaign click activities for the contacts 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.

GET: https://api.constantcontact.com/v2/contacts/{contactsId}/tracking/clicks

Test API

name

type

default

description

api_key

query

REQUIRED; The API key for the application

contactId

path

Specifies the contact to retrieve click activities for

created_since

query

Use to retrieve only 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.

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_CLICK

campaign_id

string

Unique ID of the email campaign where the link is located

click_date

string

Date the contact clicked on the link

contact_id

string

Unique ID of the contact that clicked on the link

email_address

string

Email address the campaign was sent to

link_id

string

Unique ID of the link in the Campaign; referred to as url_uid in the email campaign structure.

link_uri

string

URI of the link the contact clicked on

Example ResponseTOP

{
    "meta": {
       	 "pagination": {
			      "next_link": "/v2/contacts/36/tracking/clicks?next=c3RhcnRBdD0zJmxpbWl0PTI"
			        }
    },
    "results": [
      {
           "activity_type": "EMAIL_CLICK",
           "campaign_id": "1100394165287",
           "contact_id": "36",
           "email_address": "bcd@example.com",
           "link_id": "1100394163874",
           "link_uri": "http://www.constantcontact.com",
           "click_date": "2012-12-06T08:06:25.732Z"
       }
    ]
}