Stat API: Difference between revisions
No edit summary |
No edit summary |
||
Line 29: | Line 29: | ||
=== Request === | === Request === | ||
No parameters | ''No parameters'' | ||
<!--T:5--> | <!--T:5--> | ||
Line 604: | Line 604: | ||
! Key !! Type !! Description | ! Key !! Type !! Description | ||
|- | |- | ||
| success || Boolean | | success || Boolean || Was the request successful or it failed | ||
|- | |- | ||
|code | | code || Number || Response status code | ||
| | |||
| | |||
|- | |- | ||
|msg | |msg || [String] || Error message | ||
| | |||
| | |||
|- | |- | ||
| colspan="3" |data | | colspan="3" |data | ||
Line 623: | Line 619: | ||
|{ metricTitle: ['''<item>''', …] } | |{ metricTitle: ['''<item>''', …] } | ||
|See bellow description '''<item>''' | |See bellow description '''<item>''' | ||
| | | | ||
|} | |} | ||
Line 637: | Line 630: | ||
|id | |id | ||
|String | |String | ||
|<groupTitle | |<groupTitle or metricTitle> | ||
+ underscore | + underscore | ||
<!--T:6--> | <!--T:6--> | ||
+ <metric or group's name> (groupTitle_id) | + <metric or group's name> (groupTitle_id, for example: lowQuality_total, feature_adBlock) | ||
<!--T:7--> | <!--T:7--> | ||
Line 647: | Line 640: | ||
|icon | |icon | ||
|<code>date</code><nowiki> | </nowiki><code>text</code><nowiki> | </nowiki><code>number</code> | |<code>date</code><nowiki> | </nowiki><code>text</code><nowiki> | </nowiki><code>number</code> | ||
| | |Type of content served | ||
|- | |- | ||
|filterType | |filterType | ||
|<code>range</code><nowiki> | </nowiki><code>list</code><nowiki> | </nowiki><code> | |<code>range</code><nowiki> | </nowiki><code>list</code><nowiki> | </nowiki><code>binary</code> | ||
|See description filterType | |See bellow description '''<filterType>''' | ||
|- | |- | ||
|filterSync | |filterSync | ||
Line 698: | Line 687: | ||
|String | |String | ||
|Search query | |Search query | ||
|- | |||
|dateFrom | |||
|String | |||
|What date should we start searching? Date in the format Y-m-d. | |||
|- | |||
|dateTo | |||
|String | |||
|Until what date should we continue searching?? Date in the format Y-m-d. | |||
|- | |||
|cancellable | |||
|Boolean | |||
|''deprecated'' | |||
|} | |} | ||
Line 811: | Line 812: | ||
!Description | !Description | ||
|- | |- | ||
|success | | success || Boolean || Was the request successful or it failed | ||
|Boolean | |||
| | |||
|- | |- | ||
|code | | code || Number || Response status code | ||
| | |||
| | |||
|- | |- | ||
|msg | |msg || [String] || Error message | ||
| | |||
| | |||
|- | |- | ||
| colspan="3" |data | | colspan="3" |data | ||
Line 844: | Line 839: | ||
<pre class="mw-collapsible-content"> | <pre class="mw-collapsible-content"> | ||
{ | { | ||
"id":null, | "id":null, | ||
"name":null, | "name":null, | ||
"perPage":50, | |||
"groups":[ | "groups":[ | ||
"time_day", | "time_day", | ||
Line 881: | Line 876: | ||
|id | |id | ||
|String | |String | ||
| | |Optional parameter | ||
|- | |- | ||
|name | |name | ||
|String | |String | ||
| | |Optional parameter | ||
|- | |- | ||
|perPage | |perPage | ||
|Number | |Number | ||
|Default value 50 | |Number of lines shown simultaneously. Default value is 50. | ||
|- | |- | ||
|page | |page | ||
|Number | |Number | ||
|Default value 1 | |Current page number. Default value is 1. | ||
|- | |||
|groups | |||
|[String] | |||
|'''Allowed values:''' | |||
time_hour, time_day, time_week, time_month, time_dateTime, sub_integration, sub_botType, sub_referer, sub_1, sub_2, sib_3, sub_4, sub_5, sub_6, sub_7, geo_language, geo_timezone, geo_country, geo_city, geo_provider, device_browser, device_browserEngine, device_os, device_realOs, device_device, device_type, device_connectionType, device_useragent, screen_width, screen_height, screen_orientation, screen_pixelDensity | |||
'''Full list of metrics you can get with this [[#How_to_get_all_possible_groupings_and_metrics|URL]].''' | |||
|- | |- | ||
|metrics | |metrics | ||
Line 904: | Line 906: | ||
| colspan="3" |filters | | colspan="3" |filters | ||
|- | |- | ||
|dateFrom | |filters.dateFrom | ||
|String | |String | ||
|Date in the format Y-m-d. If you specify a period, dateFrom will not work. The period has high priority. | |Date in the format Y-m-d. If you specify a period, dateFrom will not work. The period has high priority. | ||
|- | |- | ||
|dateTo | |filters.dateTo | ||
|String | |String | ||
|Date in the format Y-m-d. If you specify a period, dateTo will not work. The period has high priority. | |Date in the format Y-m-d. If you specify a period, dateTo will not work. The period has high priority. | ||
|- | |- | ||
|filters. | |filters.period | ||
|<nowiki>today | yesterday | currentWeek | 7days| month | null</nowiki> | |<nowiki>today | yesterday | currentWeek | 7days| month | null</nowiki> | ||
|If you specify a period, dateFrom and dateTo will not work. The period has high priority | |If you specify a period, dateFrom and dateTo will not work. The period has high priority | ||
|- | |- | ||
|timezone | |filters.timezone | ||
|Number | |Number | ||
|From -12 to +12 | |From -12 to +12. Default value is 0, which means that the data will be output in UTC. | ||
|- | |- | ||
| | |filters.filters | ||
|[ | |['''<filters>'''] | ||
|See bellow description '''<filters>''' | |||
''' | |||
|- | |- | ||
|compare | |compare | ||
|'''<compare>''' | |'''<compare>''' | ||
| | |See bellow description '''<compare>''' | ||
|} | |} | ||
{| class="wikitable mw-collapsible" | {| class="wikitable mw-collapsible" | ||
Line 2,328: | Line 2,323: | ||
!Description | !Description | ||
|- | |- | ||
|success | | success || Boolean || Was the request successful or it failed | ||
|Boolean | |||
| | |||
|- | |- | ||
|code | | code || Number || Response status code | ||
| | |||
| | |||
|- | |- | ||
|msg | |msg || [String] || Error message | ||
| | |||
| | |||
|- | |- | ||
| colspan="3" |data | | colspan="3" |data |
Revision as of 16:19, 10 April 2024
Detailed description of the requests and responses for each endpoint.
Endpoint list:
Method | Path | Description |
---|---|---|
OPTIONS | /api/stat/get | Returns all possible groupings and metrics grouped by categories |
POST | /api/stat/filter | Obtaining data for filter |
POST | /api/stat/data | Obtaining data for the table |
How to get all possible groupings and metrics
To obtain all possible groupings and metrics grouped by categories use this URL:
Method | Path |
---|---|
OPTIONS | /api/stat/get |
Request
No parameters
Response
Response example
{ "success":true, "code":200, "msg":[], "data":{ "groups":{ "time":[ { "id":"time_hour", "icon":"date", "filterType":"range" }, { "id":"time_day", "icon":"date", "filterType":"range" }, { "id":"time_week", "icon":"date", "filterType":"range" }, { "id":"time_month", "icon":"date", "filterType":"range" }, { "id":"time_dateTime", "icon":"date", "filterType":"list", "filterSync":true } ], "sub":[ { "id":"sub_integration", "icon":"text", "filterType":"list", "filterSync":false }, { "id":"sub_botType", "icon":"text", "filterType":"list", "filterSync":false }, { "id":"sub_cnvId", "icon":"text", "filterType":"list", "filterSync":true }, { "id":"sub_clickId", "icon":"number", "filterType":"list", "filterSync":true }, { "id":"sub_referer", "icon":"text", "filterType":"list", "filterSync":true, "tooltip":true }, { "id":"sub_1", "icon":"text", "filterType":"list", "filterSync":true }, { "id":"sub_2", "icon":"text", "filterType":"list", "filterSync":true }, { "id":"sub_3", "icon":"text", "filterType":"list", "filterSync":true }, { "id":"sub_4", "icon":"text", "filterType":"list", "filterSync":true }, { "id":"sub_5", "icon":"text", "filterType":"list", "filterSync":true }, { "id":"sub_6", "icon":"text", "filterType":"list", "filterSync":true }, { "id":"sub_7", "icon":"text", "filterType":"list", "filterSync":true } ], "geo":[ { "id":"geo_language", "icon":"text", "filterType":"list", "filterSync":true }, { "id":"geo_timezone", "icon":"text", "filterType":"list", "filterSync":false }, { "id":"geo_country", "icon":"text", "filterType":"list", "filterSync":false }, { "id":"geo_city", "icon":"text", "filterType":"list", "filterSync":true }, { "id":"geo_provider", "icon":"text", "filterType":"list", "filterSync":true }, { "id":"geo_ip", "icon":"text", "filterType":"list", "filterSync":true } ], "device":[ { "id":"device_browser", "icon":"text", "filterType":"list", "filterSync":true, "tooltip":true }, { "id":"device_browserEngine", "icon":"text", "filterType":"list", "filterSync":true, "tooltip":true }, { "id":"device_os", "icon":"text", "filterType":"list", "filterSync":true, "tooltip":true }, { "id":"device_realOs", "icon":"text", "filterType":"list", "filterSync":false, "tooltip":true }, { "id":"device_device", "icon":"text", "filterType":"list", "filterSync":true, "tooltip":true }, { "id":"device_type", "icon":"text", "filterType":"list", "filterSync":false, "tooltip":true }, { "id":"device_connectionType", "icon":"text", "filterType":"list", "filterSync":false }, { "id":"device_useragent", "icon":"text", "filterType":"list", "filterSync":true } ], "screen":[ { "id":"screen_width", "icon":"number", "filterType":"range", "tooltip":true }, { "id":"screen_height", "icon":"number", "filterType":"range", "tooltip":true }, { "id":"screen_orientation", "icon":"text", "filterType":"list", "filterSync":false }, { "id":"screen_pixelDensity", "icon":"number", "filterType":"list", "filterSync":true, "tooltip":true } ] }, "metrics":{ "summary":[ { "id":"summary_totalVisits", "icon":"number", "filterType":"range" }, { "id":"summary_validVisits", "icon":"number", "filterType":"range", "filterSync":false, "tooltip":true }, { "id":"summary_validVisitsPc", "icon":"number", "filterType":"range", "filterSync":false }, { "id":"summary_techLosses", "icon":"number", "filterType":"range", "filterSync":false, "tooltip":true }, { "id":"summary_techLossesPc", "icon":"number", "filterType":"range", "filterSync":false }, { "id":"summary_uniqUsers", "icon":"number", "filterType":"range", "tooltip":true }, { "id":"summary_uniqUsersPc", "icon":"number", "filterType":"range" }, { "id":"summary_conversions", "icon":"number", "filterType":"binary", "filterSync":false, "tooltip":true }, { "id":"summary_conversionsPc", "icon":"number", "filterType":"range", "filterSync":false } ], "bots":[ { "id":"bots_total", "icon":"number", "filterType":"range", "filterSync":false, "tooltip":true }, { "id":"bots_totalPc", "icon":"number", "filterType":"range", "filterSync":false }, { "id":"bots_crawler", "icon":"number", "filterType":"binary", "filterSync":false, "tooltip":true }, { "id":"bots_crawlerPc", "icon":"number", "filterType":"range", "filterSync":false }, { "id":"bots_spoofing", "icon":"number", "filterType":"binary", "filterSync":false, "tooltip":true }, { "id":"bots_spoofingPc", "icon":"number", "filterType":"range", "filterSync":false }, { "id":"bots_automated", "icon":"number", "filterType":"binary", "filterSync":false, "tooltip":true }, { "id":"bots_automatedPc", "icon":"number", "filterType":"range", "filterSync":false }, { "id":"bots_iFrame", "icon":"number", "filterType":"binary", "filterSync":false, "tooltip":true }, { "id":"bots_iFramePc", "icon":"number", "filterType":"range", "filterSync":false }, { "id":"bots_badReputationIp", "icon":"number", "filterType":"binary", "filterSync":false, "tooltip":true }, { "id":"bots_badReputationIpPc", "icon":"number", "filterType":"range", "filterSync":false }, { "id":"bots_blocked", "icon":"number", "filterType":"binary", "filterSync":false, "tooltip":true }, { "id":"bots_blockedPc", "icon":"number", "filterType":"range", "filterSync":false } ], "lowQuality":[ { "id":"lowQuality_total", "icon":"number", "filterType":"binary", "filterSync":false, "tooltip":true }, { "id":"lowQuality_totalPc", "icon":"number", "filterType":"range", "filterSync":false }, { "id":"lowQuality_proxy", "icon":"number", "filterType":"binary", "filterSync":false, "tooltip":true }, { "id":"lowQuality_proxyPc", "icon":"number", "filterType":"range", "filterSync":false }, { "id":"lowQuality_spoofing", "icon":"number", "filterType":"binary", "filterSync":false, "tooltip":true }, { "id":"lowQuality_spoofingPc", "icon":"number", "filterType":"range", "filterSync":false }, { "id":"lowQuality_automated", "icon":"number", "filterType":"binary", "filterSync":false, "tooltip":true }, { "id":"lowQuality_automatedPc", "icon":"number", "filterType":"range", "filterSync":false }, { "id":"lowQuality_trafficCheats", "icon":"number", "filterType":"binary", "filterSync":false, "tooltip":true }, { "id":"lowQuality_trafficCheatsPc", "icon":"number", "filterType":"range", "filterSync":false } ], "feature":[ { "id":"feature_adBlock", "icon":"number", "filterType":"list", "filterSync":false, "tooltip":true }, { "id":"feature_adBlockPc", "icon":"number", "filterType":"range" }, { "id":"feature_isMobile", "icon":"number", "filterType":"binary", "tooltip":true }, { "id":"feature_isMobilePc", "icon":"number", "filterType":"range" }, { "id":"feature_webView", "icon":"number", "filterType":"binary", "tooltip":true }, { "id":"feature_webViewPc", "icon":"number", "filterType":"range" }, { "id":"feature_iFrame", "icon":"number", "filterType":"binary", "filterSync":false, "tooltip":true }, { "id":"feature_iFramePc", "icon":"number", "filterType":"range", "filterSync":false }, { "id":"feature_pushNotifications", "icon":"number", "filterType":"binary", "filterSync":false, "tooltip":true }, { "id":"feature_pushNotificationsPc", "icon":"number", "filterType":"range", "filterSync":false } ], "beAn":[ { "id":"beAn_pageVisibility", "icon":"number", "filterType":"list", "filterSync":false, "tooltip":true, "disabled":false }, { "id":"beAn_pageVisibilityPc", "icon":"number", "filterType":"range", "filterSync":false, "disabled":false }, { "id":"beAn_pageActivity", "icon":"number", "filterType":"list", "filterSync":false, "tooltip":true, "disabled":false }, { "id":"beAn_pageActivityPc", "icon":"number", "filterType":"range", "filterSync":false, "disabled":false }, { "id":"beAn_pageAcceptance", "icon":"number", "filterType":"list", "filterSync":false, "tooltip":true, "disabled":false }, { "id":"beAn_pageAcceptancePc", "icon":"number", "filterType":"range", "filterSync":false, "disabled":false } ] } } }
API
Key | Type | Description | |
---|---|---|---|
success | Boolean | Was the request successful or it failed | |
code | Number | Response status code | |
msg | [String] | Error message | |
data | |||
data.groups | { groupTitle: [<item>, …] } | See bellow description <item> | |
data.metrics | { metricTitle: [<item>, …] } | See bellow description <item> |
Key | Type | Description |
---|---|---|
id | String | <groupTitle or metricTitle>
+ underscore + <metric or group's name> (groupTitle_id, for example: lowQuality_total, feature_adBlock) |
icon | date | text | number
|
Type of content served |
filterType | range | list | binary
|
See bellow description <filterType> |
filterSync | Boolean * | list with server-side search
|
How to get all possible values for filter
To obtain values use this URL:
Method | Path |
---|---|
POST | /api/stat/filter |
Request
Request example
{ "id":"geo_language", "searchQuery":"en", "cancellable":true, "dateFrom":"2024-04-10", "dateTo":"2024-04-10" }
API
Key | Type | Description |
---|---|---|
id | String | Filter name |
searchQuery | String | Search query |
dateFrom | String | What date should we start searching? Date in the format Y-m-d. |
dateTo | String | Until what date should we continue searching?? Date in the format Y-m-d. |
cancellable | Boolean | deprecated |
Response
Response example
{ "success":true, "code":200, "msg":[], "data":{ "items":[ { "id":"bd", "label":"Bengali" }, { "id":"bez", "label":"Bena (Tanzania)" }, { "id":"bn", "label":"Bengali" }, { "id":"ce", "label":"Chechen" }, { "id":"ckb", "label":"Central Kurdish" }, { "id":"en", "label":"English" }, { "id":"fr", "label":"French" }, { "id":"hy", "label":"Armenian" }, { "id":"kam", "label":"Kamba (Kenya)" }, { "id":"kln", "label":"Kalenjin" }, { "id":"km", "label":"Central Khmer" }, { "id":"luo", "label":"Luo (Kenya and Tanzania)" }, { "id":"mfe", "label":"Morisyen" }, { "id":"seh", "label":"Sena" }, { "id":"ses", "label":"Koyraboro Senni Songhai" }, { "id":"sl", "label":"Slovenian" }, { "id":"tk", "label":"Turkmen" }, { "id":"tzm", "label":"Central Atlas Tamazight" }, { "id":"ve", "label":"Venda" }, { "id":"vec", "label":"Venetian" }, { "id":"yav", "label":"Yangben" }, { "id":"yrl", "label":"Nhengatu" } ] } }
API
Key | Type | Description |
---|---|---|
success | Boolean | Was the request successful or it failed |
code | Number | Response status code |
msg | [String] | Error message |
data | ||
data.items | [{ id: Number, label: String }] | { id: 1, label: "Param A" } |
How to get full statistic data
To obtain such data use this URL:
Method | Path |
---|---|
POST | /api/stat/data |
Request
Request example
{ "id":null, "name":null, "perPage":50, "groups":[ "time_day", "geo_country" ], "metrics":[ "summary_totalVisits", "bots_total", "bots_totalPc" ], "filters":{ "filters":[ { "id":"geo_language", "type":"list", "include":["sl", "hr", "sh", "bs", "sr"], "exclude":[] } ], "period":"today", "timezone":-3 }, "compare":null }
API
Key | Type | Description |
---|---|---|
id | String | Optional parameter |
name | String | Optional parameter |
perPage | Number | Number of lines shown simultaneously. Default value is 50. |
page | Number | Current page number. Default value is 1. |
groups | [String] | Allowed values:
time_hour, time_day, time_week, time_month, time_dateTime, sub_integration, sub_botType, sub_referer, sub_1, sub_2, sib_3, sub_4, sub_5, sub_6, sub_7, geo_language, geo_timezone, geo_country, geo_city, geo_provider, device_browser, device_browserEngine, device_os, device_realOs, device_device, device_type, device_connectionType, device_useragent, screen_width, screen_height, screen_orientation, screen_pixelDensity Full list of metrics you can get with this URL. |
metrics | [String] | Allowed values:
summary_totalVisits, summary_uniqUsers, summary_uniqUsersPc, summary_validVisits, summary_validVisitsPc, summary_techLosses, summary_techLossesPc, bots_total, bots_totalPc, bots_crawler, bots_crawlerPc, bots_spoofing, bots_spoofingPc, bots_automated, bots_automatedPc, bots_iFrame, bots_iFramePc, bots_badReputationIp, bots_badReputationIpPc, bots_blocked, bots_blockedPc, lowQuality_total, lowQuality_totalPc, lowQuality_proxy, lowQuality_proxyPc, lowQuality_spoofing, lowQuality_spoofingPc, lowQuality_automated, lowQuality_automatedPc, lowQuality_trafficCheats, lowQuality_trafficCheatsPc, feature_adBlock, feature_adBlockPc, feature_isMobile, feature_isMobilePc, feature_webView, feature_webViewPc, feature_iFrame, feature_iFramePc, feature_pushNotifications, feature_pushNotificationsPc. Those values are allowed only if option Behavioral analysis is turned on for you integration: beAn_pageVisibility, beAn_pageVisibilityPc, beAn_pageActivity, beAn_pageActivityPc, beAn_pageAcceptance, beAn_pageAcceptancePc Full list of metrics you can get with this URL. |
filters | ||
filters.dateFrom | String | Date in the format Y-m-d. If you specify a period, dateFrom will not work. The period has high priority. |
filters.dateTo | String | Date in the format Y-m-d. If you specify a period, dateTo will not work. The period has high priority. |
filters.period | today | yesterday | currentWeek | 7days| month | null | If you specify a period, dateFrom and dateTo will not work. The period has high priority |
filters.timezone | Number | From -12 to +12. Default value is 0, which means that the data will be output in UTC. |
filters.filters | [<filters>] | See bellow description <filters> |
compare | <compare> | See bellow description <compare> |
Key | Type | Description |
---|---|---|
id | String | Allowed values:
time_hour, time_day, time_week, time_month, sub_integration, sub_botType, sub_referer, sub_1, sub_2, sib_3, sub_4, sub_5, sub_6, sub_7, geo_language, geo_timezone, geo_country, geo_city, geo_provider, device_browser, device_browserEngine, device_os, device_realOs, device_device, device_type, device_connectionType, device_useragent, screen_width, screen_height, screen_orientation, screen_pixelDensity, summary_totalVisits, summary_uniqUsers, summary_uniqUsersPc, summary_validVisits, summary_validVisitsPc, summary_techLosses, summary_techLossesPc, bots_total, bots_totalPc, bots_crawler, bots_crawlerPc, bots_spoofing, bots_spoofingPc, bots_automated, bots_automatedPc, bots_iFrame, bots_iFramePc, bots_badReputationIp, bots_badReputationIpPc, bots_blocked, bots_blockedPc, lowQuality_total, lowQuality_totalPc, lowQuality_proxy, lowQuality_proxyPc, lowQuality_spoofing, lowQuality_spoofingPc, lowQuality_automated, lowQuality_automatedPc, lowQuality_trafficCheats, lowQuality_trafficCheatsPc, feature_adBlock, feature_adBlockPc, feature_isMobile, feature_isMobilePc, feature_webView, feature_webViewPc, feature_iFrame, feature_iFramePc, feature_pushNotifications, feature_pushNotificationsPc. Those values are allowed only if option Behavioral analysis is turned on for you integration: beAn_pageVisibility, beAn_pageVisibilityPc, beAn_pageActivity, beAn_pageActivityPc, beAn_pageAcceptance, beAn_pageAcceptancePc Full list of metrics you can get with this URL. |
type | String | |
range | {from: Number, to: Number} |
Key | Type | Description |
---|---|---|
dateFrom | String | Date in the format Y-m-d |
dateTo | String | Date in the format Y-m-d |
mode | compare_value | diff | percent | |
sort | Boolean |
Response
Response example
{ "success":true, "code":200, "msg":[], "data":{ "rows":[ { "id":0, "time_day":{ "rawValue":"10.04.2024", "value":"10.04.2024", "diff":null, "percent":null, "compare_value":null }, "geo_country":{ "rawValue":"AE", "value":"United Arab Emirates ", "diff":null, "percent":null, "compare_value":null }, "summary_totalVisits":{ "rawValue":"1", "value":"1", "diff":null, "percent":null, "compare_value":null }, "bots_total":{ "rawValue":"0", "value":"0", "diff":null, "percent":null, "compare_value":null }, "bots_totalPc":{ "rawValue":0, "value":"0", "diff":null, "percent":null, "compare_value":null } }, { "id":1, "time_day":{ "rawValue":"10.04.2024", "value":"10.04.2024", "diff":null, "percent":null, "compare_value":null }, "geo_country":{ "rawValue":"AT", "value":"Austria", "diff":null, "percent":null, "compare_value":null }, "summary_totalVisits":{ "rawValue":"27", "value":"27", "diff":null, "percent":null, "compare_value":null }, "bots_total":{ "rawValue":"0", "value":"0", "diff":null, "percent":null, "compare_value":null }, "bots_totalPc":{ "rawValue":0, "value":"0", "diff":null, "percent":null, "compare_value":null } }, { "id":2, "time_day":{ "rawValue":"10.04.2024", "value":"10.04.2024", "diff":null, "percent":null, "compare_value":null }, "geo_country":{ "rawValue":"BA", "value":"Bosnia and Herzegovina", "diff":null, "percent":null, "compare_value":null }, "summary_totalVisits":{ "rawValue":"349", "value":"349", "diff":null, "percent":null, "compare_value":null }, "bots_total":{ "rawValue":"3", "value":"3", "diff":null, "percent":null, "compare_value":null }, "bots_totalPc":{ "rawValue":0.86, "value":"0.86", "diff":null, "percent":null, "compare_value":null } }, { "id":3, "time_day":{ "rawValue":"10.04.2024", "value":"10.04.2024", "diff":null, "percent":null, "compare_value":null }, "geo_country":{ "rawValue":"BD", "value":"Bangladesh", "diff":null, "percent":null, "compare_value":null }, "summary_totalVisits":{ "rawValue":"1", "value":"1", "diff":null, "percent":null, "compare_value":null }, "bots_total":{ "rawValue":"0", "value":"0", "diff":null, "percent":null, "compare_value":null }, "bots_totalPc":{ "rawValue":0, "value":"0", "diff":null, "percent":null, "compare_value":null } }, { "id":4, "time_day":{ "rawValue":"10.04.2024", "value":"10.04.2024", "diff":null, "percent":null, "compare_value":null }, "geo_country":{ "rawValue":"BG", "value":"Bulgaria", "diff":null, "percent":null, "compare_value":null }, "summary_totalVisits":{ "rawValue":"3", "value":"3", "diff":null, "percent":null, "compare_value":null }, "bots_total":{ "rawValue":"0", "value":"0", "diff":null, "percent":null, "compare_value":null }, "bots_totalPc":{ "rawValue":0, "value":"0", "diff":null, "percent":null, "compare_value":null } }, { "id":5, "time_day":{ "rawValue":"10.04.2024", "value":"10.04.2024", "diff":null, "percent":null, "compare_value":null }, "geo_country":{ "rawValue":"BR", "value":"Brazil", "diff":null, "percent":null, "compare_value":null }, "summary_totalVisits":{ "rawValue":"1", "value":"1", "diff":null, "percent":null, "compare_value":null }, "bots_total":{ "rawValue":"0", "value":"0", "diff":null, "percent":null, "compare_value":null }, "bots_totalPc":{ "rawValue":0, "value":"0", "diff":null, "percent":null, "compare_value":null } }, { "id":6, "time_day":{ "rawValue":"10.04.2024", "value":"10.04.2024", "diff":null, "percent":null, "compare_value":null }, "geo_country":{ "rawValue":"CA", "value":"Canada", "diff":null, "percent":null, "compare_value":null }, "summary_totalVisits":{ "rawValue":"1", "value":"1", "diff":null, "percent":null, "compare_value":null }, "bots_total":{ "rawValue":"0", "value":"0", "diff":null, "percent":null, "compare_value":null }, "bots_totalPc":{ "rawValue":0, "value":"0", "diff":null, "percent":null, "compare_value":null } }, { "id":7, "time_day":{ "rawValue":"10.04.2024", "value":"10.04.2024", "diff":null, "percent":null, "compare_value":null }, "geo_country":{ "rawValue":"CH", "value":"Switzerland", "diff":null, "percent":null, "compare_value":null }, "summary_totalVisits":{ "rawValue":"4", "value":"4", "diff":null, "percent":null, "compare_value":null }, "bots_total":{ "rawValue":"0", "value":"0", "diff":null, "percent":null, "compare_value":null }, "bots_totalPc":{ "rawValue":0, "value":"0", "diff":null, "percent":null, "compare_value":null } }, { "id":8, "time_day":{ "rawValue":"10.04.2024", "value":"10.04.2024", "diff":null, "percent":null, "compare_value":null }, "geo_country":{ "rawValue":"DE", "value":"Germany", "diff":null, "percent":null, "compare_value":null }, "summary_totalVisits":{ "rawValue":"110", "value":"110", "diff":null, "percent":null, "compare_value":null }, "bots_total":{ "rawValue":"0", "value":"0", "diff":null, "percent":null, "compare_value":null }, "bots_totalPc":{ "rawValue":0, "value":"0", "diff":null, "percent":null, "compare_value":null } }, { "id":9, "time_day":{ "rawValue":"10.04.2024", "value":"10.04.2024", "diff":null, "percent":null, "compare_value":null }, "geo_country":{ "rawValue":"HR", "value":"Croatia", "diff":null, "percent":null, "compare_value":null }, "summary_totalVisits":{ "rawValue":"274", "value":"274", "diff":null, "percent":null, "compare_value":null }, "bots_total":{ "rawValue":"4", "value":"4", "diff":null, "percent":null, "compare_value":null }, "bots_totalPc":{ "rawValue":1.46, "value":"1.46", "diff":null, "percent":null, "compare_value":null } }, { "id":10, "time_day":{ "rawValue":"10.04.2024", "value":"10.04.2024", "diff":null, "percent":null, "compare_value":null }, "geo_country":{ "rawValue":"HU", "value":"Hungary", "diff":null, "percent":null, "compare_value":null }, "summary_totalVisits":{ "rawValue":"1", "value":"1", "diff":null, "percent":null, "compare_value":null }, "bots_total":{ "rawValue":"0", "value":"0", "diff":null, "percent":null, "compare_value":null }, "bots_totalPc":{ "rawValue":0, "value":"0", "diff":null, "percent":null, "compare_value":null } }, { "id":11, "time_day":{ "rawValue":"10.04.2024", "value":"10.04.2024", "diff":null, "percent":null, "compare_value":null }, "geo_country":{ "rawValue":"IN", "value":"India", "diff":null, "percent":null, "compare_value":null }, "summary_totalVisits":{ "rawValue":"2", "value":"2", "diff":null, "percent":null, "compare_value":null }, "bots_total":{ "rawValue":"0", "value":"0", "diff":null, "percent":null, "compare_value":null }, "bots_totalPc":{ "rawValue":0, "value":"0", "diff":null, "percent":null, "compare_value":null } }, { "id":12, "time_day":{ "rawValue":"10.04.2024", "value":"10.04.2024", "diff":null, "percent":null, "compare_value":null }, "geo_country":{ "rawValue":"IR", "value":"Iran", "diff":null, "percent":null, "compare_value":null }, "summary_totalVisits":{ "rawValue":"1", "value":"1", "diff":null, "percent":null, "compare_value":null }, "bots_total":{ "rawValue":"0", "value":"0", "diff":null, "percent":null, "compare_value":null }, "bots_totalPc":{ "rawValue":0, "value":"0", "diff":null, "percent":null, "compare_value":null } }, { "id":13, "time_day":{ "rawValue":"10.04.2024", "value":"10.04.2024", "diff":null, "percent":null, "compare_value":null }, "geo_country":{ "rawValue":"IT", "value":"Italy", "diff":null, "percent":null, "compare_value":null }, "summary_totalVisits":{ "rawValue":"2", "value":"2", "diff":null, "percent":null, "compare_value":null }, "bots_total":{ "rawValue":"0", "value":"0", "diff":null, "percent":null, "compare_value":null }, "bots_totalPc":{ "rawValue":0, "value":"0", "diff":null, "percent":null, "compare_value":null } }, { "id":14, "time_day":{ "rawValue":"10.04.2024", "value":"10.04.2024", "diff":null, "percent":null, "compare_value":null }, "geo_country":{ "rawValue":"LB", "value":"Lebanon", "diff":null, "percent":null, "compare_value":null }, "summary_totalVisits":{ "rawValue":"2", "value":"2", "diff":null, "percent":null, "compare_value":null }, "bots_total":{ "rawValue":"0", "value":"0", "diff":null, "percent":null, "compare_value":null }, "bots_totalPc":{ "rawValue":0, "value":"0", "diff":null, "percent":null, "compare_value":null } }, { "id":15, "time_day":{ "rawValue":"10.04.2024", "value":"10.04.2024", "diff":null, "percent":null, "compare_value":null }, "geo_country":{ "rawValue":"LU", "value":"Luxembourg", "diff":null, "percent":null, "compare_value":null }, "summary_totalVisits":{ "rawValue":"1", "value":"1", "diff":null, "percent":null, "compare_value":null }, "bots_total":{ "rawValue":"0", "value":"0", "diff":null, "percent":null, "compare_value":null }, "bots_totalPc":{ "rawValue":0, "value":"0", "diff":null, "percent":null, "compare_value":null } }, { "id":16, "time_day":{ "rawValue":"10.04.2024", "value":"10.04.2024", "diff":null, "percent":null, "compare_value":null }, "geo_country":{ "rawValue":"MA", "value":"Morocco", "diff":null, "percent":null, "compare_value":null }, "summary_totalVisits":{ "rawValue":"1", "value":"1", "diff":null, "percent":null, "compare_value":null }, "bots_total":{ "rawValue":"0", "value":"0", "diff":null, "percent":null, "compare_value":null }, "bots_totalPc":{ "rawValue":0, "value":"0", "diff":null, "percent":null, "compare_value":null } }, { "id":17, "time_day":{ "rawValue":"10.04.2024", "value":"10.04.2024", "diff":null, "percent":null, "compare_value":null }, "geo_country":{ "rawValue":"ME", "value":"Montenegro", "diff":null, "percent":null, "compare_value":null }, "summary_totalVisits":{ "rawValue":"42", "value":"42", "diff":null, "percent":null, "compare_value":null }, "bots_total":{ "rawValue":"0", "value":"0", "diff":null, "percent":null, "compare_value":null }, "bots_totalPc":{ "rawValue":0, "value":"0", "diff":null, "percent":null, "compare_value":null } }, { "id":18, "time_day":{ "rawValue":"10.04.2024", "value":"10.04.2024", "diff":null, "percent":null, "compare_value":null }, "geo_country":{ "rawValue":"MK", "value":"Republic of North Macedonia", "diff":null, "percent":null, "compare_value":null }, "summary_totalVisits":{ "rawValue":"21", "value":"21", "diff":null, "percent":null, "compare_value":null }, "bots_total":{ "rawValue":"0", "value":"0", "diff":null, "percent":null, "compare_value":null }, "bots_totalPc":{ "rawValue":0, "value":"0", "diff":null, "percent":null, "compare_value":null } }, { "id":19, "time_day":{ "rawValue":"10.04.2024", "value":"10.04.2024", "diff":null, "percent":null, "compare_value":null }, "geo_country":{ "rawValue":"MT", "value":"Malta", "diff":null, "percent":null, "compare_value":null }, "summary_totalVisits":{ "rawValue":"1", "value":"1", "diff":null, "percent":null, "compare_value":null }, "bots_total":{ "rawValue":"0", "value":"0", "diff":null, "percent":null, "compare_value":null }, "bots_totalPc":{ "rawValue":0, "value":"0", "diff":null, "percent":null, "compare_value":null } }, { "id":20, "time_day":{ "rawValue":"10.04.2024", "value":"10.04.2024", "diff":null, "percent":null, "compare_value":null }, "geo_country":{ "rawValue":"NO", "value":"Norway", "diff":null, "percent":null, "compare_value":null }, "summary_totalVisits":{ "rawValue":"1", "value":"1", "diff":null, "percent":null, "compare_value":null }, "bots_total":{ "rawValue":"0", "value":"0", "diff":null, "percent":null, "compare_value":null }, "bots_totalPc":{ "rawValue":0, "value":"0", "diff":null, "percent":null, "compare_value":null } }, { "id":21, "time_day":{ "rawValue":"10.04.2024", "value":"10.04.2024", "diff":null, "percent":null, "compare_value":null }, "geo_country":{ "rawValue":"PL", "value":"Poland", "diff":null, "percent":null, "compare_value":null }, "summary_totalVisits":{ "rawValue":"8", "value":"8", "diff":null, "percent":null, "compare_value":null }, "bots_total":{ "rawValue":"0", "value":"0", "diff":null, "percent":null, "compare_value":null }, "bots_totalPc":{ "rawValue":0, "value":"0", "diff":null, "percent":null, "compare_value":null } }, { "id":22, "time_day":{ "rawValue":"10.04.2024", "value":"10.04.2024", "diff":null, "percent":null, "compare_value":null }, "geo_country":{ "rawValue":"QA", "value":"Qatar", "diff":null, "percent":null, "compare_value":null }, "summary_totalVisits":{ "rawValue":"2", "value":"2", "diff":null, "percent":null, "compare_value":null }, "bots_total":{ "rawValue":"0", "value":"0", "diff":null, "percent":null, "compare_value":null }, "bots_totalPc":{ "rawValue":0, "value":"0", "diff":null, "percent":null, "compare_value":null } }, { "id":23, "time_day":{ "rawValue":"10.04.2024", "value":"10.04.2024", "diff":null, "percent":null, "compare_value":null }, "geo_country":{ "rawValue":"RO", "value":"Romania", "diff":null, "percent":null, "compare_value":null }, "summary_totalVisits":{ "rawValue":"2", "value":"2", "diff":null, "percent":null, "compare_value":null }, "bots_total":{ "rawValue":"0", "value":"0", "diff":null, "percent":null, "compare_value":null }, "bots_totalPc":{ "rawValue":0, "value":"0", "diff":null, "percent":null, "compare_value":null } }, { "id":24, "time_day":{ "rawValue":"10.04.2024", "value":"10.04.2024", "diff":null, "percent":null, "compare_value":null }, "geo_country":{ "rawValue":"RS", "value":"Serbia", "diff":null, "percent":null, "compare_value":null }, "summary_totalVisits":{ "rawValue":"676", "value":"676", "diff":null, "percent":null, "compare_value":null }, "bots_total":{ "rawValue":"3", "value":"3", "diff":null, "percent":null, "compare_value":null }, "bots_totalPc":{ "rawValue":0.44, "value":"0.44", "diff":null, "percent":null, "compare_value":null } }, { "id":25, "time_day":{ "rawValue":"10.04.2024", "value":"10.04.2024", "diff":null, "percent":null, "compare_value":null }, "geo_country":{ "rawValue":"RU", "value":"Russian Federation ", "diff":null, "percent":null, "compare_value":null }, "summary_totalVisits":{ "rawValue":"3", "value":"3", "diff":null, "percent":null, "compare_value":null }, "bots_total":{ "rawValue":"0", "value":"0", "diff":null, "percent":null, "compare_value":null }, "bots_totalPc":{ "rawValue":0, "value":"0", "diff":null, "percent":null, "compare_value":null } }, { "id":26, "time_day":{ "rawValue":"10.04.2024", "value":"10.04.2024", "diff":null, "percent":null, "compare_value":null }, "geo_country":{ "rawValue":"SE", "value":"Sweden", "diff":null, "percent":null, "compare_value":null }, "summary_totalVisits":{ "rawValue":"1", "value":"1", "diff":null, "percent":null, "compare_value":null }, "bots_total":{ "rawValue":"0", "value":"0", "diff":null, "percent":null, "compare_value":null }, "bots_totalPc":{ "rawValue":0, "value":"0", "diff":null, "percent":null, "compare_value":null } }, { "id":27, "time_day":{ "rawValue":"10.04.2024", "value":"10.04.2024", "diff":null, "percent":null, "compare_value":null }, "geo_country":{ "rawValue":"SI", "value":"Slovenia", "diff":null, "percent":null, "compare_value":null }, "summary_totalVisits":{ "rawValue":"199", "value":"199", "diff":null, "percent":null, "compare_value":null }, "bots_total":{ "rawValue":"10", "value":"10", "diff":null, "percent":null, "compare_value":null }, "bots_totalPc":{ "rawValue":5.03, "value":"5.03", "diff":null, "percent":null, "compare_value":null } }, { "id":28, "time_day":{ "rawValue":"10.04.2024", "value":"10.04.2024", "diff":null, "percent":null, "compare_value":null }, "geo_country":{ "rawValue":"SK", "value":"Slovakia", "diff":null, "percent":null, "compare_value":null }, "summary_totalVisits":{ "rawValue":"1", "value":"1", "diff":null, "percent":null, "compare_value":null }, "bots_total":{ "rawValue":"0", "value":"0", "diff":null, "percent":null, "compare_value":null }, "bots_totalPc":{ "rawValue":0, "value":"0", "diff":null, "percent":null, "compare_value":null } }, { "id":29, "time_day":{ "rawValue":"10.04.2024", "value":"10.04.2024", "diff":null, "percent":null, "compare_value":null }, "geo_country":{ "rawValue":"SO", "value":"Somalia", "diff":null, "percent":null, "compare_value":null }, "summary_totalVisits":{ "rawValue":"1", "value":"1", "diff":null, "percent":null, "compare_value":null }, "bots_total":{ "rawValue":"0", "value":"0", "diff":null, "percent":null, "compare_value":null }, "bots_totalPc":{ "rawValue":0, "value":"0", "diff":null, "percent":null, "compare_value":null } }, { "id":30, "time_day":{ "rawValue":"10.04.2024", "value":"10.04.2024", "diff":null, "percent":null, "compare_value":null }, "geo_country":{ "rawValue":"TR", "value":"Turkey", "diff":null, "percent":null, "compare_value":null }, "summary_totalVisits":{ "rawValue":"1", "value":"1", "diff":null, "percent":null, "compare_value":null }, "bots_total":{ "rawValue":"0", "value":"0", "diff":null, "percent":null, "compare_value":null }, "bots_totalPc":{ "rawValue":0, "value":"0", "diff":null, "percent":null, "compare_value":null } }, { "id":31, "time_day":{ "rawValue":"10.04.2024", "value":"10.04.2024", "diff":null, "percent":null, "compare_value":null }, "geo_country":{ "rawValue":"US", "value":"United States of America ", "diff":null, "percent":null, "compare_value":null }, "summary_totalVisits":{ "rawValue":"20", "value":"20", "diff":null, "percent":null, "compare_value":null }, "bots_total":{ "rawValue":"18", "value":"18", "diff":null, "percent":null, "compare_value":null }, "bots_totalPc":{ "rawValue":90, "value":"90", "diff":null, "percent":null, "compare_value":null } }, { "id":32, "time_day":{ "rawValue":"10.04.2024", "value":"10.04.2024", "diff":null, "percent":null, "compare_value":null }, "geo_country":{ "rawValue":"XK", "value":"Kosovo", "diff":null, "percent":null, "compare_value":null }, "summary_totalVisits":{ "rawValue":"3", "value":"3", "diff":null, "percent":null, "compare_value":null }, "bots_total":{ "rawValue":"0", "value":"0", "diff":null, "percent":null, "compare_value":null }, "bots_totalPc":{ "rawValue":0, "value":"0", "diff":null, "percent":null, "compare_value":null } } ], "totalRows":33, "page":1, "perPage":50, "columns":[ { "field":"time_day", "type":"string", "sortable":true, "unit":null, "tooltip":false }, { "field":"geo_country", "type":"string", "sortable":true, "unit":null, "tooltip":false }, { "field":"summary_totalVisits", "type":"number", "sortable":true, "unit":null, "tooltip":false }, { "field":"bots_total", "type":"number", "sortable":true, "unit":null, "tooltip":true }, { "field":"bots_totalPc", "type":"float", "sortable":true, "unit":"%", "tooltip":false } ], "total":{ "id":33, "time_day":"fullResult", "geo_country":{ "rawValue":null, "value":"", "diff":null, "percent":null, "compare_value":null }, "summary_totalVisits":{ "rawValue":null, "value":"1763", "diff":null, "percent":null, "compare_value":null }, "bots_total":{ "rawValue":null, "value":"38", "diff":null, "percent":null, "compare_value":null }, "bots_totalPc":{ "rawValue":null, "value":"2.16", "diff":null, "percent":null, "compare_value":null } } } }
API
Key | Type | Description |
---|---|---|
success | Boolean | Was the request successful or it failed |
code | Number | Response status code |
msg | [String] | Error message |
data | ||
data.rows | [<row>] | Description of table rows |
data.totalRows | Number | Total number of items in the table |
data.total | <row> | Sum for each column considering invisible rows |
data.page | Number | Current page |
data.perPage | Number | Number of items per page |
data.columns | [<column>] | Description of columns |
Key | Type | Description |
---|---|---|
value | String | |
diff | String | null | |
percent | Number | null | |
compare_value | String | null |
Key | Type | Description |
---|---|---|
field | String | ID of the metric or group |
type | string | number | float | |
sortable | Boolean | Sortable or not |
unit | String | null | Unit of measurement
For example, % for percentage columns |
Request examples
CURL
curl -X 'OPTIONS' \ 'https://kaminari.click/api/stat/get' \ -H 'accept: */*' 'Authorization: Bearer <YOUR API_TOKEN>'
curl -X POST 'https://kaminari.click/api/stat/filter' -d '{"id":"device_type","searchQuery":"","dateFrom":"2023-01-05","dateTo":"2023-01-05"}' -H 'content-type: application/json' -H 'Authorization: Bearer <YOUR API_TOKEN>'
curl -X POST 'https://kaminari.click/api/stat/data' -d '{"id":null,"name":null,"groups":["time_day"],"metrics":["summary_totalVisits"],"filters":{"filters":[],"period":null,"timezone":0,"dateTo":"2022-08-15","dateFrom":"2022-08-15"},"compare":null}' -H 'content-type: application/json' -H 'Authorization: Bearer <YOUR API_TOKEN>'
NodeJS
const https = require('https'); const options = { host: 'kaminari.click', port: 443, path: '/api/stat/get', method: 'POST', headers: { 'Authorization': 'Bearer <YOUR API_TOKEN>' } }; https .get(options, (resp) => { let data = ''; resp.on('data', (chunk) => { data += chunk; }); resp.on('end', () => { try { data = JSON.parse(data); } catch { console.log(data); } }); }) .on("error", (err) => { console.log("Error: " + err.message); });
PHP
<?php $ch = curl_init(); curl_setopt($ch, CURLOPT_URL, 'https://kaminari.click/api/stat/get'); curl_setopt($ch, CURLOPT_RETURNTRANSFER, true); curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'OPTIONS'); curl_setopt($ch, CURLOPT_HTTPHEADER, [ 'accept: */*', ]); $response = curl_exec($ch); curl_close($ch);
Python
import requests headers = { 'accept': '*/*', } response = requests.options('https://kaminari.click/api/stat/get', headers=headers) response = requests.options('http://Authorization: Bearer <YOUR API_TOKEN>', headers=headers)