GetSummaryReport

Returns an overview of all of the reports.

  • Open Counts
  • Click Counts
  • Enagagement Stats
  • Per day engagement statistics
  • Top 10 Email Clients
  • Top 5 Countries
  • Top 5 Links Clicked
URLs:

http://sandbox.emailonacid.com/analyticsV1/GetSummaryReport
https://api.emailonacid.com/analyticsV1/GetSummaryReport

Request:

<?xml version="1.0"?>
<get_summary_report>
  <guid>CAMPAIGN GUID</guid>
</get_summary_report>

Request Details:

Element Description Data Type Required Default
guid The unique identifier for the campaign you are attempting to update. Alpha-numeric String Y  

Response for Click Tracking Enabled Campaigns:

<?xml version="1.0"?>
<xml>
  <total_opens>TOTAL OPENS</total_opens>
  <unique_opens>UNIQUE OPENS</unique_opens>
  <reads>TOTAL READS</reads>
  <skims>TOTAL SKIMS</skims>
  <deletes>TOTAL GLANCES</deletes>
  <forwards>TOTAL FORWARDS</forwards>
  <prints>TOTAL PRINTS</prints>
  <stats_per_day>
    <clicks>
      <day>
        <date>MM-DD-YYYY</date>
        <amount>CLICK COUNT</amount>
      </day>
      <day>
        <date>MM-DD-YYYY</date>
        <amount>CLICK COUNT</amount>
      </day>
      ..........

    </clicks>
    <forwards>
      <day>
        <date>MM-DD-YYYY</date>
        <amount>FORWARD COUNT</amount>
      </day>
      <day>
        <date>MM-DD-YYYY</date>
        <amount>FORWARD COUNT</amount>
      </day>
      ..........

    </forwards>
    <opens>
      <day>
        <date>MM-DD-YYYY</date>
        <amount>TOTAL OPENS</amount>
      </day>
      <day>
        <date>MM-DD-YYYY</date>
        <amount>TOTAL OPENS</amount>
      </day>
      ..........

    </opens>
    <prints>
      <day>
        <date>MM-DD-YYYY</date>
        <amount>TOTAL PRINTS</amount>
      </day>
      <day>
        <date>MM-DD-YYYY</date>
        <amount>TOTAL PRINTS</amount>
      </day>
      ..........

    </prints>
    <unique_clicks>
      <day>
        <date>MM-DD-YYYY</date>
        <amount>UNIQUE CLICKS</amount>
      </day>
      <day>
        <date>MM-DD-YYYY</date>
        <amount>UNIQUE CLICKS</amount>
      </day>
      ..........

    </unique_clicks>
    <unique_opens>
      <day>
        <date>MM-DD-YYYY</date>
        <amount>UNIQUE OPENS</amount>
      </day>
      <day>
        <date>MM-DD-YYYY</date>
        <amount>UNIQUE OPENS</amount>
      </day>
      ..........

    </unique_opens>
  </stats_per_day>
  <opens_by_environemnt>
    <Desktop>OPENS IN DESKTOP CLIENTS</Desktop>
    <Web>OPENS IN WEB CLIENTS</Web>
    <Mobile>OPENS IN MOBILE CLIENTS</Mobile>
  </opens_by_environemnt>
  <top_10_clients>
    <client>
      <client_name>EMAIL CLIENT NAME</client_name>
      <unique_total>UNIQUE OPENS</unique_total>
      <open_total>TOTAL OPENS</open_total>
    </client>
    <client>
      <client_name>EMAIL CLIENT NAME</client_name>
      <unique_total>UNIQUE OPENS</unique_total>
      <open_total>TOTAL OPENS</open_total>
    </client>
    ..........

  </top_10_clients>
  <top_5_countries>
    <country>
      <country_code>COUNTRY CODE</country_code>
      <country_name>COUNTRY NAME</country_name>
      <unique_open>UNIQUE OPENS</unique_open>
      <total_open>TOTAL OPENS</total_open>
      <total_forward>TOTAL FORWARDS</total_forward>
      <total_print>TOTAL PRINTS</total_print>
      <total_delete>TOTAL GLANCES</total_delete>
      <total_skim>TOTAL SKIMS</total_skim>
      <total_read>TOTAL READS</total_read>
      <total_desktop>TOTAL DESKTOP CLIENT OPENS</total_desktop>
      <total_mobile>TOTAL MOBILE OPENS</total_mobile>
      <total_web_client>TOTAL WEBCLIENT OPENS</total_web_client>
    </country>
    ..........

  </top_5_countries>
  <total_clicks>TOTAL CLICKS</total_clicks>
  <unique_clicks>TOTAL UNIQUE CLICKS</unique_clicks>
  <top_5_links>
    <link>
      <url>LINK DESTINATION</url>
      <total_clicks>TOTAL CLICKS ON THIS LINK</total_clicks>
      <unique_clicks>UNIQUE CLICKS FOR THIS LINK</unique_clicks>
    </link>
    ..........

  </top_5_links>
