View Basic report

Copied

                https://api.ocamba.com/v1/hood/reports/basic

Predefined report that displays essential information such as Event date, Requests, Impressions, Clicks, Total Clicks, CTR, Revenue and more

query Parameters

Name

Description

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/hood/RESOURCE_NAME?sort=name → sorts per name, ascending
GET /VERSION/hood/RESOURCE_NAME?sort=-id → sorts per id descending
GET /VERSION/hood/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

outstring

Data format output - 'csv' (default) or 'json'.

Example: out=json

resolutionstring

Data resoulution, supported values 'hour', 'day'.

Example: resolution=hour

fieldsstringrequired

Fields is array of dimensions and measures. You can use dimensions to categorize, segment, and reveal the details in your data. Measures contain numeric, quantitative values that you can measure. At least one measure is required.

Example: stat_date,container_id,pageviews,new_users,push_allowed,push_blocked

Response status codes

200 - OK

Name

Description

account_idinteger

Dimension
Adex account identifier generated on Ocamba platform.

Example: 968742523

account_namestring

Dimension
Adex account name created on Ocamba platform.

Example: Test account

app_typestring

Dimension
Type of application, it can be web, android, ios or unknown.

Example: web

asninteger

Dimension
The Autonomous System Number.

Example: 15169

body_clickinteger

Measure
The total number of clicks when there are no action buttons.

Example: 10

bounce_ratefloat

Measure
Bounce rate is the percentage of site visits that are single-page sessions.

Example: 12.33

browser_idinteger

Dimension
The identifier 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: 97

button1_clickinteger

Measure
The total number of clicks on first action button.

Example: 10

button2_clickinteger

Measure
The total number of clicks on second action button.

Example: 10

button3_clickinteger

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

Example: 10

city_idinteger

Dimension
The GeoName identifier of the city.

Example: 6354908

city_namestring

Dimension
The name of the city.

Example: Sydney

conn_typestring

Dimension
The type of the connection.

Example: cable/dsl

conn_type_idinteger

Dimension
The identifier 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

container_typestring

Dimension
Type of application, it can be web, android, ios or unknown.

Example: web

country_codestring

Dimension
The code of the geographical country.

Example: RS

country_namestring

Dimension
The name of the geographical country.

Example: Serbia

custom_promptinteger

Measure
Total number of custom windows display a dialog box to prompt user for inputs.

Example: 10

custom_prompt_button1integer

Measure
Total number of cliks on the custom prompt's first button.

Example: 10

custom_prompt_button2integer

Measure
Total number of cliks on the custom prompt's second button.

Example: 10

data_center_prefixstring

Dimension
Data Center Prefix.

Example: am

device_idinteger

Dimension
The identifier of the device.

Example: 5

device_namestring

Dimension
The name of the device.

Example: sony

dialog_declinedinteger

Measure
Total number of declined push prompts.

Example: 10

errorsinteger

Measure
The total number of errors.

Example: 5246

incoming_bandwidthinteger

Measure
The total ammount of outgoing incoming_bandwidth.

Example: 5623186

ispstring

Dimension
Internet Service Provider.

Example: Google

new_usersinteger

Measure
The total number of new users.

Example: 3256

os_idinteger

Dimension
The identifier 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: 10

outgoing_bandwidthinteger

Measure
The total ammount of outgoing outgoing_bandwidth.

Example: 5246872

page_depthfloat

Measure
The ratio of pageviews per sessions.

Example: 3.25

page_domainstring

Dimension
The domain of page url.

Example: test.com

page_ref_domainstring

Dimension
The domain of page referer url.

Example: demo.com

page_ref_urlstring

Dimension
The page referer full url.

Example: demo.com/politics

page_urlstring

Dimension
The page full url.

Example: test.com/sport

pageviewsinteger

Measure
The total number of page views.

Example: 123456

partner_idinteger

Dimension
Adex partner identifier generated on Ocamba platform.

Example: 968742523

partner_namestring

Dimension
Adex partner name created on Ocamba platform.

