Translations:Stat API/10/en: Difference between revisions
(Importing a new version from external source) |
(Importing a new version from external source) |
||
Line 16: | Line 16: | ||
|perPage | |perPage | ||
|Number | |Number | ||
| | |Default value 50 | ||
|- | |- | ||
|page | |page | ||
|Number | |Number | ||
| | |Default value 1 | ||
|- | |- | ||
|metrics | |metrics | ||
Line 30: | Line 30: | ||
|dateFrom | |dateFrom | ||
|String | |String | ||
| | |Date in the format Y-m-d | ||
|- | |- | ||
|dateTo | |dateTo | ||
|String | |String | ||
| | |Date in the format Y-m-d | ||
|- | |- | ||
|filters.filters | |filters.filters | ||
Line 50: | Line 50: | ||
|groups | |groups | ||
|[String] | |[String] | ||
|''' | |'''Allowed values:''' | ||
time_hour, time_day, time_week. time_month, time_dateTime, sub_integration, sub_botType, sub_tbReason, sub_pid, sub_clickId, sub_placementId, sub_sspName, sub_domainName, sub_referer, sub_clickLink, sub_1... | time_hour, time_day, time_week. time_month, time_dateTime, sub_integration, sub_botType, sub_tbReason, sub_pid, sub_clickId, sub_placementId, sub_sspName, sub_domainName, sub_referer, sub_clickLink, sub_1...7, geo_language, geo_timezone, geo_country, geo_city, geo_provider, geo_ip, 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 65: | Line 65: | ||
|id | |id | ||
|String | |String | ||
|''' | |'''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...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, 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 | ||
Line 77: | Line 77: | ||
|} | |} | ||
{| class="wikitable mw-collapsible" | {| class="wikitable mw-collapsible" | ||
|+ | |+Description <compare> | ||
!Key | !Key | ||
!Type | !Type | ||
Line 84: | Line 84: | ||
|dateFrom | |dateFrom | ||
|String | |String | ||
| | |Date in the format Y-m-d | ||
|- | |- | ||
|dateTo | |dateTo | ||
|String | |String | ||
| | |Date in the format Y-m-d | ||
|- | |- | ||
|mode | |mode | ||
Line 120: | Line 120: | ||
|data.rows | |data.rows | ||
|['''<row>'''] | |['''<row>'''] | ||
| | |Description of table rows | ||
|- | |- | ||
|data.totalRows | |data.totalRows | ||
|Number | |Number | ||
| | |Total number of items in the table | ||
|- | |- | ||
|data.total | |data.total | ||
|'''<row>''' | |'''<row>''' | ||
| | |Sum for each column considering invisible rows | ||
|- | |- | ||
|data.page | |data.page | ||
|Number | |Number | ||
| | |Current page | ||
|- | |- | ||
|data.perPage | |data.perPage | ||
|Number | |Number | ||
| | |Number of items per page | ||
|- | |- | ||
|data.columns | |data.columns | ||
|['''<column>'''] | |['''<column>'''] | ||
| | |Description of columns | ||
|} | |} | ||
{| class="wikitable mw-collapsible" | {| class="wikitable mw-collapsible" | ||
|+ | |+ | ||
Description <row> | |||
!Key | !Key | ||
!Type | !Type | ||
Line 167: | Line 167: | ||
{| class="wikitable mw-collapsible" | {| class="wikitable mw-collapsible" | ||
|+ | |+ | ||
Description <column> | |||
!Key | !Key | ||
!Type | !Type | ||
Line 174: | Line 174: | ||
|field | |field | ||
|String | |String | ||
|ID | |ID of the metric or group | ||
|- | |- | ||
|type | |type | ||
Line 182: | Line 182: | ||
|sortable | |sortable | ||
|Boolean | |Boolean | ||
| | |Sortable or not | ||
|- | |- | ||
|unit | |unit | ||
|<nowiki>String | null</nowiki> | |<nowiki>String | null</nowiki> | ||
| | |Unit of measurement | ||
For example, % for percentage columns | |||
|} | |} |
Revision as of 09:43, 18 December 2023
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 | От -12 до +12 |
groups | [String] | Allowed values:
time_hour, time_day, time_week. time_month, time_dateTime, sub_integration, sub_botType, sub_tbReason, sub_pid, sub_clickId, sub_placementId, sub_sspName, sub_domainName, sub_referer, sub_clickLink, sub_1...7, geo_language, geo_timezone, geo_country, geo_city, geo_provider, geo_ip, 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...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, 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 |