View Stats report

GET /reports/stats
Copied
Arrow
                https://api.ocamba.com/v1/hood/reports/stats

Stats provides reports on various reporting data parameters

query Parameters
Arrow
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
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: active
Response status codes
Arrow
200 - OK
Arrow
Name
Description
activeinteger
Measure
Total number of active users


Example: 5246872
ad_clicksinteger
Measure
Number of times user has clicked.


Example: 10
ad_impressionsinteger
Measure
Number of times user has viewed an ad.


Example: 1063
ad_last_clickeddateTime
Dimension
Timezone: GMT.


Example: 2022-03-20 20:45:11
ad_last_impressiondateTime
Dimension
Timezone: GMT.


Example: 2022-03-20 20:45:11
ad_last_serveddateTime
Dimension
Timezone: GMT.


Example: 2022-03-20 20:45:11
ad_servedinteger
Measure
Number of times user has received an ad.


Example: 89
ad_spam_clicksinteger
Number of times user has made a spam click.


Example: 0
app_namestring
Dimension
Hood application name created on Ocamba platform.


Example: delsystems.net
browser_idstring
Dimension
The id of the browser.


Example: 10
browser_namestring
Dimension
The name of the browser.


Example: Chrome
client_idstring
Dimension
A unique identifier generated by the Ocamba platform.


Example: 17232323230987654321
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
first_session_datedate
Dimension



Example: 2022-01-13
lang_codestring
Dimension
The code of the user language.


Example: en
lang_namestring
Dimension
The name of the user language.


Example: English
os_idstring
Dimension
The id of the operating system.


Example: 12
os_namestring
Dimension
The name of the operating system.


Example: Android
push_clicksinteger
Measure
Number of times user clicked on push notification.


Example: 122
push_credentialsobject
Dimension
Credential object.


Example: { "endpoint":"https://fcm.googleapis.com/fcm/send/example" }
push_last_toucheddateTime
Dimension
Timezone: GMT.


Example: 2022-03-20 20:45:11
push_statusstring
Dimension
User status, user can be 0 (inactive), 1 (subscribed) or 2 (unsubscribed).


Example: 1
push_subscription_timedateTime
Dimension
Timezone: GMT.


Example: 2022-03-22 10:17:33
push_subscriptionsinteger
Measure
Total number of subscriptions.


Example: 56
push_unsubscription_timedateTime
Dimension
Timezone: GMT.


Example: 2022-02-17 23:11:00
push_unsubscriptionsinteger
Measure
Total number of unsubscriptions.


Example: 56
push_wokenupsinteger
Measure
Number of times user has received a notification.


Example: 122
retargetingobject
Dimension
Retargeting object.


Example: { "retargeting":"test", "test":"value" }
tag_idstring
Dimension
Tag id created on Ocamba platform.


Example: 126598752
tag_namestring
Dimension
Tag name created on Ocamba platform.


Example: test demo
timezonestring
Dimension
The user timezone.


Example: Europe/Istanbul
total_pageviewsinteger
Measure
Number of pageviews that user has made.


Example: 163
total_sessionsinteger
Measure
Number of sessions that user has made.


Example: 10
tip
1 Sortable fields are: client_id, first_session_date, tag_id, tag_name, container_id, container_name, app_name, push_subscription_time, push_unsubscription_time, push_last_touched, push_credentials, push_status, retargeting, os_id, os_name, browser_id, browser_name, country_code, country_name, timezone, lang_code, lang_name, ad_last_served, ad_last_impression, ad_last_clicked, total_sessions, total_pageviews, push_wokenups, push_clicks, ad_served, ad_impressions, ad_spam_clicks, ad_clicks, push_subscriptions, push_unsubscriptions, active.
2 Filterable fields are: client_id, first_session_date, tag_id, tag_name, container_id, container_name, app_name, push_subscription_time, push_unsubscription_time, push_last_touched, push_credentials, push_status, retargeting, os_id, os_name, browser_id, browser_name, country_code, country_name, timezone, lang_code, lang_name, ad_last_served, ad_last_impression, ad_last_clicked, total_sessions, total_pageviews, push_wokenups, push_clicks, ad_served, ad_impressions, ad_spam_clicks, ad_clicks, push_subscriptions, push_unsubscriptions, active.
Response examples
Copied
Arrow
200 Arrow
  • 200
  • 200
[
   {
     "tag_id": "1303",
      "tag_name": "DS",
      "country_code": "TR",
      "country_name": "Turkey",
      "push_subscriptions": 12,
      "push_unsubscriptions": 3,
      "active": 9
   }
 ]

{
  "tag_id": "126598752",
  "tag_name": "test demo",
  "container_id": 126598752,
  "container_name": "test.demo.com",
  "app_name": "delsystems.net",
  "country_code": "RS",
  "country_name": "Serbia",
  "lang_code": "en",
  "lang_name": "English",
  "browser_id": "10",
  "browser_name": "Chrome",
  "os_id": "12",
  "os_name": "Android",
  "client_id": "17232323230987654321",
  "first_session_date": "2022-01-13",
  "timezone": "Europe/Istanbul",
  "total_sessions": 10,
  "total_pageviews": 163,
  "push_subscription_time": "2022-03-22 10:17:33",
  "push_unsubscription_time": "2022-02-17 23:11:00",
  "push_last_touched": "2022-03-20 20:45:11",
  "ad_last_served": "2022-03-20 20:45:11",
  "ad_last_clicked": "2022-03-20 20:45:11",
  "ad_last_impression": "2022-03-20 20:45:11",
  "push_credentials": "{\n  \"endpoint\":\"https://fcm.googleapis.com/fcm/send/example\"\n}",
  "push_status": "1",
  "push_wokenups": 122,
  "push_clicks": 122,
  "retargeting": "{\n  \"retargeting\":\"test\",\n  \"test\":\"value\"\n}",
  "ad_served": 89,
  "ad_impressions": 1063,
  "ad_spam_clicks": 0,
  "ad_clicks": 10,
  "push_subscriptions": 56,
  "push_unsubscriptions": 56,
  "active": 5246872
}