View Advertiser report
Copied
https://api.ocamba.com/v2/adex/reports/advertiser
Copied
https://api.ocamba.com/v2/adex/reports/advertiser
Obtain various advertiser reports
Name
Descriptionsortstring
Sorts the response by specified field(s) with the option to specify sorting order (ascending by default, add prefix "-" for descending).Examples:
GET /VERSION/adex/RESOURCE_NAME?sort=name → sorts per name, ascending
GET /VERSION/adex/RESOURCE_NAME?sort=-id → sorts per id descending
GET /VERSION/adex/RESOURCE_NAME?sort=id,-name → sorts per id ascending, then name descending
See tips for the list of sortable fields.
Example: sort=-field1,field2
pagestring
The page number indicates which set of items will be returned in the response. The format of request is "page=N,M" where 'N' (required) represents page number and 'M' (optional) is number of items per page.Examples:
N=1, M=20 → returns page 1 with 20 items
N=2, M=20 → returns page 2 with 20 items (items 21-40)
N=3 → returns page 3. The number of objects returned depends on the resource settings.
Example: page=1,10
fieldsstring
The client can request more efficient filtered representation of the resource showing only specific field(s), using the “fields” query parameter. Note that the “fields” parameter has precedence over the “view” parameter.Example GET /VERSION/adex/RESOURCE_NAME?fields=id,name
See "Tips" for the list of filterable parameters.
Example: fields=field1,field2,field3
stat_datestring
The day of the event.Example: today
200 - OK
Name
Descriptionab_test_idstring
DimensionThe id of the ab_test.
Example: 5
ab_test_namestring
DimensionThe A/B test name.
Example: test
ab_test_variation_idstring
DimensionThe id of the ab_test_variation.
Example: 18
ab_test_variation_namestring
DimensionThe A/B test variation name.
Example: variation test
asninteger
DimensionThe Autonomous System Number.
Example: 15169
browser_idinteger
DimensionThe id of the browser.
Example: 10
browser_namestring
DimensionThe name of the browser.
Example: Chrome
browser_versioninteger
DimensionThe major version of the browser.
Example: 87
campaign_algo_idinteger
DimensionUnique campaign algorithm identifier.
Example: 1
campaign_algo_namestring
DimensionThe campaign algorithm name.
Example: Round-robin
campaign_idinteger
DimensionThe campaign id generated on ocamba platform.
Example: 1059687
campaign_namestring
DimensionThe campaign name created on ocamba platform.
Example: Test campaign
ccrfloat
MeasureThe rate of conversions to clicks.
Example: 0.057
cirfloat
MeasureThe rate of clicks to impressions.
Example: 12.98
city_idinteger
DimensionThe GeoName ID of the city.
Example: 6354908
city_namestring
DimensionThe name of the city.
Example: Sydney
clickinteger
MeasureThe total number of valid clicks across all impressions.
Example: 123456
conn_typestring
DimensionThe type of the connection.
Example: cable/dsl
conn_type_idinteger
DimensionThe ID of the connection type. (1 - 'dialup', 2 - 'cable/dsl', 3 - 'corporate', 4 - 'cellular')
Example: 2
container_idinteger
DimensionUnique container identifier generated on Ocamba platform.
Example: 126598752
container_namestring
DimensionContainer name created on Ocamba platform.
Example: test.demo.com
conversioninteger
MeasureThe total number of conversions.
Example: 12
convs_ratefloat
MeasureThe rate of conversions to impressions.
Example: 0.0856
country_codestring
DimensionThe code of the geographical country.
Example: RS
country_namestring
DimensionThe name of the geographical country.
Example: Serbia
cpcfloat
MeasureThe rate of clicks to revenue.
Example: 187.02
cpmmfloat
MeasureThe number of conversions per million impressions.
Example: 221.877
creative_idinteger
DimensionThe creative id generated on ocamba platform.
Example: 1029607
creative_langstring
DimensionThe creative language.
Example: en
creative_namestring
DimensionThe creative name created on ocamba platform.
Example: Dynamic native test
creator_idinteger
DimensionThe creator id generated on Ocamba platform.
Example: 1000123
creator_namestring
DimensionThe creator name.
Example: Jane Doe
cta_0integer
MeasureThe total number of clicks on default call to action.
cta_1integer
MeasureThe total number of clicks on first call to action.
Example: 1
cta_2integer
MeasureThe total number of clicks on second call to action.
Example: 2
cta_3integer
MeasureThe total number of clicks on third call to action (only for Android and iOS).
Example: 3
ctpfloat
MeasureThe rate of clicks to impressions with percentage.
Example: 0.56
ctrfloat
MeasureThe rate of clicks to impressions.
Example: 0.002
device_idinteger
DimensionThe id of the device.
Example: 5
device_namestring
DimensionThe name of the device.
Example: sony
dsp_account_idinteger
DimensionThe adex account id generated on ocamba platform.
Example: 874214212
dsp_account_namestring
DimensionThe adex account name created on ocamba platform.
Example: Default account
dsp_iab_categoryinteger
DimensionThe dsp IAB category id.
Example: 103
dsp_iab_idstring
DimensionThe dsp IAB id.
Example: IAB1-3
dsp_iab_namestring
DimensionThe dsp IAB category name.
Example: Fine Art
dsp_parent_iab_idstring
DimensionThe dsp parent IAB id.
Example: IAB1
ecpafloat
MeasureThe effective spend per conversion.
Example: 1.2
ecpcfloat
MeasureThe effective spend per click.
Example: 1.25
ecpmfloat
MeasureThe effective spend per 1000 impressions.
Example: 187.02
exchange_idinteger
DimensionThe exchange id generated on ocamba platform.
Example: 1258
exchange_namestring
DimensionThe exchange name created on ocamba platform.
Example: First test exchange #1
expected_incomefloat
MeasureThe total expected income.
Example: 0.56
expensefloat
MeasureThe total expense.
Example: 12.98
hood_tag_idinteger
DimensionHood tag id created on Ocamba platform.
Example: 126598752
hood_tag_namestring
DimensionHood tag name created on Ocamba platform.
Example: test.demo.com
impressioninteger
MeasureThe total number of impressions served.
Example: 5246872
incomefloat
MeasureThe total income.
Example: 125.65
ispstring
DimensionInternet Service Provider.
Example: Google
keywordstring
DimensionCharacteristic set of words or a phrase which describes the bid request.
Example: sport
os_idinteger
DimensionThe id of the operating system.
Example: 12
os_namestring
DimensionThe name of the operating system.
Example: Android
os_versioninteger
DimensionThe major version of the operating system.
Example: 15
partner_idinteger
DimensionThe partner id generated on ocamba platform.
Example: 1029607
partner_namestring
DimensionThe partner name created on ocamba platform.
Example: Zeropark
ppmfloat
MeasureThe profit per 1000 impressions.
Example: 0.944
revenuefloat
MeasureThe total revenue.
Example: 187.02
rpmfloat
MeasureThe revenue per 1000 impressions.
Example: 2.65
servedinteger
MeasureThe total number of served campaigns in response.
Example: 5687421
server_traffic_idstring
DimensionThe server traffic identifier.
Example: 2
server_traffic_namestring
DimensionThe server traffic name.
Example: VPN
spam_clickinteger
MeasureThe total number of spam clicks across all impressions.
Example: 56
ssp_account_idinteger
DimensionThe adex account id generated on ocamba platform.
Example: 68745145
ssp_account_namestring
DimensionThe adex account name created on ocamba platform.
Example: Default account
stat_datedateTime
DimensionThe day of the event.
Example: 2021-12-27
subidstring
DimensionString used to record and track unique user attributes, traffic sources, banners, and/or link placement.
Example: example_source
taginteger
DimensionThe ID of request type. (1 - 'open rtb', 5 - 'native', 6 - 'webpush', 7 - 'widget', 9 - 'smartlink')
Example: 6
total_clickinteger
MeasureThe total number of all clicks across all impressions.
Example: 56
user_langstring
DimensionThe language of the user.
Example: en
zone_idinteger
DimensionThe zone id generated on ocamba platform.
Example: 1029607
zone_namestring
DimensionThe zone name created on ocamba platform.
Example: Push zone
tip
1 Sortable fields are: stat_date, subid, zone_id, zone_name, country_code, country_name, os_version, os_id, os_name, tag, browser_version, browser_id, browser_name, device_id, device_name, user_lang, hood_tag_id, hood_tag_name, container_id, container_name, asn, isp, conn_type_id, conn_type, city_id, city_name, keyword, ssp_account_id, ssp_account_name, ssp_pm, server_traffic_id, server_traffic_name, region, region_name, exchange_id, exchange_name, partner_id, partner_name, campaign_id, campaign_name, creator_id, creator_name, creative_id, creative_name, creative_lang, dsp_pm, dsp_account_id, dsp_account_name, dsp_iab_category, dsp_iab_id, dsp_parent_iab_id, dsp_iab_name, ab_test_id, ab_test_name, ab_test_variation_id, ab_test_variation_name, page_url, page_domain, impression, total_click, spam_click, click, conversion, income, cost, expected_income, attributed_revenue, expense, served, ctr, ctp, cir, ecpm, ecpa, ppm, ccr, cta_0, cta_1, cta_2, cta_3, campaign_algo_id and campaign_algo_name.
2 Filterable fields are: stat_date, subid, zone_id, country_code, os_version, os_id, tag, browser_version, browser_id, device_id, user_lang, hood_tag_id, container_id, asn, isp, conn_type_id, city_id, keyword, ssp_account_id, ssp_pm, server_traffic_id, region, exchange_id, partner_id, campaign_id, campaign_name, creator_id, creator_name, creative_id, creative_name, creative_lang, dsp_pm, dsp_account_id, dsp_iab_category, dsp_iab_id, dsp_parent_iab_id, ab_test_id, ab_test_variation_id, page_url, page_domain, impression, total_click, spam_click, click, conversion, income, cost, expected_income, attributed_revenue, expense, served, ctr, ctp, cir, ecpm, ecpa, ppm, ccr, cta_0, cta_1, cta_2, cta_3, campaign_algo_id and campaign_algo_name.
3 To get data by the time in your local time zone, you should set tz query parameter to the specific time zone. See the list of valid time zones here -> https://en.wikipedia.org/wiki/List_of_tz_database_time_zones#List.
4 API provided filling empty entry points in between first and last date/hour. You should set with_fill parameter to true, but just in case the date dimension is requested only. It is in relation with resolution. You should pass day or hour, which defines what type of breakdown you request, default setup displays daily breakdown.
5 For easier search, Reports API gives you the possibility of using one of the following labels: today, yesterday, last-7-days, last-30-days, last-24-hours, this-month, last-month, current-hour, last-hour, last-48-hours, last-2-days, month-to-date, month-to-yesterday, quarter-to-date.
note
1 When filtering delivery_date and delivery_time, use one of the following formats:
- Single format: YYYY-mm-dd;
Displaying stats for this specific day
- Range format: rf:YYYY-mm-dd,YYYY-mm-dd;
Requires usage of the range operators:
- r - range - The value must be in a specified open range, where both endpoints are excluded.
- rf - range full - The value must be in a specified closed range, where both endpoints are included.
- rl - range left - The value must be in a specified half-open range, where only left or start point is included.
- rr - range right - The value must be in a specified half-open range, where only right or end point is included.
Displaying stats in this specific range.
- Hour range format: rl: YYYY-mm-dd hh:00:00,YYYY-mm-dd hh:00:00
If you exclude this parameter, the default setup displays "today" stats.
- Single format: YYYY-mm-dd;
Displaying stats for this specific day
- Range format: rf:YYYY-mm-dd,YYYY-mm-dd;
Requires usage of the range operators:
- r - range - The value must be in a specified open range, where both endpoints are excluded.
- rf - range full - The value must be in a specified closed range, where both endpoints are included.
- rl - range left - The value must be in a specified half-open range, where only left or start point is included.
- rr - range right - The value must be in a specified half-open range, where only right or end point is included.
Displaying stats in this specific range.
- Hour range format: rl: YYYY-mm-dd hh:00:00,YYYY-mm-dd hh:00:00
If you exclude this parameter, the default setup displays "today" stats.