TABLE OF CONTENTS
EX.CO Reports API is an interface that enables our partners to connect, login and download predefined reports. It requires an account on the platform with reporting rights to access the API. The following tables lists the formats and conventions used when exchanging data with the EX.CO API.
Reports API Base URL:
Revenue
Revenue report object
POST api/v1/revenue
Property | Required | Type | Description | Default |
---|---|---|---|---|
dimensions | Required | Array | Grouping field. Min 1, max 3 field(s) will be included in report. See dimensions section. | - |
filters | Required | Object | Use filters to narrow the report results. Up to 5 filters could be applied per request. See filters section. | - |
metrics | Required | Array | Value(s) filed(s). Min 1 metric(s) will be included in report. See metrics section. | - |
format | Optional | String | Use format to set request response type. Supported formats are |
|
Dimensions
Property | Required | Type | Description |
---|---|---|---|
utm_source | optional | String | Breakdown report by |
utm_medium | optional | String | Breakdown report by |
utm_campaign | optional | String | Breakdown report by |
utm_term | optional | String | Breakdown report by |
utm_content | optional | String | Breakdown report by |
embed_type | optional | String | Breakdown report by |
country | optional | String | Breakdown report by country. |
date | optional | String | Breakdown report by date. |
hour | optional | String | Breakdown report by hour. |
product | optional | String | Breakdown report by product. |
subId | optional | String | Breakdown report by |
os | optional | String | Breakdown report by |
browser | optional | String | Breakdown report by |
device | optional | String | Breakdown report by |
domain | optional | String | Breakdown report by |
player | optional | String | Breakdown report by |
Filters
Property | Required | Type | Description | Support values |
---|---|---|---|---|
fromDate | required | Date | Filter results by ISO date. | |
toDate | required | Date | Filter results by ISO date. | |
utcOffset | optional | String | Time offset from UTC. default is | "UTC-11:00" |
device | optional | String | Filter results by | "mobile" |
demand_type | optional | String | Filter results by | "network" |
player | optional | String | Filter results by | |
players | optional | String | Filter results by | |
utm_source | optional | String | Filter results by | |
utm_medium | optional | String | Filter results by | |
utm_campaign | optional | String | Filter results by | |
utm_content | optional | String | Filter results by | |
embed_type | optional | String | Filter results by | |
utm_term | optional | String | Filter results by | |
subId | optional | String | Filter results by | |
os | optional | String | Filter results by | "-" |
browser | optional | String | Filter results by | "-" |
country | optional | String | Filter results by | Supported countries can be found here. |
domain | optional | String | Filter results by | |
type | optional | String | Filter results by | "display" |
Notes: All filters are case insensitive
Metrics
Property | Required | Type | Description |
---|---|---|---|
loads | optional | String | Number of unit loads. |
revenue | optional | String | Generated revenue. |
rpm | optional | String | Revenue per thousand loads |
viewable_loads | optional | String | Number of viewable unit loads |
viewable_rpm | optional | String | Revenue per thousand viewable loads |
viewability | optional | String | The percentage of viewable player loads from all player loads |
cta_clicks | optional | String | Number of the content clicks |
cpm | optional | String | Cost per thousand impressions |
Example Request payload:
{ "dimensions": [ "domain", "country", "utm_source" ], "filters": { "fromDate": "2019-01-01", "toDate": "2019-01-02", "country": ["United States", "Israel"], "utm_source": "facebook", "domain": "test.com" }, "format": "json", "metrics": [ "rpm" ] }
[ { "product": "stream", "country": "Israel", "rpm": 1.218984, "domain": "test.com", "utm_source": "facebook" }, { "product": "stream", "country": "United States", "rpm": 3.413984, "domain": "test.com", "utm_source": "facebook" } ]
Demand Revenue report object
POST api/v1/revenue/demand
NOTE: To perform any actions, please see authentication section.
Property | Required | Type | Description | Default |
---|---|---|---|---|
dimensions | Required | Array | Grouping field. Min 1, max 3 field(s) will be included in report. See dimensions section. | - |
filters | Required | Object | Use filters to narrow the report results. Up to 5 filters could be applied per request. See filters section. | - |
metrics | Required | Array | Value(s) filed(s). Min 1 metric(s) will be included in report. See metrics section. | - |
format | Optional | String | Use format to set request response type. Supported formats are csv and json . | json |
Dimension
Property | Required | Type | Description |
utm_source | optional | String | Breakdown report by utm_source URL param. |
utm_medium | optional | String | Breakdown report by utm_medium URL param. |
utm_campagin | optional | String | Breakdown report by utm_campaign URL param. |
utm_term | optional | String | Breakdown report by utm_term URL param. |
utm_content | optional | String | Breakdown report by utm_content URL param. |
embed_type | optional | String | Breakdown report by embed_type URL param. |
country | optional | String | Breakdown report by country. |
date | optional | String | Breakdown report by date. |
hour | optional | String | Breakdown report by hour. |
product | optional | String | Breakdown report by product. |
subId | optional | String | Breakdown report by subId js function. |
os | optional | String | Breakdown report by Operating System name. |
browser | optional | String | Breakdown report by Browser name. |
device | optional | String | Breakdown report by Device name. |
domain | optional | String | Breakdown report by domain name. |
player | optional | String | Breakdown report by player name. |
Filters
Property | Required | Type | Description | Supported values |
---|---|---|---|---|
fromDate | required | Date | Filter results by ISO date. | |
toDate | required | Date | Filter results by ISO date. | |
utcOffset | optional | String | Time offset from UTC. default is "UTC 00:00" | "UTC-11:00" "UTC-10:00" "UTC-09:00" "UTC-08:00" "UTC-07:00" "UTC-06:00" "UTC-05:00" "UTC-04:00" "UTC-03:00" "UTC-02:00" "UTC-01:00" "UTC 00:00" "UTC+01:00" "UTC+02:00" "UTC+03:00" "UTC+04:00" "UTC+05:00" "UTC+05:45" "UTC+06:00" "UTC+07:00" "UTC+08:00" "UTC+09:00" "UTC+10:00" "UTC+11:00" "UTC+12:00" "UTC+13:00" |
device | optional | String[] | Filter results by Device . Full match mode | "mobile" "desktop" |
demand_type | optional | String | Filter results by Demand Type . Full match mode | "network" "publisher" |
player | optional | String | Filter results by Player id. Full match mode | |
players | optional | String[] | Filter results by Player id. Full match mode | |
utm_source | optional | String | Filter results by UTM_source value. Contains mode | |
utm_medium | optional | String | Filter results by UTM_medium value. Contains mode | |
utm_campaign | optional | String | Filter results by UTM_campaign value. Contains mode | |
utm_content | optional | String | Filter results by UTM_content value. Contains mode | |
embed_type | optional | String | Filter results by Embed_type value. Full match mode | |
utm_term | optional | String | Filter results by UTM_term value. Contains mode | |
subId | optional | String | Filter results by subId value. Full match mode | |
os | optional | String[] | Filter results by Operating System . Full match mode | "-" "Android" "webOS" "Tizen" "BlackBerry" "OSX" "Fedora" "Linux" "KaiOS" "RIM Tablet OS" "Chrome OS" "Symbian S60" "Ubuntu" "Windows Phone" "iOS" "Windows 10 Mobile;" "Fire OS" "Chromecast" "PlayStation OS" "Symbian OS" "Roku OS" "Windows" "Nintendo" "Xbox OS" |
browser | optional | String[] | Filter results by Browser . Full match mode | "-" "Office" "Opera" "Opera Mobile" "DeX Samsung Browser" "Chrome Mobile on iOS" "Quark Browser" "360 Browser" "Java Applet" "Tizen Browser" "UC Web Browser on iOS" "Android" "Mobile Safari" "UC Browser" "Amazon Silk Browser" "Xiaomi Mint browser" "QuickLook" "Symbian S60 Browser" "MAUI Browser" "Netfront NX" "Chrome Mobile" "Chrome" "QQ Browser" "Huawei Browser" "Elements Browser" "Thunderbird" "Android App" "Oculus Browser" "Facebook on Android" "Epiphany" "IE Mobile" "WebView" "Puffin browser" "Seznam Browser" "Aloha Browser" "AOL Shield browser" "Samsung Browser" "Chromium" "BlackBerry Webkit Browser" "Firefox Rocket" "BlackBerry Browser" "Firefox" "Meizu Browser" "Opera Coast" "PaleMoon" "Opera Mini on iOS" "SeaMonkey" "Opera Mini" "Nintendo Browser" "mCent Browser" "Coc Coc Browser" "Vivo Browser" "Firefox Mobile" "Qt framework" "MIUI Browser" "Oppo Browser" "Facebook on iOS" "Avast Secure Browser" "CFNetwork App" "Vivaldi" "Android Webkit" "Firefox Focus" "Edge" "Edge Mobile" "Firefox on iOS" "Google Search Application" "Baidu Browser" "Safari" "Aloha Lite Browser" "IE" "Yandex browser" |
country | optional | String[] | Filter results by Country . Full match mode | Supported countries can be found here, for example |
domain | optional | String[] | Filter results by Domain . Full match mode | |
type | optional | String[] | Filter results by Ad Type . Full match mode "all" will return results for all add types | "display" "video" "all" |
All filters are case sensitive
Metrics
Property | Required | Type | Description |
---|---|---|---|
ad_viewability | optional | String | The percentage viewable ads of all displayed ads |
fill_rate | optional | String | The percentage of fulfilled ad requests of all ad requests made |
pd_ad_requests | optional | String | Ad requests made from publisher demand |
viewable_ads | optional | String | Number of viewable ads |
ad_completed | optional | String | Number of ads completed |
ad_clicks | optional | String | Number of ad clicks |
ecpm | optional | String | Cost per thousand impressions |
vcr | optional | String | Completed Ads |
ad_ctr | optional | String | Click Through Rate |
publisher_revenue | optional | String | Revenue from publisher demand |
ad_impressions | optional | String | Number of ad impressions |
Was this article helpful?
That’s Great!
Thank you for your feedback
Sorry! We couldn't be helpful
Thank you for your feedback
Feedback sent
We appreciate your effort and will try to fix the article