GetEmailClientReport

Returns break down of email clients the email was opened in and the clients individual statistics.

URLs:

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

Request:

<?xml version="1.0"?>
<get_emailclient_report>
  <guid>CAMPAIGN GUID</guid>
</get_emailclient_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>
  <top_10_clients>
    <client>
      <client_name>CLIENT NAME</client_name>
      <unique_total>UNIQUE OPENS</unique_total>
      <open_total>TOTAL OPENS</open_total>
    </client>
    ..........
      
  </top_10_clients>
  <client_breakdown>
    <client>
      <name>CLIENT NAME</name>
      <opens>TOTAL OPENS</opens>
      <unique_opens>UNIQUE OPENS</unique_opens>
      <percent_total>PERCERNT OF OPENS</percent_total>
      <percent_unique>PERCENT OF UNIQUE OPENS</percent_unique>
      <versions>
        <version>
          <name>VERSION NAME</name>
          <opens>VERSION OPEN COUNT</opens>
          <unique_opens>VERSION UNIQUE OPEN COUNT</unique_opens>
          <percent_total>VERSION PERCENT OF OPENS</percent_total>
          <percent_unique>VERSION PERCENT OF UNIQUE OPENS</percent_unique>
        </version>
      </versions>
    </client>
    ..........
      
  </client_breakdown>
</xml>

Response Details:

Element Description Data Type
top_10_clients List of the top ten email clients
client Specific client information
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
client_breakdown List all email clients, their statistics and the statistics for the different versions of each client.
client Specific client information
name The name of the client. String
opens Count of opens in the client. Integer
unique_opens Count of unique opens in the client. Integer
percent_total Percentage of total opens for this client compared to all of the other clients. String
percent_unique Percentage of total unique opens for this client compared to all of the other clients. String
versions List of all the different client versions and their statistics
version A specific versions statistics
name The name of the client version. String
opens Count of opens in the client version. Integer
unique_opens Count of unique opens in the client version. Integer
percent_total Percentage of total opens for this client version compared to all of the other versions of this client. String
percent_unique Percentage of total unique opens for this client version compared to all of the other versions of this client. String