View Click report

Copied

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

Obtain various reports on clicks

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

click_datestring

The date of the click.

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

user_idinteger

Unique user identifier generated by Ocamba.

Example: 1008819

zone_idinteger

Unique zone identifier generated by Ocamba.

Example: 1009638

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

campaign_idinteger

Unique campaign identifier generated by Ocamba.

Example: 1044852

creative_idinteger

Unique creative identifier generated by Ocamba.

Example: 1000223

country_codestring

Two letter country code.

Example: US

spaminteger

Filtering spam and valid clicks. Possible values are 0 (valid click) and 1 (spam click).

Example: 1

task_idinteger

Unique task identifier generated by Ocamba. Use this filter only in case of webpush click.

Example: 25845698

city_idinteger

Unique GeoName identifier of the city.

Example: 6354908

asninteger

The Autonomous System Number.

Example: 15169

conn_type_idinteger

Unique connection type identifier. Possible values are 1 (dialup), 2 (cable/dsl), 3 (corporate) and 4 (cellular).

Example: 4

user_data_kvstring

Custom key-value map provided by requestor.

Example: ud_tpclk=example

keywordstring

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

Example: mainstream

ssp_iab_idstring

Unique ssp IAB identifier.

Example: IAB1-3

dsp_iab_idstring

Unique dsp IAB identifier.

Example: IAB1-1

page_domainstring

The domain of page url.

Example: example.com

page_urlstring

The page full url.

Example: https://example.net/sport

cta_positioninteger

The position of call to actions.
Examples:
cta_position=0 -> Default call to action position.
cta_poistion=1 -> The position of the first call to action.
cta_position=2 -> The position of the second call to action.
cta_position=3 -> The position of the third call to action (only for Android and iOS).

Example: 1

campaign_algo_idinteger

Unique campaign algorithm identifier.

Example: 1

campaign_algo_nameinteger

The campaign algorithm name.

Example: Round_robin

Response status codes

200 - OK

Name

Description

asninteger

Dimension
The Autonomous System Number.

Example: 15169

automation_idinteger

Dimension
The EBS Automation id generated on ocamba platform.

Example: 1029607

automation_namestring

Dimension
The EBS Automation name created on ocamba platform.

Example: New Ebs Automation

bid_datedateTime

Dimension
The date of the bid request.

Example: 2021-12-27 02:05:12

browser_idinteger

Dimension
Unique browser identifier.

Example: 10

browser_namestring

Dimension
The browser name.

Example: Chrome

campaign_algo_idinteger

Dimension
Unique campaign algorithm identifier.

Example: 1

campaign_algo_namestring

Dimension
The campaign algorithm name.

Example: Round-robin

campaign_idinteger

Dimension
Unique campaign identifier generated by Ocamba.

Example: 1044852

campaign_namestring

Dimension
The campaign name.

Example: Test campaign

city_idinteger

Dimension
Unique GeoName identifier of the city.

Example: 6354908

city_namestring

Dimension
The name of the city.

Example: Sydney

click_datedateTime

Dimension
The date of the click.

Example: 2021-12-27

conn_typestring

Dimension
The type of the connection.

Example: cable/dsl

conn_type_idinteger

Dimension
Unique connection type identifier. Possible values are 1 (dialup), 2 (cable/dsl), 3 (corporate) and 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

country_codestring

Dimension
Two letter country code.

Example: RS

country_namestring

Dimension
The name of country.

Example: Serbia

creative_idinteger

Dimension
Unique creative identifier generated by Ocamba.

Example: 1000223

creative_namestring

Dimension
The creative name.

Example: Dynamic native test

cta_positionnumber (integer)

Measure
The position of call to actions.
Examples:
cta_position=0 -> Default call to action position.
cta_poistion=1 -> The position of the first call to action.
cta_position=2 -> The position of the second call to action.
cta_position=3 -> The position of the third call to action (only for Android and iOS).

Example: 1

date_deliverydateTime

Dimension
The delivery date, only in case of webpush click.

Example: 2021-12-25 05:02:17

diffstring

Measure
The click_date and bid_date difference in seconds.

Example: 125

dsp_account_idinteger

Dimension
Unique demand side platform account identifier generated by Ocamba.

Example: 874214212

dsp_account_namestring

Dimension
The demand side platform account name.

Example: Default account

dsp_iab_categoryinteger

Dimension
The dsp IAB category id.

Example: 103

dsp_iab_idstring

Dimension
The dsp IAB id.

Example: IAB1-3

dsp_iab_namestring

Dimension
The dsp IAB category name.

Example: Fine Art

dsp_parent_iab_idstring

Dimension
The dsp parent IAB id.

Example: IAB1

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

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

idstring

Dimension
Unique session identifier.

Example: OaQgQqPvX4I

incomefloat

Measure
The total income.

Example: 125.65

ipv4string

Dimension
The Internet Protocol version 4 address.

Example: 37.8.65.98

ipv6string

Dimension
The Internet Protocol version 6 address.

Example: 2001:0db8:85a3:0000:0000:8a2e:0370:7334

ispstring

Dimension
Internet Service Provider.

Example: Google

keywordstring

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

Example: sport

landing_urlstring

Dimension
The landing url of the click.

Example: www.example.com

os_idinteger

Dimension
Unique operating system identifier.

Example: 12

os_namestring

Dimension
The operating system name.

Example: Android

page_domainstring

Dimension
The domain of page url.

Example: example.net

page_urlstring

Dimension
The page full url.

Example: https://example.net/sport

partner_idinteger

Dimension
Unique partner identifier generated by Ocamba.

Example: 16

partner_namestring

Dimension
The partner name.

Example: Zeropark

placement_idinteger

Dimension
Unique placement identifier.