</xml>

Response Details:

Element Description Data Type
total_opens Total amount of times the email was opened Integer
unique_opens Count of unique opens for the email. Integer
total_clicks Total of all link clicks during this campaign. Integer
unique_clicks Total of all unique link clicks during this campaign. Integer
reads How many times the email was read. Integer
skims How many times the email was skimmed. Integer
deletes How many times the email was glanced at. Integer
forwards How many times the email was forwarded. Integer
prints How many times the email was printed. Integer
stats_per_day Contains per day statistics.
clicks Per day click statistics.
day Statistics for a specific day.
date Date for the day. Format: MM-DD-YYYY Date Formatted String
amount Count for clicks on this day Integer
forwards Per day forward statistics.
day Statistics for a specific day.
date Date for the day. Format: MM-DD-YYYY Date Formatted String
amount Count for forwards on this day Integer
opens Per day open statistics.
day Statistics for a specific day.
date Date for the day. Format: MM-DD-YYYY Date Formatted String
amount Count for opens on this day Integer
prints Per day print statistics.
day Statistics for a specific day.
date Date for the day. Format: MM-DD-YYYY Date Formatted String
amount Count for prints on this day Integer
unique_clicks Per day unique click statistics.
day Statistics for a specific day.
date Date for the day. Format: MM-DD-YYYY Date Formatted String
amount Count for unique clicks on this day Integer
unique_opens Per day unique open statistics.
day Statistics for a specific day.
date Date for the day. Format: MM-DD-YYYY Date Formatted String
amount Count for unique opens on this day Integer
opens_by_environment Gives open count for each environment.
Desktop Count for opens in desktop email clients.
Web Count for opens in web email clients.
Mobile Count for opens in mobile devices.
top_10_clients Contains the top 10 email clients for the campaign.
client Client specific statistics.
client_name The name of the email client. String
unique_total Count of unique opens in the client. Integer
open_total Count of opens in the client. Integer
top_5_links Contains the top 5 links that were clicked on for the campaign.
link Link specific statistics.
url Url for the link destination. String
total_clicks Number of times this link was clicked. Integer
unique_clicks Number of unique clicks on this link. Integer
top_5_countries Contains the top r countries for the campaign.
country Link specific statistics.
country_code Abbreviated country code.
Example: US
String
country_name Name of the country String
total_open Open count in this country. Integer
total_forward Forward count in this country. Integer
total_print Print count in this country. Integer
total_delete Glance count in this country. Integer
total_skim Skim count in this country. Integer
total_read Read count in this country. Integer
total_desktop Open count for desktop email clients in this country. Integer
total_mobile Open count for mobile devices in this country. Integer
total_web_client Open count for web email clients in this country. Integer

Response for Click Tracking Disabled Campaigns:

