View Push-click report

GET /reports/push-click
Copied
Arrow
                https://api.ocamba.com/v1/hood/reports/push-click

Obtain various Push-click reports

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
Response status codes
Arrow
200 - OK
Arrow
Name
Description
app_typestring
Dimension
Type of application, it can be web, android, ios, safari or unknown.


Example: web
asninteger
The Autonomous System Number.


Example: 15169
browser_idinteger
The id of the browser.


Example: 10
browser_namestring
The name of the browser.


Example: Chrome
browser_versionstring
The browser version.


Example: 74
button_positioninteger
Dimension
The position of action buttons.
Examples:
button_position=0 -> There are no action buttons set.
button_position=1 -> The position of the first action button.
button_position=2 -> The position of the second action button.
button_position=3 -> The position of the third action button (only for Android and iOS).


Example: 1
city_idinteger
The GeoName ID of the city.


Example: 6354908
city_namestring
The name of the city.


Example: Sydney
click_datedateTime
The day of the event.


Example: 2021-12-27
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, safari or unknown.


Example: ios
country_codestring
The code of the geographical country.


Example: RS
country_namestring
The name of the geographical country.


Example: Serbia
data_center_prefixstring
Dimension
Data Center Prefix.


Example: am
delivery_datedateTime
The day of the scheduler execution.


Example: 2021-12-27
lang_codestring
The code of the language.


Example: en
lang_namestring
The name of the language.


Example: English
os_idinteger
The id of the operating system.


Example: 12
os_namestring
The name of the operating system.


Example: Android
os_versionstring
The operating system version.


Example: 10
page_domainstring
The page domain of page url.


Example: test.com
regioninteger
The GeoName ID of the region.


Example: 123984
region_namestring
The name of the region.


Example: Morava
tag_idinteger
Tag id generated on Ocamba platform.


Example: 126598752
tag_namestring
Tag name created on Ocamba platform.


Example: test.demo.com
tag_typestring
Dimension
Type of application, it can be web, android, ios, safari or unknown.


Example: ios
task_idinteger
Push scheduler id generated on Ocamba platform.


Example: 1284472
task_namestring
Push scheduler name created on Ocamba platform.


Example: Monday 15pm
timezonestring
User timezone.


Example: Europe/Istanbul
traffic_idinteger
Push traffic id generated on Ocamba platform.


Example: 1580236
user_agestring
The range user age.


Example: 8-30
user_age_by_hourstring
Dimension
The range user age by hour.


Example: 17
user_country_codestring
Dimension
The code of the geographical country.


Example: RS
user_idinteger
Push user id generated on Ocamba platform.


Example: 1284472
user_ipv4string
Dimension
The Internet Protocol version 4 address.


Example: 37.8.65.98
user_ipv6string
Dimension
The Internet Protocol version 6 address.


Example: 2001:0db8:85a3:0000:0000:8a2e:0370:7334
user_langstring
Dimension
The user language.


Example: en
utm_sourcestring
The source from utm on subscription.


Example: january-31-12-ab

tip
1 Sortable fields are: click_date, task_name, tag_id, tag_name, container_id, container_name, country_code, country_name, delivery_date, timezone, city_name, os_name, os_version, browser_name, browser_version, utm_source, lang_code, lang_name, app_type, tag_type, container_type, asn, region_name, user_age, data_center_prefix, user_country_code, user_lang, user_age_by_hour and button_position.
2 Filterable fields are: click_date, user_id, task_id, tag_id, container_id, container_name, traffic_id, country_code, delivery_date, timezone, city_id, os_id, os_version, browser_id, browser_version, utm_source, lang_code, app_type, tag_type, container_type, asn, region, page_domain, data_center_prefix, user_country_code, user_lang, user_age_by_hour, button_position, task_name, tag_name, country_name, city_name, os_name, browser_name, lang_name and region_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, current-hour, last-hour, last-48-hours, last-2-days, month-to-date, month-to-yesterday, quarter-to-date.
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
Arrow
200 Arrow
  • 200
  • 200
[
   {
       "user_id": "16620399588724816447",
       "app_type": "web",
       "asn": "203512",
       "region": "7581800",
       "region_name": "Morava",
       "user_age": "8-30"
   }
 ]

{
  "click_date": "2021-12-27",
  "user_id": 1284472,
  "task_id": 1284472,
  "task_name": "Monday 15pm",
  "tag_id": 126598752,
  "tag_name": "test.demo.com",
  "container_id": 126598752,
  "container_name": "test.demo.com",
  "traffic_id": 1580236,
  "country_code": "RS",
  "country_name": "Serbia",
  "page_domain": "test.com",
  "delivery_date": "2021-12-27",
  "timezone": "Europe/Istanbul",
  "city_id": 6354908,
  "city_name": "Sydney",
  "os_id": 12,
  "os_name": "Android",
  "os_version": "10",
  "browser_id": 10,
  "browser_name": "Chrome",
  "browser_version": "74",
  "utm_source": "january-31-12-ab",
  "lang_code": "en",
  "lang_name": "English",
  "app_type": "web",
  "tag_type": "ios",
  "container_type": "ios",
  "asn": 15169,
  "region": 123984,
  "region_name": "Morava",
  "user_age": "8-30",
  "data_center_prefix": "am",
  "user_ipv4": "37.8.65.98",
  "user_ipv6": "2001:0db8:85a3:0000:0000:8a2e:0370:7334",
  "user_country_code": "RS",
  "user_lang": "en",
  "user_age_by_hour": "17",
  "button_position": 1
}