View Publisher report

Copied

                https://api.ocamba.com/v2/adex/reports/publisher

Obtains report on Publisher

query Parameters

Name

Description

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

sortstring

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

stat_datestring

The day of the event.

Example: today

Response status codes

200 - OK

Name

Description

asninteger

Dimension
The Autonomous System Number.

Example: 15169

browser_idinteger

Dimension
The id of the browser.

Example: 10

browser_namestring

Dimension
The name of the browser.

Example: Chrome

browser_versioninteger

Dimension
The major version of the browser.

Example: 87

campaign_algo_idinteger

Dimension
Unique campaign algorithm identifier.

Example: 1

campaign_algo_namestring

Dimension
The campaign algorithm name.

Example: Round-robin

cirfloat

Measure
The rate of clicks to impressions.

Example: 12.98

city_idinteger

Dimension
The GeoName ID of the city.

Example: 6354908

city_namestring

Dimension
The name of the city.

Example: Sydney

clickinteger

Measure
The total number of valid clicks across all impressions.

Example: 123456

conn_typestring

Dimension
The type of the connection.

Example: cable/dsl

conn_type_idinteger

Dimension
The ID of the connection type. (1 - 'dialup', 2 - 'cable/dsl', 3 - 'corporate', 4 - 'cellular')

Example: 2

container_idinteger

Dimension
Unique container identifier generated on Ocamba platform.

Example: 126598752

container_namestring

Dimension
Container name created on Ocamba platform.

Example: test.demo.com

conversioninteger

Measure
The total number of conversions.

Example: 12

convs_ratefloat

Measure
The rate of conversions to impressions.

Example: 0.0856

country_codestring

Dimension
The code of the geographical country.

Example: RS

country_namestring

Dimension
The name of the geographical country.

Example: Serbia

cpcfloat

Measure
The rate of clicks to revenue.

Example: 187.02

cpmmfloat

Measure
The number of conversions per million impressions.

Example: 221.877

cta_0integer

Measure
The total number of clicks on default call to action.

cta_1integer

Measure
The total number of clicks on first call to action.

Example: 1

cta_2integer

Measure
The total number of clicks on second call to action.

Example: 2

cta_3integer

Measure
The total number of clicks on third call to action (only for Android and iOS).

Example: 3

ctpfloat

Measure
The rate of clicks to impressions with percentage.

Example: 0.56

ctrfloat

Measure
The rate of clicks to impressions.

Example: 0.002

device_idinteger

Dimension
The id of the device.

Example: 5

device_namestring

Dimension
The name of the device.

Example: sony

ecpcfloat

Measure
The effective spend per click.

Example: 1.25

expected_incomefloat

Measure
The total expected income.

Example: 0.56

expensefloat

Measure
The total expense.

Example: 12.98

fillinteger

Measure
The total number of respones from ad server with at least one ad.

Example: 5687421

filled_rpmfloat

Measure
The revenue per 1000 filled impressions.

Example: 33.16

ftrfloat

Measure
The rate of fill to requests with percentage.

Example: 0.99

hood_tag_idinteger

Dimension
Hood tag id created on Ocamba platform.

Example: 126598752

hood_tag_namestring

Dimension
Hood tag name created on Ocamba platform.

Example: test.demo.com

impressioninteger

Measure
The total number of impressions served.

Example: 5246872

incomefloat

Measure
The total income.

Example: 125.65

ispstring

Dimension
Internet Service Provider.

Example: Google

keywordstring

Dimension
Characteristic set of words or a phrase which describes the bid request.

Example: sport

os_idinteger

Dimension
The id of the operating system.

Example: 12

os_namestring

Dimension
The name of the operating system.

Example: Android

os_versioninteger

Dimension
The major version of the operating system.

Example: 15

requestinteger

Measure
The total number of requests to ad server.

Example: 5687421

revenuefloat

Measure
The total revenue.

Example: 187.02

rpmfloat

Measure
The revenue per 1000 impressions.

Example: 2.65

servedinteger

Measure
The total number of served ads.

Example: 5687421

server_traffic_idstring

Dimension
The server traffic identifier.

Example: 2

server_traffic_namestring

Dimension
The server traffic name.

Example: VPN

spam_clickinteger

Measure
The total number of spam clicks across all impressions.

Example: 56

ssp_account_idinteger

Dimension
The adex account id generated on ocamba platform.

Example: 68745145

ssp_account_namestring

Dimension
The adex account name created on ocamba platform.

Example: Default account

