View Publisher Bids report

Copied

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

Obtains report on Publisher Bids

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

avg_bidfloat

Measure
The average bid.

Example: 6.98

browser_idinteger

Dimension
The id of the browser.

Example: 10

browser_namestring

Dimension
The name of the browser.

Example: Chrome

campaign_idinteger

Dimension
The campaign id generated on ocamba platform.

Example: 1059687

campaign_namestring

Dimension
The campaign name created on ocamba platform.

Example: Test campaign

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

country_codestring

Dimension
The code of the geographical country.

Example: RS

country_namestring

Dimension
The name of the geographical country.

Example: Serbia

device_idinteger

Dimension
The id of the device.

Example: 5

device_namestring

Dimension
The name of the device.

Example: sony

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

keywordstring

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

Example: sport

max_bidfloat

Measure
The maximal bid.

Example: 10.98

med_bidfloat

Measure
The median bid.

Example: 4.98

min_bidfloat

Measure
The minimal bid.

Example: 0.98

os_idinteger

Dimension
The id of the operating system.

Example: 12

os_namestring

Dimension
The name of the operating system.

Example: Android

page_domainstring

Dimension
The domain of url of the page where ad is placed.

Example: www.example.com

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

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: stat_date, subid, zone_id, country_code, os_id, hood_tag_id, container_id, browser_id, device_id, keyword, campaign_id, min_bid, max_bid, avg_bid, med_bid.

2 FIlterable fields are: stat_date, subid, zone_id, country_code, os_id, hood_tag_id, container_id, browser_id, device_id, keyword, campaign_id, min_bid, max_bid, avg_bid, med_bid.

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

[
   {
     "avg_bid": 0.0238,
     "stat_date": "2021-12-21T00:00:00Z"
   }
 ]

{
  "stat_date": "2021-12-27",
  "subid": "example_source",
  "zone_id": 1029607,
  "zone_name": "Push zone",
  "country_code": "RS",
  "country_name": "Serbia",
  "browser_id": 10,
  "browser_name": "Chrome",
  "os_id": 12,
  "os_name": "Android",
  "device_id": 5,
  "device_name": "sony",
  "hood_tag_id": 126598752,
  "hood_tag_name": "test.demo.com",
  "container_id": 126598752,
  "container_name": "test.demo.com",
  "keyword": "sport",
  "min_bid": 0.98,
  "max_bid": 10.98,
  "med_bid": 4.98,
  "avg_bid": 6.98,
  "campaign_id": 1059687,
  "campaign_name": "Test campaign",
  "page_domain": "www.example.com"
}

View Publisher Bids report

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

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