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

Rate limits:

Burst: 10/s
Steady: 150/m

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

asninteger

Dimension
Autonomous System Number, derived from the visitor’s IP. This mapping is part of Ocamba and may change over time. See the documentation for current details.

Example: 213725

body_clickinteger

Measure
Number of clicks on the main notification body when no action buttons are used. Typically occurs if users tap the primary content of the push message.

Example: 10

bounce_ratefloat

Measure
Percentage of sessions in which users view only a single page (i.e., no further interactions within the session). This metric is only tracked if analytics is enabled in the container.

Example: 12.33

browser_idinteger

Dimension
Unique identifier assigned by the Ocamba platform for a browser (e.g., 12 = Chrome). This mapping is part of Ocamba and may change over time. See the documentation for current details.

Possible values: 0 | 1 | 3 | 10 | 12 | 13 | 17 | 36 | 54 | 57 | 62 | 69 | 72 | 82 | 83 | 87 | 88

browser_namestring

browser_versioninteger

Dimension
Major version of the browser, extracted from the complete version string major.minor.patch.build (e.g., "133.0.6943.142" → 133).

Example: 133

button1_clickinteger

Measure
Number of clicks on the first action button of a push notification.

Example: 10

button2_clickinteger

Measure
Number of clicks on the second action button of a push notification.

Example: 10

button3_clickinteger

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

Example: 10

city_idinteger

Dimension
GeoName city identifier, derived from the visitor’s IP. This mapping is part of Ocamba and may change over time. See the documentation for current details.

Example: 6354908

city_namestring

Dimension
City name mathcing corresponding city_id. This mapping is part of Ocamba and may change over time. See the documentation for current details.

Example: Sydney

conn_typestring

Dimension
Name corresponding to the conn_type_id. This mapping is part of Ocamba and may change over time. See the documentation for current details.

Possible values: dialup | cable/dsl | corporate | cellular

conn_type_idinteger

Dimension
Connection type identifier from the visitor’s IP (e.g., 1 = dialup, 2 = cable/dsl). This mapping is part of Ocamba and may change over time. See the documentation for current details.

Possible values: 1 | 2 | 3 | 4

container_idinteger

Dimension
Unique identifier assigned by the HoodEngage app for a container resource. A container is an editable resource that centralizes settings for push notifications, analytics, crash reporting, user consent, and various lead-generation features (e.g., newsletter or SMS pop-ups). These changes are applied upon the next user session or SDK run.

Example: 126598752

container_namestring

Dimension
The name given by the user when creating a container..

Example: BBC Network US

container_typestring

Dimension
Indicates the platform or environment for the container resource. Type is not editable.

Possible values:
- web: The container is configured for websites
- android: The container is configured for Android apps
- ios: The container is configured for iOS apps
- unknown: The container environment was not recognized or cannot be determined

Possible values: unknown | web | android | ios

country_codestring

Dimension
Two-letter country code, typically derived from the visitor’s IP address (ISO 3166-1 alpha-2 codes).

Example: US

country_namestring

Dimension
Official country name derived from country_code.

Example: United States

custom_promptinteger

Measure
Number of times a custom prompt was shown to the user. Examples include push slide prompt, notification bell.

Example: 10

custom_prompt_button1integer

Measure
Number of clicks on the primary button in a custom prompt window.

Example: 10

custom_prompt_button2integer

Measure
Number of clicks on the secondary button in a custom prompt window.

Example: 10

data_center_prefixstring

Dimension
Prefix of the nearest Ocamba data center where data was collected.

Possible values: pa | am | ny | sg

device_idinteger

Dimension
Unique identifier assigned by the Ocamba platform for a device. This mapping is part of Ocamba and may change over time. See the documentation for current details.

Possible values: 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15

device_namestring

dialog_declinedinteger

Measure
Number of times a user declined a custom window prompt.

Example: 10

errorsinteger

Measure
Total reported error events from HoodEngage SDK (web or mobile).

Example: 5246

incoming_bandwidthinteger

Measure
Total inbound bandwidth usage, measured in bytes.

Example: 5623186

ispstring

Dimension
Internet Service Provider name, derived from the visitor’s IP. This mapping is part of Ocamba and may change over time. See the documentation for current details.

Example: Octopus Web Solution

new_usersinteger

Measure
Total count of*uniqu new users, i.e., first-time visitors. This metric is only tracked if analytics is enabled in the container.

Example: 3256

os_idinteger

Dimension
Unique identifier assigned by the Ocamba platform for an operating system. This mapping is part of Ocamba and may change over time. See the documentation for current details.

Possible values: 0 | 1 | 4 | 10 | 12 | 14 | 17 | 18 | 26 | 40 | 1000

os_namestring

os_versioninteger

Dimension
Major version of the operating system, extracted from the full OS version string. For example, “Windows 11.0.12345” → 11 or “macOS Sequoia 15.3.1” → 15.

Example: 10

outgoing_bandwidthinteger

Measure
Total outbound bandwidth usage, measured in bytes.

Example: 5246872

page_depthfloat

Measure
Average pageviews per session, calculated as (pageviews / sessions). This metric is only tracked if analytics is enabled in the container. A higher page depth indicates that users tend to view multiple pages within a single session.

Example: 3.25

page_domainstring

Dimension
Domain of the viewed page.

Example: test.com

page_ref_domainstring

Dimension
Domain of the referrer page.

Example: demo.com

page_ref_urlstring

Dimension
Full URL of the page's referer.

Example: https:/demo.com/politics

page_urlstring

Dimension
Full URL of the viewed page.

Example: https://test.com/sport

pageviewsinteger

Measure
The total number of page views.

Example: 123456

