View Basic report
View Basic report
Query parameters
parametersResponse schemas
curl -X GET \
"https://api.ocamba.com/v0/hood/reports/basic" \
-H "Authorization: Bearer {TOKEN}"
const url = 'https://api.ocamba.com/v0/hood/reports/basic';
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/v0/hood/reports/basic");
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
[
{
"push_allowed": 9563,
"stat_date": "2021-12-29T00:00:00Z"
},
{
"push_allowed": 9563,
"stat_date": "2021-12-29T00:00:00Z"
}
]
400 Bad Request
500 Internal Server Error
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, profile_lang, new_profiles, profiles, views_per_profile, sessions_per_profile, push_user_growth, modal_id, modal_name, ab_test_id, ab_test_name, variation_id, variation_name, modal_views, modal_closes, modal_cta_clicks, modal_click_rate.
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, custom_prompt_button2, profile_lang, new_profiles, profiles, views_per_profile, sessions_per_profile, push_user_growth, modal_id, modal_name, ab_test_id, ab_test_name, variation_id, variation_name, modal_views, modal_closes, modal_cta_clicks, modal_click_rate.
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.
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 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.
- 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.