GetEngagementReport

Returns engagement statistics for a campaign.

URLs:

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

Request:

<?xml version="1.0"?>
<get_engagement_report>
  <guid>CAMPAIGN GUID</guid>
</get_engagement_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:

<?xml version="1.0"?>
<xml>
  <total_opens>TOTAL OPENS</total_opens>
  <total_reads>TOTAL READS</total_reads>
  <total_skims>TOTAL SKIMS</total_skims>
  <total_deletes>TOTAL GLANCES</total_deletes>
  <total_forwards>TOTAL FORWARDS</total_forwards>
  <total_prints>TOTAL PRINTS</total_prints>
  <email_clients>
    <client>
      <client_name>CLIENT NAME</client_name>
      <opens>TOTAL OPENS FOR CLIENT</opens>
      <unique_opens>TOTAL UNIQUE OPENS FOR CLIENT</unique_opens>
      <reads>TOTAL READS WITH CLIENT</reads>
      <read_percentage>READ PERCENTAGE FOR CLIENT</read_percentage>
      <skims>TOTAL SKIMS FOR CLIENT</skims>
      <skim_percentage>SKIM PERCENTAGE FOR CLIENT</skim_percentage>
      <deletes>TOTAL GLANCES FOR CLIENT</deletes>
      <delete_percentage>DELETE PERCENTAGE FOR CLIENT</delete_percentage>
    </client>
    ..........
      
  </email_clients>
  <mobile_devices>
    <device>
      <device_name>DEVICE NAME</device_name>
      <opens>TOTAL OPENS FOR DEVICE</opens>
      <unique_opens>TOTAL UNIQUE OPENS FOR DEVICE</unique_opens>
      <reads>TOTAL READS WITH DEVICE</reads>
      <read_percentage>READ PERCENTAGE FOR DEVICE</read_percentage>
      <skims>TOTAL SKIMS FOR DEVICE</skims>
      <skim_percentage>SKIM PERCENTAGE FOR DEVICE</skim_percentage>
      <deletes>TOTAL GLANCES FOR DEVICE</deletes>
      <delete_percentage>DELETE PERCENTAGE FOR DEVICE</delete_percentage>
    </device>
    ..........
    
  </mobile_devices>
  <environments>
    <desktop>
      <opens>TOTAL OPENS</opens>
      <unique_opens>UNIQUE OPENS</unique_opens>
      <reads>READS</reads>
      <skims>SKIMS</skims>
      <deletes>GLANCES</deletes>
    </desktop>
    <web>
      <opens>TOTAL OPENS</opens>
      <unique_opens>UNIQUE OPENS</unique_opens>
      <reads>READS</reads>
      <skims>SKIMS</skims>
      <deletes>GLANCES</deletes>
    </web>
    <mobile>
      <opens>TOTAL OPENS</opens>
      <unique_opens>UNIQUE OPENS</unique_opens>
      <reads>READS</reads>
      <skims>SKIMS</skims>
      <deletes>GLANCES</deletes>
    </mobile>
  </environments>
</xml>

Response Details:

Element Description Data Type
total_opens Total amount of times the email was opened Integer
total_reads Total amount of times the email was read Integer
total_skims Total amount of times the email was skimmed Integer
total_deletes Total amount of times the email was glanced at Integer
total_forwards Total amount of times the email was forwarded Integer
total_prints Total amount of times the email was printed Integer
email_clients Statistics for each email client the email was opened in.
client Statistics for a specific email client.
client_name Name of email client String
opens Total number of emails opened. Integer
reads Total number of emails read. Integer
read_percentage Percentage of email reads in this client compared to every other email client. Float
skims Total number of emails skimmed. Integer
skim_percentage Percentage of email skims in this client compared to every other email client. Float
deletes Total number of emails glanced at. Integer
delete_percentage Percentage of email glances in this client compared to every other email client. Float
mobile_devices Statistics for each mobile device the email was opened in.
device Statistics for a specific mobile device.
device_name Name of mobile device String
opens Total number of emails opened. Integer
reads Total number of emails read. Integer
read_percentage Percentage of email reads in this device compared to every other mobile device. Float
skims Total number of emails skimmed. Integer
skim_percentage Percentage of email skims in this device compared to every other mobile device. Float
deletes Total number of emails glanced at. Integer
delete_percentage Percentage of email glances in this device compared to every other mobile device. Float
environments Statistics for each environment
desktop Statistics for desktop based email clients
opens Total number of emails opened. Integer
reads Total number of emails read. Integer
skims Total number of emails skimmed. Integer
deletes Total number of emails glanced at. Integer
web Statistics for web based email clients
opens Total number of emails opened. Integer
reads Total number of emails read. Integer
skims Total number of emails skimmed. Integer
deletes Total number of emails glanced at. Integer
mobile Statistics for mobile based email clients
opens Total number of emails opened. Integer
reads Total number of emails read. Integer
skims Total number of emails skimmed. Integer
deletes Total number of emails glanced at. Integer