View External-demand report

Copied

                https://api.ocamba.com/v2/adex/reports/external-demand

Obtains report on External demand

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

resolutionstring

This parameter additionally defines the stat_date parameter. You should pass day or hour, which defines what type of breakdown you request, default setup displays daily breakdown. If day is passed, the report displays stats for specific range by days. If hour is passed, the report displays stats for specific range by hour. If you pass the stat_date in the hour format and request the daily resolution, the stat_date will have priority over the resolution.

outstring

You can request JSON formatted response. Set the `out` parameter value to json.

Example: out=json

stat_datestring

The request time.
expected format for date is "YYYY-MM-DD", example "2021-12-27"
expected format for date time is "YYYY-MM-DD HH:SS", example "2022-12-23 01:00"

Example: rf:2022-02-10,2022-02-15

exchange_idinteger

Unique exchange identifier generated by Ocamba.

Example: 936

partner_idinteger

Unique partner identifier generated by Ocamba.

Example: 56

subidstring

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

Example: source_example

os_idinteger

Unique operating system identifier.

Example: 12

browser_idinteger

Unique browser identifier.

Example: 10

country_codestring

Two letter country code.

Example: US

device_idinteger

Unique device identifier.

Example: 6

http_status_codeinteger

HTTP response status codes.

Example: 204

servedinteger

The total number of ads back in respons.

Example: 5

error_codeinteger

error codes.

Example: 110

keywordstring

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

Example: wine

hood_tag_idinteger

Ocamba unique hood tag id, usually only available in push traffic.

hood_tag_namestring

User provided name for hood tag, usually only available in push traffic.

container_idinteger

Ocamba unique hood container id, usually only available in push traffic.

container_namestring

User provided name for hood container, usually only available in push traffic.

page_domainstring

Domain of page where ad should be placed.

campaign_idinteger

Unique campaign identifier generated by Ocamba.

Example: 1044852

zone_idinteger

Unique zone identifier generated by Ocamba.

Example: 1009638

successinteger

The total number of requests which successfully returned an ad.

Example: 22674

failedinteger

The total number of requests which failed to return a valid ad.

Example: 135

impressioninteger

The total number of impressions.

Example: 15268

total_clickinteger

The total number of clicks, including spam clicks.

Example: 1656

spam_clickinteger

The total number of spam clicks.

Example: 94

clickinteger

The total number of valid clicks.

Example: 1562

conversioninteger

The total number of conversions.

Example: 12

incomefloat

The total income.

Example: 16.52

expensefloat

The total expense.

Example: 1.33

revenuefloat

The total earnings, the difference between income and expense.

Example: 0.98

min_bidfloat

The minimal bid.

Example: 10.19

max_bidfloat

The maximal bid.

Example: 15.19

avg_bidfloat

The average bid.

Example: 6.19

med_bidfloat

The median bid.

Example: 4.3

med_bid_exactfloat

The exact median bid measure.

Example: 4.3

ads_countinteger

The total number of ads.

Example: 12

calls_countinteger

The total number of calls.

Example: 7

Response status codes

200 - OK

Name

Description

ads_countinteger

Measure
The total number of ads.

Example: 30

avg_bidfloat

Measure
The average bid.

Example: 6.98

browser_idinteger

Dimension
Unique browser identifier.

Example: 10

browser_namestring

Dimension
The browser name.

Example: Chrome

calls_countinteger

Measure
The total number of calls.

Example: 17

campaign_idinteger

Dimension
Unique campaign identifier generated by Ocamba.

Example: 1044852

campaign_namestring

Dimension
The campaign name.

Example: Test campaign

clickinteger

Measure
The total number of valid clicks.

Example: 1562

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

country_codestring

Dimension
Two letter country code.

Example: RS

country_namestring

Dimension
The name of country.

Example: Serbia

ctrfloat

Measure
The rate of clicks to impressions.

Example: 10.84

device_idinteger

Dimension
Unique device identifier.

Example: 6

device_namestring

Dimension
The device name.

Example: Huawei

error_codestring

Dimension
Error codes.

Example: 110

error_descstring

Dimension
Error description.

Example: Connection timed out

exchange_idinteger

Dimension
Unique exchange identifier generated by Ocamba.

Example: 1258

exchange_namestring

Dimension
The exchange name.

Example: First test exchange #1

expensefloat

Measure
The total expense.