Example: Test account

push_allowedinteger

Measure
The total number of allowed push subscriptions.

Example: 574125

push_allowed_ctrfloat

Measure
The rate of push allowed to push prompt.

Example: 15.31

push_allowed_thru_pctfloat

Measure
The rate of push allowed to push prompt with percentage.

Example: 10.36

push_blockedinteger

Measure
The total number of blocked push subscriptions.

Example: 32485

push_click_thru_pctfloat

Measure
The rate of clicks to wokenups with percentage.

Example: 17.11

push_clicksinteger

Measure
The total number of push clicks.

Example: 3214

push_ctrfloat

Measure
The rate of clicks to wokenups.

Example: 12.54

push_promptinteger

Measure
Total number of windows display a dialog box to prompt user for inputs.

Example: 59743

push_subscriptionsinteger

Measure
The total number of push subscriptions.

Example: 23254

push_unsubscriptionsinteger

Measure
The total number of push unsubscriptions.

Example: 3214

push_user_growthinteger

Measure
Growth scale of the user base that represents a ratio between push subscribed and unsubscribed users. A ratio can be negative since there is a possibility that there are more unsubscribed users than subscribed in a particular time range.

Example: 2435

push_wokenupsinteger

Measure
The total number of received push notifications.

Example: 23254

sdk_versionstring

Dimension
SDK version.

Example: 2.0.8

server_traffic_idstring

Dimension
The server traffic identifier.

Example: 2

server_traffic_namestring

Dimension
The server traffic name.

Example: VPN

sessionsinteger

Measure
The total number of sessions.

Example: 325

sessions_per_userfloat

Measure
The ratio of sessions per users.

Example: 3.25

stat_datedateTime

Dimension
The day of the event.

Example: 2021-12-27

tag_idinteger

Dimension
Unique tag identifier generated on Ocamba platform.

Example: 126598752

tag_namestring

Dimension
Tag name created on Ocamba platform.

Example: test.demo.com

tag_typestring

Dimension
Type of application, it can be web, android, ios or unknown.

Example: web

timezonestring

Dimension
Timezone.

Example: Europe/Belgrade

traffic_source_type_idinteger

Dimension
The unique identifier representing traffic source that is driving visitor to your website.

Possible values: 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8

traffic_source_type_namestring

user_langstring

Dimension
The language of the user.

Example: en

usersinteger

Measure
The total number of users.

Example: 201

utm_campaignstring

Dimension
Urchin Tracking Module campaign, used to identify a strategic campaign.

Example: push_campaign

utm_contentstring

Dimension
Urchin Tracking Module content, used to differentiate ads or links that point to the same URL.

Example: logolink

utm_mediumstring

Dimension
Urchin Tracking Module medium, used to identify a medium.

Example: organic

utm_sourcestring

Dimension
Urchin Tracking Module source, used to identify a search engine, social media, newsletter name or other source.

Example: google

utm_termstring

Dimension
Urchin Tracking Module term, used to note the keywords for the ad.

Example: testing+term

views_per_userfloat

Measure
The ratio of pageviews per users.

Example: 2.33

tip

1 Sortable fields are: stat_date, account_id, account_name, partner_id, partner_name, country_code, country_name, os_name, browser_name, device_name, user_lang, tag_name, container_name, isp, conn_type, city_name, sdk_version, data_center_prefix, app_type, tag_type, container_type, timezone, page_domain, page_ref_domain, utm_medium, utm_campaign, utm_term, utm_source, traffic_source_type_name, pageviews, new_users, push_allowed, push_blocked, errors, sessions, users, views_per_user, sessions_per_user, bounce_rate, push_user_growth, push_wokenups, push_clicks, push_subscriptions, push_unsubscriptions, push_allowed_ctr, push_allowed_thru_pct, body_click, button1_click, button2_click, button3_click, dialog_declined, custom_prompt, custom_prompt_button1 and custom_prompt_button2.

