View Push-click report
View Push-click report
Rate limits:
- Burst: 10/s
- Steady: 150/m
Query parameters
parametersResponse schemas
curl -X GET \
"https://api.ocamba.com/v1/hood/reports/push-click" \
-H "Authorization: Bearer {TOKEN}"
const url = 'https://api.ocamba.com/v1/hood/reports/push-click';
const options = {
method: 'GET',
headers: {
Authorization: `Bearer {TOKEN}`
}
};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
$ch = curl_init("https://api.ocamba.com/v1/hood/reports/push-click");
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "GET");
curl_setopt($ch, CURLOPT_HTTPHEADER, [
"Authorization: Bearer {TOKEN}"
]);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$response = curl_exec($ch);
Responses
200 OK
[
{
"user_id": "16620399588724816447",
"app_type": "web",
"asn": "203512",
"region": "7581800",
"region_name": "Morava",
"profile_age": "8-30"
}
]
400 Bad Request
{
"code": 400,
"title": "Bad request.",
"message": "The request body is not valid.",
"trace_id": "99a84211-f73d-4ff8-acdf-eb3e06bb9d62"
}
500 Internal Server Error
{
"code": 500,
"title": "Internal server error.",
"trace_id": "99a84211-f73d-4ff8-acdf-eb3e06bb9d62"
}
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, profile_id, profile_age, profile_age_by_hour, profile_lang, profile_country_code.
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, profile_id, profile_age, profile_age_by_hour, profile_lang, profile_country_code.
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.
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.
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.
- r - range - The value must be in a specified open range, where both endpoints are excluded.
- 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.