URL syntax:

https://n29.epom.com/rest-api/analytics/{format}/{login}/{hash}/{timestamp}.do

  • {format} represents the expected output format of the retrieved analytics data (available formats include HTML, CSV, PDF, XLSX, and JSON).
  • {login} is the login of the requesting part in Epom system.
  • {timestamp} (13 digits) is the current Unix timestamp on the requesting system. It should be passed in milliseconds.
  • {hash} (32 characters) is an MD5 digest built on the concatenation of MD5 hash of the requesting part's password in Epom System (necessary because user passwords are represented by their hashes in Epom user database) and the timestamp (passed in milliseconds) in the exact aforementioned order.

Supported parameters:

statisticType HADOOP_ADREQUESTS
range (optional) Specifies the time period: TODAY, YESTERDAY, CURRENT_WEEK, CURRENT_MONTH, LAST_7_DAYS, LAST_30_DAYS, LAST_MONTH, LAST_3_MONTH, LAST_6_MONTH, CURRENT_YEAR, LAST_YEAR, CUSTOM. Default value is TODAY. When CUSTOM range is used, customFrom and customTo parameters should be specified.
customFrom (optional) Start date for analytics in format yyyy-MM-dd; range parameter should be set to CUSTOM.
customTo (optional) End date for analytics in format yyyy-MM-dd; range parameter should be set to CUSTOM.
hourFrom (optional) Start hour for analytics in format HH; can be useful only if groupRange is set to HOUR.
hourTo (optional) End hour for analytics in format HH; can be useful only if groupRange is set to HOUR.
groupRange (optional) Time frame for grouping analytical data. Available values: NONE, HOUR, DAY, MONTH, YEAR. Default value: NONE.
groupBy (optional) Parameters for grouping analytics data. Available values: SITE, ZONE, PLACEMENT, PLACEMENT_SIZE, PLACEMENT_LABEL, ADVERTISER, CAMPAIGN, BANNER, BANNER_LABEL, TEMPLATE_ID, CHANNEL, COUNTRY, ACTION, BROWSER, BROWSER_VERS, OPERATING_SYSTEM, OS_VERSION, TIME_ZONE, REFERER, SCREEN_SIZE, CARRIER, PLACEMENT_TYPE, LOCATION, CUSTOM_PARAMETER
displayIds (optional) Used for showing IDs along with the names of the grouped entities: true/false.
eqStr (optional) Parameters for filtering analytics data. Consists of pairs of field names and lists of string values. Field name can be one of the following: CHANNEL, COUNTRY, PLACEMENT_TYPE, BANNER_LABEL, PLACEMENT_LABEL, ACTION, BROWSER, OPERATING_SYSTEM
eqLong (optional) Parameters for filtering analytics data. Consists of pairs of field names and lists of string values. Field name can be one of the following: BANNER, CAMPAIGN, ADVERTISER, PLACEMENT, ZONE, SITE.
breakdownByCustomParameter (optional) Breakdown by Custom Parameter: true/false.
limit (optional) Specifies the numbers of entries to get in the array.
offset (optional) First entry of the array.
actionCustomParameterFragment (optional) Parameters for filtering by Custom Parameter
reportsLayoutSettings (optional) Allow providing reporting layout settings; array or properties names.


Need more help?

Should you require any additional help with our solutions, do not hesitate to contact Epom technical support at support@epom.com. Our support managers are dedicated to resolving any issues and providing you with solutions and support if you face difficulties or have questions.