Overview of email reporting

The email reporting methods allow you to track how contacts interact with your email campaigns and understand the performance of your email campaigns.

Email reporting methods use an email campaign activity ID value to return reporting data for a specific email. You can get reporting data for primary_email and resend role email campaign activities. You cannot get reporting data on permalink role email campaign activities.

All email reporting methods require the campaign_data authorization scope and the ui:campaign:metrics user privilege. For more information on requesting the campaign_data scope, see the Authorization Scopes Overview.

GET an Email Links Report

GET https://api.cc.email/v3/reports/email_reports/{campaign_activity_id}/links

Use this method to get a report on the links in an email campaign activity. This report includes the number of unique contacts that clicked each link and the type of action associated with clicking each link.

Learn more about getting an email links report.

GET an Email Sends Report

GET https://api.cc.email/v3/reports/email_reports/{campaign_activity_id}/tracking/sends

Use this method to get a report listing the contacts to which a specified email campaign activity was sent. Report data includes contact information, such as the contact’s email address, unique contact ID, and the date and time that you sent the email campaign activity.

Learn more about getting an email sends report.

GET an Email Opens Report

GET https://api.cc.email/v3/reports/email_reports/{campaign_activity_id}/tracking/opens

Use this method to get a report listing each time contacts opened the specified email campaign activity. This report includes contact information, such as the contact’s email address and unique ID, the date and time they opened the email campaign activity, and the type of device they used to open it.

Learn more about getting an email opens report.

GET an Email Clicks Report

GET https://api.cc.email/v3/reports/email_reports/{campaign_activity_id}/tracking/clicks

Use this method to get a report listing each time contacts clicked one or more links for the specified email campaign activity. This report includes contact information, such as the contact’s email address and unique ID, the date and time they clicked a link, the type of device they used to click the link, and the links unique id.

Learn more about getting an email opens report.

Email Reporting Example Schema