Get an email campaigns summary report listing unique contact tracking activity counts.

Note: This method is only for use with primary_email and resend role email campaign activities.

Make a GET call to the /reports/summary_reports/email_campaign_summaries endpoint to get a summary report listing the unique contact tracking activity counts for up to 500 email campaigns.

The response results are listed in descending order by the date that the campaign was last sent (last_sent_date). The results include the total number of times that each contact uniquely interacted with an email campaign. For example, the following shows unique_counts for tracked activities associated with Newsletter campaigns:

 {
     "bulk_email_campaign_summaries": [
         {
             "campaign_id": "4399ce90-5b89-13e7-ba80-00163e498a99",
             "campaign_type": "Newsletter",
             "last_sent_date": "2020-09-17T06:18:39.000Z",
             "unique_counts": {
                 "sends": 15,
                 "opens": 6,
                 "clicks": 2,
                 "forwards": 1,
                 "optouts": 1,
                 "abuse": 0,
                 "bounces": 6,
                 "not_opened": 3
             }
         }
     ],
     "_links": {
             "next": {
                 "href": "/v3/reports/summary_reports/email_campaign_summaries?next=Y2FtcGFpZ25fdHlwZXM9MTQsMTUsMTIsNDMsMiwxLDI2LDIxLDE5LDE3LDMwLDExLDIzLDEwLDQ0LDE2LDIyLDE4LDI0LDI1LDIwLDU3JmxpbWl0PTEmbz0x"
             }
 
 }

The unique_counts show that this email campaign was sent to 15 different contacts of which 6 opened it, 3 didn’t open it, 2 clicked on a campaign link, 1 forwarded it to different email address, and 1 clicked the optout link in the email footer. No contacts (0) reported the bulk email campaign as abuse (spam).

Parameters

To limit the number of resulting email campaign summaries to return on each page of results, use the limit query parameter. The default limit is 50 and the maximum is 500 email campaign summaries per page.

Example GET Email Campaigns Summary Report Requests

GET https://api.cc.email/v3/reports/summary_reports/email_campaign_summaries?limit=1

Endpoint Requirements

User privileges: ui:campaign:metrics

Authorization scopes: campaign_data

<?php

$request = new HttpRequest();
$request->setUrl('https://api.cc.email/v3/reports/summary_reports/email_campaign_summaries');
$request->setMethod(HTTP_METH_GET);

$request->setQueryData(array(
  'limit' => '1'
));

$request->setHeaders(array(
  'Authorization' => 'Bearer {access_token}',
  'Accept' => '*/*',
  'Content-Type' => 'application/json'
));

try {
  $response = $request->send();

  echo $response->getBody();
} catch (HttpException $ex) {
  echo $ex;
}
OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://api.cc.email/v3/reports/summary_reports/email_campaign_summaries?limit=1")
  .get()
  .addHeader("Content-Type", "application/json")
  .addHeader("Accept", "*/*")
  .addHeader("Authorization", "Bearer {access_token}")
  .build();
  
Response response = client.newCall(request).execute();
curl -X GET \
  'https://api.cc.email/v3/reports/summary_reports/email_campaign_summaries?limit=1' \
  -H 'Accept: */*' \
  -H 'Authorization: Bearer {access_token}' \
  -H 'Content-Type: application/json' \

Response

{
    "bulk_email_campaign_summaries": [
        {
            "campaign_id": "4399ce90-5b89-11e7-ba80-00163e498a99",
            "campaign_type": "Newsletter",
            "last_sent_date": "2020-09-17T06:18:39.000Z",
            "unique_counts": {
                "sends": 15,
                "opens": 6,
                "clicks": 2,
                "forwards": 1,
                "optouts": 1,
                "abuse": 0,
                "bounces": 6,
                "not_opened": 3
            }
        }
    ],
    "_links": {
            "next": {
                "href": "/v3/reports/summary_reports/email_campaign_summaries?next=Y2FtcGFpZ25fdHlwZXM9MTQsMTUsMTIsNDMsMiwxLDI2LDIxLDE5LDE3LDMwLDExLDIzLDEwLDQ0LDE2LDIyLDE4LDI0LDI1LDIwLDU3JmxpbWl0PTEmbz0x"
            }

}


Try it!