Example: 12.98

failedinteger

Measure
The total number of requests which failed to return a valid ad.

Example: 135

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

http_reasonstring

Dimension
HTTP reason.

Example: No Content

http_status_codestring

Dimension
HTTP response status codes.

Example: 204

impressioninteger

Measure
The total number of impressions.

Example: 15268

incomefloat

Measure
The total income.

Example: 125.65

keywordstring

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

Example: affiliate

max_bidfloat

Measure
The maximal bid.

Example: 10.98

med_bidfloat

Measure
The median bid.

Example: 4.98

med_bid_exactfloat

Measure
The exact median bid.

Example: 4.98

min_bidfloat

Measure
The minimal bid.

Example: 0.98

os_idinteger

Dimension
Unique operating system identifier.

Example: 12

os_namestring

Dimension
The operating system name.

Example: Android

page_domainstring

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

Example: www.example.com

partner_idinteger

Dimension
Unique partner identifier generated by Ocamba.

Example: 16

partner_namestring

Dimension
The partner name.

Example: Zeropark

revenuefloat

Measure
The total revenue.

Example: 187.02

servedinteger

Dimension
served.

Example: 5

spam_clickinteger

Measure
The total number of spam clicks.

Example: 94

stat_datedateTime

Dimension
The request time.

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

successinteger

Measure
The total number of requests which successfully returned an ad.

Example: 22674

total_clickinteger

Measure
The total number of clicks, including spam clicks.

Example: 1656

zone_idinteger

Dimension
Unique zone identifier generated by Ocamba.

Example: 1029607

zone_namestring

Dimension
The zone name.

Example: Push zone

tip

1 Sortable fields are: stat_date, exchange_id, exchange_name, partner_id, partner_name, subid, os_id, os_name, browser_id, browser_name, country_code, country_name, device_id, device_name, campaign_id, campaign_name, served, http_status_code, http_reason, error_code, error_desc, keyword, hood_tag_id, hood_tag_name, container_id, container_name, page_domain, zone_id, zone_name, success, failed, impression, total_click, spam_click, click, conversion, income, expense, revenue, ctr, min_bid, max_bid, avg_bid, med_bid, med_bid_exact, ads_count and calls_count.

2 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.

3 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, last-month, current-hour, last-hour, last-48-hours, last-2-days, month-to-date, this-month, 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.

Response examples

Copied

200

[
    {
        "exchange_name": "Adventure testing",
        "http_status_code": "200",
        "http_reason": "OK",
        "browser_name": "Unknown",
        "ads_count": 5
    },
    {
        "exchange_name": "Minaaa testing",
        "http_status_code": "400",
        "http_reason": "Bad Request",
        "browser_name": "Unknown",
        "ads_count": 0
    },
    {
        "exchange_name": "Mina Testira",
        "http_status_code": "204",
        "http_reason": "No Content",
        "browser_name": "Unknown",
        "ads_count": 0
    }
]

{
  "stat_date": "2021-12-27",
  "subid": "example_source",
  "campaign_id": 1044852,
  "campaign_name": "Test campaign",
  "exchange_id": 1258,
  "exchange_name": "First test exchange #1",
  "partner_id": 16,
  "partner_name": "Zeropark",
  "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": 6,
  "device_name": "Huawei",
  "http_status_code": "204",
  "http_reason": "No Content",
  "error_code": "110",
  "error_desc": "Connection timed out",
  "served": 5,
  "keyword": "affiliate",
  "hood_tag_id": 126598752,
  "hood_tag_name": "test.demo.com",
  "container_id": 126598752,
  "container_name": "test.demo.com",
  "page_domain": "www.example.com",
  "success": 22674,
  "failed": 135,
  "impression": 15268,
  "total_click": 1656,
  "spam_click": 94,
  "click": 1562,
  "ctr": 10.84,
  "conversion": 12,
  "income": 125.65,
  "expense": 12.98,
  "revenue": 187.02,
  "min_bid": 0.98,
  "max_bid": 10.98,
  "med_bid": 4.98,
  "med_bid_exact": 4.98,
  "avg_bid": 6.98,
  "ads_count": 30,
  "calls_count": 17
}

View External-demand report

GET /reports/external-demandCopied https://api.ocamba.com/v2/adex/reports/external-demand

GET /reports/external-demand
Copied
`https://api.ocamba.com/v2/adex/reports/external-demand`