ssp_iab_categoryinteger

Dimension
The ssp IAB category id.

Example: 103

ssp_iab_idstring

Dimension
The ssp IAB id.

Example: IAB1-3

ssp_iab_namestring

Dimension
The ssp IAB category name.

Example: Fine Art

ssp_parent_iab_idstring

Dimension
The ssp parent IAB id.

Example: IAB1

stat_datedateTime

Dimension
The day of the event.

Example: 2021-12-27

subidstring

Dimension
String used to record and track unique user attributes, traffic sources, banners, and/or link placement.

Example: example_source

taginteger

Dimension
The ID of request type. (1 - 'open rtb', 5 - 'native', 6 - 'webpush', 7 - 'widget', 9 - 'smartlink')

Example: 6

total_clickinteger

Measure
The total number of all clicks across all impressions.

Example: 56

user_langstring

Dimension
The language of the user.

Example: en

zone_idinteger

Dimension
The zone id generated on ocamba platform.

Example: 1029607

zone_namestring

Dimension
The zone name created on ocamba platform.

Example: Push zone

tip

1 Sortable fields are: delivery_date, delivery_time, hood_tag_id, hood_tag_name, container_id, container_name, task_id, task_name, os_name, browser_name, total_user, unsubscribed, delivered, failed, wokenup, impression, total_click, spam_click, click, conversion, income, ctr, ctdr, delivery_rate, cta_0, cta_1, cta_2, cta_3, campaign_algo_id and campaign_algo_name.

2 Filterable fields are: stat_date, day, hour, subid, zone_id, country_code, os_version, os_id, tag, browser_version, browser_id, user_lang, hood_tag_id, container_id, asn, conn_type_id, city_id, keyword, ssp_account_id, ssp_pm, server_traffic_id, region, page_domain, impression, total_click, spam_click, click, cta_0, cta_1, cta_2, cta_3, conversion, income, cost, expected_income, attributed_revenue, expense, earnings, revenue, served, ctr, ctp, cir, cpc, ecpc, rpm, cpmm, convs_rate, request, fill, ftr, ssp_iab_category, ssp_iab_id, 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.

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.

Response examples

Copied

200

[
   {
     "revenue": 2653.32837,
     "stat_date": "2021-12-21T00:00:00Z"
   }
 ]

{
  "stat_date": "2021-12-27",
  "subid": "example_source",
  "zone_id": 1029607,
  "zone_name": "Push zone",
  "ssp_account_id": 68745145,
  "ssp_account_name": "Default account",
  "country_code": "RS",
  "country_name": "Serbia",
  "browser_id": 10,
  "browser_name": "Chrome",
  "browser_version": 87,
  "os_id": 12,
  "os_name": "Android",
  "os_version": 15,
  "tag": 6,
  "device_id": 5,
  "device_name": "sony",
  "user_lang": "en",
  "conn_type_id": 2,
  "conn_type": "cable/dsl",
  "asn": 15169,
  "isp": "Google",
  "city_id": 6354908,
  "city_name": "Sydney",
  "hood_tag_id": 126598752,
  "hood_tag_name": "test.demo.com",
  "container_id": 126598752,
  "container_name": "test.demo.com",
  "keyword": "sport",
  "ssp_iab_category": 103,
  "ssp_iab_id": "IAB1-3",
  "ssp_parent_iab_id": "IAB1",
  "ssp_iab_name": "Fine Art",
  "server_traffic_id": "2",
  "server_traffic_name": "VPN",
  "campaign_algo_id": 1,
  "campaign_algo_name": "Round-robin",
  "served": 5687421,
  "request": 5687421,
  "fill": 5687421,
  "ftr": 0.99,
  "click": 123456,
  "spam_click": 56,
  "total_click": 56,
  "impression": 5246872,
  "conversion": 12,
  "income": 125.65,
  "expected_income": 0.56,
  "expense": 12.98,
  "revenue": 187.02,
  "ctp": 0.56,
  "cir": 12.98,
  "cpc": 187.02,
  "filled_rpm": 33.16,
  "ctr": 0.002,
  "ecpc": 1.25,
  "rpm": 2.65,
  "cpmm": 221.877,
  "convs_rate": 0.0856,
  "cta_1": 1,
  "cta_2": 2,
  "cta_3": 3
}

View Publisher report

GET /reports/publisherCopied https://api.ocamba.com/v2/adex/reports/publisher

GET /reports/publisher
Copied
`https://api.ocamba.com/v2/adex/reports/publisher`