Translations:Stat API/10/en: Difference between revisions
(Importing a new version from external source) |
(Importing a new version from external source) |
||
Line 51: | Line 51: | ||
|[String] | |[String] | ||
|'''Allowed values:''' | |'''Allowed values:''' | ||
time_hour, time_day, time_week | 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 | ||
|- | |- | ||
|compare | |compare | ||
Line 66: | Line 66: | ||
|String | |String | ||
|'''Allowed values:''' | |'''Allowed values:''' | ||
time_hour, time_day, time_week, time_month, sub_integration, sub_botType, sub_referer, sub_1 | 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 | ||
|- | |- | ||
|type | |type |
Revision as of 15:14, 22 January 2024
POST /api/stat/data
Key | Type | Description |
---|---|---|
id | String | |
name | String | |
perPage | Number | Default value 50 |
page | Number | Default value 1 |
metrics | [String] | |
filters | ||
dateFrom | String | Date in the format Y-m-d |
dateTo | String | Date in the format Y-m-d |
filters.filters | <filters> | |
period | today | yesterday | currentWeek | 7days| month | null | |
timezone | Number | From -12 to +12 |
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 |
compare | <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 |
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 |
Key | Type | Description |
---|---|---|
success | Boolean | |
code | ||
msg | ||
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 |