Email Reporting

GET an Email Links Report

Changed on

Use this method to return link details, including the number of unique contacts that clicked each link in an email campaign activity, and the type of action associated with clicking each link. To include link details for links that were not clicked, set the no_clicks query parameter to true.

You can return reporting data for primary_email and resend role email campaign activities. For more use case information, see Get an Email Links Report in the API guide.

get/reports/email_reports/{campaign_activity_id}/links

Request

  • Base URL
    https://api.cc.email/v3
  • URL
    https://api.cc.email/v3/reports/email_reports/{campaign_activity_id}/links
  • Auth
    • OAuth 2
      Implicit: https://authz.constantcontact.com/oauth2/default/v1/authorize
      Scopes: campaign_data
    • or OAuth 2
      Authorization code: https://authz.constantcontact.com/oauth2/default/v1/authorize
      Token URL: https://authz.constantcontact.com/oauth2/default/v1/token scopes: campaign_data

Path parameters

campaign_activity_idstring uuid required

The unique ID for an email campaign activity.

Query parameters

no_clicksboolean

Set this query parameter to true to return details for links that were not clicked in the response results.

Response

Request was successful

campaign_activity_idstring uuid

The unique ID for an email campaign activity.

Example response

{
  "campaign_activity_id": "8892baf9-970a-4de6-8400-fa4ec461987c",
  "link_click_counts": [
    {
      "link_url": "https://www.constantcontact.com/",
      "url_id": "1100577727321",
      "unique_clicks": 99,
      "list_action": "add",
      "list_id": "3377aefd-970a-4de6-8400-ab4ec491624c",
      "link_tag": "google-link-1"
    }
  ]
}

Changes