Example: 32

reasonstring

Dimension
Reason why the click is spam.

Example: double click

request_idinteger

Dimension
Unique request identifier.

Example: 68

revenuefloat

Measure
The total revenue.

Example: 187.02

server_traffic_idstring

Dimension
The server traffic identifier.

Example: 2

server_traffic_namestring

Dimension
The server traffic name.

Example: VPN

spaminteger

Dimension
Internal spam click identifier.

Example: 512

ssp_account_idinteger

Dimension
The supply side platform account identifier generated by Ocamba.

Example: 68745145

ssp_account_namestring

Dimension
The supply side platform account name.

Example: Default account

ssp_iab_categoryinteger

Dimension
The dsp IAB category id.

Example: 201

ssp_iab_idstring

Dimension
The dsp IAB id.

Example: IAB2-1

ssp_iab_namestring

Dimension
The dsp IAB category name.

Example: Auto Parts

ssp_parent_iab_idstring

Dimension
The dsp parent IAB id.

Example: IAB2

subidstring

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

Example: example_source

task_idinteger

Dimension
Unique task identifier generated by Ocamba. Use this filter only in case of webpush click.

Example: 25845698

user_data_kvstring

Dimension
Custom key-value map provided by requestor.

Example: ud_tpclk=example

user_idinteger

Dimension
Unique user identifier generated by Ocamba.

Example: 1008819

visitor_uastring

Dimension
The visitor's user agent.

Example: Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/98.0.4758.102 Safari/537.36 Edg/98.0.1108.62

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: click_date, zone_name, exchange_name, partner_name, hood_tag_id, hood_tag_name, container_id, container_name, subid, os_name, browser_name, campaign_name, creative_name, country_name, ssp_account_name, dsp_account_id, dsp_account_name, isp, conn_type, user_data_kv, city_name, keyword, ssp_iab_category, ssp_parent_iab_id, ssp_iab_name, dsp_iab_category, dsp_parent_iab_id, dsp_iab_name, page_domain, page_url, income, expense, revenue, automation_id, automation_name, cta_position, campaign_algo_id and campaign_algo_name.

2 Filterable fields are: click_date, zone_id, exchange_id, partner_id, subid, os_id, browser_id, campaign_id, creative_id, country_code, spam, user_id, dsp_account_id, hood_tag_id, container_id, task_id, server_traffic_id, region, asn, conn_type_id, user_data_kv, city_id, keyword, ssp_iab_category, ssp_iab_id, dsp_iab_category, dsp_iab_id, page_domain, automation_id, page_url, cta_position, 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 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 click_date, 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

[
   {
       "browser_id": "12",
       "exchange_id": "1",
       "income": 0.008,
       "click_date": "2022-03-03T00:00:00Z"
   },
   {
       "browser_id": "17",
       "exchange_id": "2",
       "income": 0.0008,
       "click_date": "2022-03-03T00:00:00Z"
   },
   {
       "browser_id": "17",
       "exchange_id": "3",
       "income": 0.05094,
       "click_date": "2022-03-03T00:00:00Z"
   },
   {
       "browser_id": "17",
       "exchange_id": "4",
       "income": 0.0462,
       "click_date": "2022-03-03T00:00:00Z"
   },
   {
       "browser_id": "12",
       "exchange_id": "5",
       "income": 0.002,
       "click_date": "2022-03-03T00:00:00Z"
   }
 ]

{
  "click_date": "2021-12-27",
  "bid_date": "2021-12-27 02:05:12",
  "id": "OaQgQqPvX4I",
  "user_id": 1008819,
  "subid": "example_source",
  "campaign_id": 1044852,
  "campaign_name": "Test campaign",
  "creative_id": 1000223,
  "creative_name": "Dynamic native test",
  "hood_tag_id": 126598752,
  "hood_tag_name": "test.demo.com",
  "container_id": 126598752,
  "container_name": "test.demo.com",
  "dsp_account_id": 874214212,
  "dsp_account_name": "Default account",
  "ssp_account_id": 68745145,
  "ssp_account_name": "Default account",
  "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",
  "conn_type_id": 2,
  "conn_type": "cable/dsl",
  "asn": 15169,
  "isp": "Google",
  "city_id": 6354908,
  "city_name": "Sydney",
  "user_data_kv": "ud_tpclk=example",
  "keyword": "sport",
  "placement_id": 32,
  "request_id": 68,
  "spam": 512,
  "reason": "double click",
  "visitor_ua": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/98.0.4758.102 Safari/537.36 Edg/98.0.1108.62",
  "landing_url": "www.example.com",
  "task_id": 25845698,
  "date_delivery": "2021-12-25 05:02:17",
  "ipv4": "37.8.65.98",
  "ipv6": "2001:0db8:85a3:0000:0000:8a2e:0370:7334",
  "dsp_iab_category": 103,
  "dsp_iab_id": "IAB1-3",
  "dsp_parent_iab_id": "IAB1",
  "dsp_iab_name": "Fine Art",
  "ssp_iab_category": 201,
  "ssp_iab_id": "IAB2-1",
  "ssp_parent_iab_id": "IAB2",
  "ssp_iab_name": "Auto Parts",
  "server_traffic_id": "2",
  "server_traffic_name": "VPN",
  "page_domain": "example.net",
  "page_url": "https://example.net/sport",
  "automation_id": 1029607,
  "automation_name": "New Ebs Automation",
  "diff": "125",
  "campaign_algo_id": 1,
  "campaign_algo_name": "Round-robin",
  "income": 125.65,
  "expense": 12.98,
  "revenue": 187.02,
  "cta_position": 1
}

View Click report

GET /reports/clickCopied https://api.ocamba.com/v2/adex/reports/click

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