<?xml version="1.0"?>
<xml>
  <total_opens>TOTAL OPENS</total_opens>
  <unique_opens>UNIQUE OPENS</unique_opens>
  <reads>TOTAL READS</reads>
  <skims>TOTAL SKIMS</skims>
  <deletes>TOTAL GLANCES</deletes>
  <forwards>TOTAL FORWARDS</forwards>
  <prints>TOTAL PRINTS</prints>
  <stats_per_day>
    <forwards>
      <day>
        <date>MM-DD-YYYY</date>
        <amount>FORWARD COUNT</amount>
      </day>
      <day>
        <date>MM-DD-YYYY</date>
        <amount>FORWARD COUNT</amount>
      </day>
      ..........

    </forwards>
    <opens>
      <day>
        <date>MM-DD-YYYY</date>
        <amount>TOTAL OPENS</amount>
      </day>
      <day>
        <date>MM-DD-YYYY</date>
        <amount>TOTAL OPENS</amount>
      </day>
      ..........

    </opens>
    <prints>
      <day>
        <date>MM-DD-YYYY</date>
        <amount>TOTAL PRINTS</amount>
      </day>
      <day>
        <date>MM-DD-YYYY</date>
        <amount>TOTAL PRINTS</amount>
      </day>
      ..........

    </prints>
    <unique_opens>
      <day>
        <date>MM-DD-YYYY</date>
        <amount>UNIQUE OPENS</amount>
      </day>
      <day>
        <date>MM-DD-YYYY</date>
        <amount>UNIQUE OPENS</amount>
      </day>
      ..........

    </unique_opens>
  </stats_per_day>
  <opens_by_environemnt>
    <Desktop>OPENS IN DESKTOP CLIENTS</Desktop>
    <Web>OPENS IN WEB CLIENTS</Web>
    <Mobile>OPENS IN MOBILE CLIENTS</Mobile>
  </opens_by_environemnt>
  <top_10_clients>
    <client>
      <client_name>EMAIL CLIENT NAME</client_name>
      <unique_total>UNIQUE OPENS</unique_total>
      <open_total>TOTAL OPENS</open_total>
    </client>
    <client>
      <client_name>EMAIL CLIENT NAME</client_name>
      <unique_total>UNIQUE OPENS</unique_total>
      <open_total>TOTAL OPENS</open_total>
    </client>
    ..........

  </top_10_clients>
  <top_5_countries>
    <country>
      <country_code>COUNTRY CODE</country_code>
      <country_name>COUNTRY NAME</country_name>
      <unique_open>UNIQUE OPENS</unique_open>
      <total_open>TOTAL OPENS</total_open>
      <total_forward>TOTAL FORWARDS</total_forward>
      <total_print>TOTAL PRINTS</total_print>
      <total_delete>TOTAL GLANCES</total_delete>
      <total_skim>TOTAL SKIMS</total_skim>
      <total_read>TOTAL READS</total_read>
      <total_desktop>TOTAL DESKTOP CLIENT OPENS</total_desktop>
      <total_mobile>TOTAL MOBILE OPENS</total_mobile>
      <total_web_client>TOTAL WEBCLIENT OPENS</total_web_client>
    </country>
    ..........

  </top_5_countries>
</xml>

Response Details:

Element Description Data Type
total_opens Total amount of times the email was opened Integer
unique_opens Count of unique opens for the email. Integer
reads How many times the email was read. Integer
skims How many times the email was skimmed. Integer
deletes How many times the email was glanced at. Integer
forwards How many times the email was forwarded. Integer
prints How many times the email was printed. Integer
stats_per_day Contains per day statistics.
forwards Per day forward statistics.
day Statistics for a specific day.
date Date for the day. Format: MM-DD-YYYY Date Formatted String
amount Count for forwards on this day Integer
opens Per day open statistics.
day Statistics for a specific day.
date Date for the day. Format: MM-DD-YYYY Date Formatted String
amount Count for opens on this day Integer
prints Per day print statistics.
day Statistics for a specific day.
date Date for the day. Format: MM-DD-YYYY Date Formatted String
amount Count for prints on this day Integer
unique_opens Per day unique open statistics.
day Statistics for a specific day.
date Date for the day. Format: MM-DD-YYYY Date Formatted String
amount Count for unique opens on this day Integer
opens_by_environment Gives open count for each environment.
Desktop Count for opens in desktop email clients.
Web Count for opens in web email clients.
Mobile Count for opens in mobile devices.
top_10_clients Contains the top 10 email clients for the campaign.
client Client specific statistics.
client_name The name of the email client. String
unique_total Count of unique opens in the client. Integer
open_total Count of opens in the client. Integer
top_5_countries Contains the top 5 countries for the campaign.
country Link specific statistics.
country_code Abbreviated country code.
Example: US
String
country_name Name of the country String
total_open Open count in this country. Integer
total_forward Forward count in this country. Integer
total_print Print count in this country. Integer
total_delete Glance count in this country. Integer
total_skim Skim count in this country. Integer
total_read Read count in this country. Integer
total_desktop Open count for desktop email clients in this country. Integer
total_mobile Open count for mobile devices in this country. Integer
total_web_client Open count for web email clients in this country. Integer