|
|
| (2 intermediate revisions by the same user not shown) |
| Line 1: |
Line 1: |
| === '''POST /api/stat/data''' === | | == How to get full statistic data == |
| {| class="wikitable mw-collapsible" | | To obtain such data use this URL: |
| |+Request
| | {| class="wikitable" |
| !Key | | ! Method !! Path |
| !Type | |
| !Description | |
| |- | | |- |
| |id | | | POST || /api/stat/data |
| |String | |
| | | |
| |-
| |
| |name
| |
| |String
| |
| |
| |
| |-
| |
| |perPage
| |
| |Number
| |
| |Default value 50
| |
| |-
| |
| |page
| |
| |Number
| |
| |Default value 1
| |
| |-
| |
| |metrics
| |
| |[String]
| |
| |
| |
| |-
| |
| | colspan="3" |filters
| |
| |-
| |
| |dateFrom
| |
| |String
| |
| |Date in the format Y-m-d
| |
| |-
| |
| |dateTo
| |
| |String
| |
| |Date in the format Y-m-d
| |
| |-
| |
| |filters.filters
| |
| |'''<filters>'''
| |
| |
| |
| |-
| |
| |period
| |
| |<nowiki>today | yesterday | currentWeek | 7days| month | null</nowiki>
| |
| |
| |
| |-
| |
| |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>'''
| |
| |
| |
| |}
| |
| {| class="wikitable mw-collapsible"
| |
| |+Description <filters>
| |
| !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}
| |
| |
| |
| |}
| |
| {| class="wikitable mw-collapsible"
| |
| |+Description <compare>
| |
| !Key
| |
| !Type
| |
| !Description
| |
| |-
| |
| |dateFrom
| |
| |String
| |
| |Date in the format Y-m-d
| |
| |-
| |
| |dateTo
| |
| |String
| |
| |Date in the format Y-m-d
| |
| |-
| |
| |mode
| |
| |<nowiki>compare_value | diff | percent</nowiki>
| |
| |
| |
| |-
| |
| |sort
| |
| |Boolean
| |
| |
| |
| |}
| |
| {| class="wikitable mw-collapsible"
| |
| |+Response
| |
| !Key
| |
| !Type
| |
| !Description
| |
| |-
| |
| |success
| |
| |Boolean
| |
| |
| |
| |-
| |
| |code
| |
| |
| |
| |
| |
| |-
| |
| |msg
| |
| |
| |
| |
| |
| |-
| |
| | colspan="3" |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
| |
| |}
| |
| {| class="wikitable mw-collapsible"
| |
| |+
| |
| Description <row>
| |
| !Key
| |
| !Type
| |
| !Description
| |
| |-
| |
| |value
| |
| |String
| |
| |
| |
| |-
| |
| |diff
| |
| |<nowiki>String | null</nowiki>
| |
| |
| |
| |-
| |
| |percent
| |
| |<nowiki>Number | null</nowiki>
| |
| |
| |
| |-
| |
| |compare_value
| |
| |<nowiki>String | null</nowiki>
| |
| |
| |
| |}
| |
| {| class="wikitable mw-collapsible"
| |
| |+
| |
| Description <column>
| |
| !Key
| |
| !Type
| |
| !Description
| |
| |-
| |
| |field
| |
| |String
| |
| |ID of the metric or group
| |
| |-
| |
| |type
| |
| |<nowiki>string | number | float</nowiki>
| |
| |
| |
| |-
| |
| |sortable
| |
| |Boolean
| |
| |Sortable or not
| |
| |-
| |
| |unit
| |
| |<nowiki>String | null</nowiki>
| |
| |Unit of measurement
| |
| For example, % for percentage columns
| |
| |} | | |} |
