Analytics API

Login

To get access to analytics and to run any API method, a login request must be run first.

POST http://api-dssXXXX.epom.com/auth/login

Content-Type: application/json

{
  “login”:“[email protected]”,
  “password”:“yourPassword”
}

The response contains the token which should be used for further API calls. Its lifetime is 40 minutes.

Analytics

To get a custom report (up to 2 dimensions) with the specified time granularity, a GroupByGranularity request should be run:

POST https://api-dssXXXX.epom.com/analytics/query/admin/groupByGranularity

Content-Type: application/json
edsp-auth-token: {token received from authentication API call}

 {
    	"dataView": "dspTransactionView",
	"interval": "YYYY-MM-DDT00:00:00.000/YYYY-MM-DDThh:mm:ss.sss",
    	"limit": 1000000,
    	"dimensions": [
    	"cid"
    ],
    	"lookupDimensions": [
    	 "campaign_name"
    ],
      "dimensionFilters" : [  
     {
      "dimension":"ssp_endpoint_id",
      "exclude":false,
      "values":["0e0c23ce-c381-4fb6-9c6e-93d376716988"]
     }
    ],

"granularity" : "HOUR",
    	"orderByMetric": "Impressions",
    	"metrics": [
        "Impressions",
        "Bid Requests",
        "Bid Responses",
        "Bid Rate",
        "Clicks",
        "Spend"
    ]
}

The response contains the report with the specified metrics. It is grouped by campaign names and broken down by hour.

Available Dimensions

Dimension	Description
ssp_id	SSP ID
ssp_endpoint_id	SSP endpoint ID
cid	Campaign ID
crid	Creative ID
imp_placement_type	Placement type
imp_placement_size	Creative size: [impPlacementWidth]x[impPlacementHeight]
device_vendor	Device vendor
device_country_code	GEO > Country
site_domain	Site > domain
publisher_id	Publisher > id
publisher_site_id	Publisher > site_id
os	Device > os
browser	Browser augmented from UA
user_id	SSP specific user id
device_model	Device > model (e.g., “iPhone”)
app_bundle	App > bundle ID
publisher_type	Traffic type as SITE or APP
app_name	App > name
imp_media_type	Media format as BANNER, VIDEO or NATIVE
device_hwv	Device hardware version
os_version	Device > os > version
device_language	Device > browser > language

Available Metrics

Metric	Formula	Description
Bid Requests	bid_req_imps_count	Total number of Bid requests
Bid Responses	bid_imps_count	Total number of Bid responses
Bid Rate	bid_imps_count / bid_req_imps_count * 100%	Bid Responses to Bid Requests percentage
Wins	win_count	Total number of Wins
Win Rate	win_count / bid_imps_count	Wins to Bids percentage
Impressions	imp_count + imp_nurl_count	Total number of Impressions
Unique Impressions	imp_uid_uniq_count	Total number of Unique Impressions (distinct users)
eCPM	((dsp_adv_price_sum/1000) / (imp_count + imp_nurl_count))*1000	Cost per Mile
Clicks	click_count	Total number of Clicks
CTR	click_count / (imp_count + imp_nurl_count)*100%	Click-through rate percentage
eCPC	(dsp_adv_price_sum/1000) / click_count	Cost per Click
Click-to-Bid rate	click_count / bid_imps_count	Click to Bid Responses correlation
Spend	dsp_adv_price_sum / 1000	Costs of the Wins
Action	action_count	Total number of Actions_0
	action_1_count	Total number of Actions_1
	action_2_count	Total number of Actions_2
	action_3_count	Total number of Actions_3
VPC	action_value_sum / action_value_count	Value-per-conversion count for Action_0
	action_1_value_sum / action_value_count	Value-per-conversion count for Action_1
	action_2_value_sum / action_2_value_count	Value-per-conversion count for Action_2
	action_3_value_sum / action_3_value_count	Value-per-conversion count for Action_3
ICR	action_count / (imp_count + imp_nurl_count) * 100%	Action to Impression percentage for Action_0
	action_1_count / (imp_count + imp_nurl_count) * 100%	Action to Impression percentage for Action_1
	action2_count / (imp_count + imp_nurl_count) 100%	Action to Impression percentage for Action_2
	action_3_count / (imp_count + imp_nurl_count) * 100%	Action to Impression percentage for Action_3
CPA	(dsp_adv_price_sum/1000)/ action_count	Cost per Action_0 count
	(dsp_adv_price_sum/1000) / action_1_count	Cost per Action_1 count
	(dsp_adv_price_sum/1000) / action_2_count	Cost per Action_2 count
	(dsp_adv_price_sum/1000) / action_3_count	Cost per Action_3 count
Revenue	action_value_sum	Cost of the Action_0
	action_1_value_sum	Cost of the Action_1
	action_2_value_sum	Cost of the Action_2
	action_3_value_sum	Cost of the Action_3
CCR	(action_count + action_1_count + action_2_count + action_3_count) / click_count * 100%	Clicks to Conversions rate
ROAS	(action_value_sum + action_1_value_sum + action_2_value_sum + action_3_value_sum) / (dsp_adv_price_sum/1000)	Return on Ad Spend
ROI	((action_value_sum + action_1_value_sum + action_2_value_sum + action_3_value_sum) - (dsp_adv_price_sum/1000)) /(dsp_adv_price_sum/1000) * 100%	Return on investment
Skip	vast_skip	Total number of Video Ads that were skipped
First quartile	vast_first_quartile	Total number of Video ads that were viewed by 25%
Midpoint	vast_midpoint	Total number of Video ads that were viewed by 50%
Third quartile	vast_third_quartile	Total number of Video ads that were viewed by 75%
Video 100%	vast_complete	Total number of Video ads that were viewed by 100%
Deposit	/billing/admin/transactions?type=DEBIT	The sum of debit transactions per user
Bid Floor	bid_floor_sum/bid_responses_count	Bid Floor count
Bid Price	dsp_bid_price_sum/bid_imps_count	Bid Price count
Floor CPM	bid_req_ssp_floor_sum/bid_req_imps_count	Minimum cost per Mile