GetGeolocationReport

Returns geolocation statistics for a campaign.

URLs:

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

Request:

<?xml version="1.0"?>
<get_geolocation_report>
  <guid>CAMPAIGN GUID</guid>
</get_geolocation_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_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 WEB CLIENT OPENS</total_web_client>
    </country>
    ..........
      
  </top_5_countries>
  <country_stats>
    <AF>
      <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 WEB CLIENT OPENS</total_web_client>
    </AF>
    ..........
      
  </country_stats>
</xml>

Response Details:

Element Description Data Type
top_5_countries Statistics for top 5 countries
country Statistics specific countries
country_code Abbreviated code for this country.
Exampe: US
String
country_name Name of country.
Exampe: United States
String
unique_open Number of unique opens in this country. Integer
total_open Total number of opens in this country. Integer
total_forward Total number of forwards in this country. Integer
total_print Total number of prints in this country. Integer
total_delete Total number of glances in this country. Integer
total_skim Total number of skims in this country. Integer
total_read Total number of reads in this country. Integer
total_desktop Total number of opens in desktop email clients in this country. Integer
total_mobile Total number of opens in mobile devices in this country. Integer
total_web Total number of opens in web email clients in this country. Integer
country_stats Contains statistics for every country using the country code as the element name.