Clicks-by-Link Report | Constant Contact Developer

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

DescriptionTOP

Privileges required: campaign:read

Returns a summary of all activities (Sends, Opens, Clicks, Forwards, Unsubscribes, Bounces) for the email campaign specified by the campaignId path parameter. All data returned is current as of the last scheduled update, unless you set updateSummary=true, which will return updated data.

NOTE: Tracking information is only available for SENT email campaigns.

DescriptionTOP

Privileges required: contacts:read

Retrieves a list of all link clicks for the campaign specified by the campaignId path parameter (REQUIRED). Use the created_since query parameter to retrieve only the clicks that occurred on or after the date/time specified. This is useful for syncing tracking data across applications.

NOTE: Tracking information is only available for SENT email campaigns.

DescriptionTOP

Privileges required: mylibrary:file:read

Get a list of all files in a Library folder specified by the folderId path parameter.

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.

DescriptionTOP

Privileges required: contacts:read

Retrieve a list of contacts that unsubscribed from an email campaign specified by the campaignId path parameter. Use the created_since query parameter to retrieve only the contacts that unsubscribed 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.

DescriptionTOP

Privileges required: contacts:read

Retrieve a list of contacts that the email campaign specified by the campaignId path parameter (REQUIRED). Use the created_since query parameter to retrieve only the email addresses that were sent the campaign 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.

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.

DescriptionTOP

Privileges required: contacts:read

Retrieves a list of contacts that forwarded the email campaign specified by the campaignId path parameter. Use the created_since query parameter to retrieve only the forward activities 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.

DescriptionTOP

Privileges required: contacts:read

Retrieves a list of all click activities for the email campaign specified by the campaignId path parameter (REQUIRED). Use the created_since query parameter to retrieve only the click activities 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.

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

name	type	default	description
GET: https://api.constantcontact.com/v2/emailmarketing/campaigns/{campaignId}/tracking/clicks/{linkId}
Test API
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

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