2 Filterable fields are: stat_date, browser_id, browser_name, os_id, os_name, country_code, country_name, device_id, device_name, asn, isp, city_id, city_name, user_lang, account_id, account_name, partner_id, partner_name, timezone, data_center_prefix, sdk_version, tag_id, tag_name, container_id, container_name, page_url, page_ref_url, page_domain, page_ref_domain, os_version, browser_version, utm_medium, utm_campaign, utm_term, utm_content, utm_source, traffic_source_type_id, traffic_source_type_name, server_traffic_id, server_traffic_name, region, region_name, app_type, tag_type, container_type, conn_type, push_allowed, push_blocked, pageviews, new_users, errors, incoming_bandwidth, outgoing_bandwidth, sessions, users, push_prompt, page_depth, views_per_user, sessions_per_user, bounce_rate, push_wokenups, push_clicks, push_ctr, push_clicks, push_subscriptions, push_unsubscriptions, push_allowed_ctr, push_allowed_thru_pct, body_click, button1_click, button2_click, button3_click, dialog_declined custom_prompt, custom_prompt_button1 and custom_prompt_button2.

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

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

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 stat_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

[
  {
    "push_allowed": 9563,
    "stat_date": "2021-12-29T00:00:00Z"
  },
  {
    "push_allowed": 9563,
    "stat_date": "2021-12-29T00:00:00Z"
  }
]

{
  "stat_date": "2021-12-27",
  "tag_id": 126598752,
  "tag_name": "test.demo.com",
  "container_id": 126598752,
  "container_name": "test.demo.com",
  "account_id": 968742523,
  "account_name": "Test account",
  "partner_id": 968742523,
  "partner_name": "Test account",
  "page_url": "test.com/sport",
  "page_domain": "test.com",
  "page_ref_url": "demo.com/politics",
  "page_ref_domain": "demo.com",
  "country_code": "RS",
  "country_name": "Serbia",
  "browser_id": 10,
  "browser_name": "Chrome",
  "browser_version": 97,
  "os_id": 12,
  "os_name": "Android",
  "os_version": 10,
  "device_id": 5,
  "device_name": "sony",
  "user_lang": "en",
  "sdk_version": "2.0.8",
  "data_center_prefix": "am",
  "app_type": "web",
  "tag_type": "web",
  "container_type": "web",
  "timezone": "Europe/Belgrade",
  "conn_type_id": 2,
  "conn_type": "cable/dsl",
  "asn": 15169,
  "isp": "Google",
  "city_id": 6354908,
  "city_name": "Sydney",
  "traffic_source_type_name": "Direct",
  "utm_source": "google",
  "utm_medium": "organic",
  "utm_campaign": "push_campaign",
  "utm_content": "logolink",
  "utm_term": "testing+term",
  "server_traffic_id": "2",
  "server_traffic_name": "VPN",
  "sessions": 325,
  "sessions_per_user": 3.25,
  "views_per_user": 2.33,
  "page_depth": 3.25,
  "users": 201,
  "bounce_rate": 12.33,
  "pageviews": 123456,
  "new_users": 3256,
  "push_allowed": 574125,
  "push_blocked": 32485,
  "errors": 5246,
  "incoming_bandwidth": 5623186,
  "outgoing_bandwidth": 5246872,
  "push_prompt": 59743,
  "push_wokenups": 23254,
  "push_clicks": 3214,
  "push_subscriptions": 23254,
  "push_unsubscriptions": 3214,
  "push_user_growth": 2435,
  "push_ctr": 12.54,
  "push_click_thru_pct": 17.11,
  "push_allowed_ctr": 15.31,
  "push_allowed_thru_pct": 10.36,
  "body_click": 10,
  "button1_click": 10,
  "button2_click": 10,
  "button3_click": 10,
  "dialog_declined": 10,
  "custom_prompt": 10,
  "custom_prompt_button1": 10,
  "custom_prompt_button2": 10
}

View Basic report

GET /reports/basicCopied https://api.ocamba.com/v1/hood/reports/basic

GET /reports/basic
Copied
`https://api.ocamba.com/v1/hood/reports/basic`