partner_idinteger

Dimension
Unique identifier assigned by the HoodEngage app for a partner. A partner can be an advertiser, publisher, or both, and typically represents a business, brand, or organization within the HoodEngage ecosystem. Partners can have multiple managers, each with their own account and permissions, and may oversee multiple containers or applications.

Example: 968742523

partner_namestring

Dimension
The user-defined name for a HoodEngage partner entity. A partner can be an advertiser, publisher, or both, and typically represents a business, brand, or organization within the HoodEngage ecosystem. Partners can have multiple managers, each with their own account and permissions, and may oversee multiple containers or applications.

Example: Ikea Sweden

push_allowedinteger

Measure
Number of times a user accepted the native push notification prompt.

Example: 574125

push_allowed_ctrfloat

Measure
Ratio of push allowed to push prompt events (push_allowed / push_prompt).

Example: 15.31

push_allowed_thru_pctfloat

Measure
Percentage of push allowed out of push_ rompt (push_allowed_ctr × 100).

Example: 10.36

push_blockedinteger

Measure
Number of times a user declined or blocked the native push notification prompt.

Example: 32485

push_click_thru_pctfloat

Measure
Percentage of push notification clicks out of all push_wokenups (push_ctr × 100).

Example: 17.11

push_clicksinteger

Measure
Total clicks on push notifications, including body and action buttons.

Example: 3214

push_ctrfloat

Measure
Ratio of push notification clicks to push wokenups (push_clicks / push_wokenups).

Example: 12.54

push_promptinteger

Measure
Number of times the native push notification prompt was displayed to the user.

Example: 59743

push_subscriptionsinteger

Measure
Total number of successful new push subscriptions. Unlike push_allowed, this only increments once per unique subscription.

Example: 23254

push_unsubscriptionsinteger

Measure
Total number of push unsubscriptions, either user-driven or via platform/API.

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
Number of times the HoodEngage SDK (web or mobile) was activated, indicating a push-capable session was initiated.

Example: 23254

sdk_versionstring

Dimension
Version of the HoodEngage SDK reporting the data, typically in major.minor.patch format (e.g., "2.0.8"). This property is determined directly by the SDK itself—whether it is the Web-based or Mobile version—and can help pinpoint which specific release is in use for troubleshooting or feature compatibility.

Example: 2.0.8

server_traffic_idstring

Dimension
Unique identifier for the server traffic type, derived from the visitor’s IP. This classification typically flags well-known non-residential IP ranges often tied to bots, scrapers, proxies, or data centers. This mapping is part of Ocamba and may change over time.

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

server_traffic_namestring

sessionsinteger

Measure
Total number of sessions. A session begins when a user first visits and ends after 30 minutes of inactivity. If the user returns more than 30 minutes after their last interaction, it is counted as a new session.

Example: 325

sessions_per_userfloat

Measure
Average sessions per user, calculated as (sessions / users). This metric is only tracked if analytics is enabled in the container. It helps gauge how frequently a typical user initiates a new session and can indicate overall user engagement or repeat visits.

Example: 3.25

stat_datedateTime

Dimension
The date/time for the event.
Resolution may be at the day or hour level:
- Day-level: "2025-03-04T00:00:00Z"
- Hour-level: "2025-03-04T07:00:00Z"

Example: 2025-03-04T07:00:00Z

timezonestring

Dimension
IANA time zone identifier. For more information visit official site https://www.iana.org.

Example: Europe/Belgrade

traffic_source_type_idinteger

Dimension
Unique identifier assigned by the Ocamba platform for a traffic source (e.g., 1 = direct, 2 = internal). This mapping is part of Ocamba and may change over time. See the documentation for current details.

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

traffic_source_type_namestring

Dimension
The traffic sources that are driving visitor to your website.
Possible values:
- direct: The user typed in the URL or used a bookmark (no referrer data).
- internal: The user navigated from another page on the same domain.
- link: The user clicked a link from an external domain that is neither social nor a search engine.
- social network: The user arrived via a recognized social network.
- search engine: The user arrived from a recognized search engine.
- paid: The user came from a known paid advertising source.
- unknown or undefined: Insufficient data to classify the traffic.
- other: A valid source that does not fit any of the standard categories above.
The unique identifier representing traffic source that is driving visitor to your website. See the documentation for current details.

Possible values: unknown | direct | internal | link | social network | search engine | paid | undefined | other

user_langstring

Dimension
Two-letter language code for the user (ISO 639-1 alpha-2 codes).

Example: en,de,es

usersinteger

Measure
Total count of unique users. This metric is only tracked if analytics is enabled in the container.

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
Average pageviews per user, calculated as (pageviews / users). This is only tracked if analytics is enabled in the container. A higher ratio can indicate deeper user engagement with the site.

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": "2025-03-04T07:00:00Z",
  "container_id": 126598752,
  "container_name": "BBC Network US",
  "partner_id": 968742523,
  "partner_name": "Ikea Sweden",
  "page_url": "https://test.com/sport",
  "page_domain": "test.com",
  "page_ref_url": "https:/demo.com/politics",
  "page_ref_domain": "demo.com",
  "country_code": "US",
  "country_name": "United States",
  "browser_version": 133,
  "os_version": 10,
  "user_lang": "en,de,es",
  "sdk_version": "2.0.8",
  "timezone": "Europe/Belgrade",
  "asn": 213725,
  "isp": "Octopus Web Solution",
  "city_id": 6354908,
  "city_name": "Sydney",
  "utm_source": "google",
  "utm_medium": "organic",
  "utm_campaign": "push_campaign",
  "utm_content": "logolink",
  "utm_term": "testing+term",
  "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`