Translations:Stat API/10/en

From Wiki Kaminari Click
Revision as of 02:28, 19 September 2023 by FuzzyBot (talk | contribs) (Importing a new version from external source)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)

POST /api/stat/data

Request
Key Type Description
id String
name String
perPage Number Значение по умолчанию 50
page Number Значение по умолчанию 1
metrics [String]
filters
dateFrom String Дата в формате Y-m-d
dateTo String Дата в формате Y-m-d
filters.filters <filters>
period today | yesterday | currentWeek | 7days| month | null
timezone Number От -12 до +12
groups [String] Допустимые значения:

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...10, 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>
Описание <filters>
Key Type Description
id String Допустимые значения:

time_hour, time_day, time_week, time_month, sub_integration, sub_botType, sub_referer, sub_1...10, 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, 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}
Описание <compare>
Key Type Description
dateFrom String Дата в формате Y-m-d
dateTo String Дата в формате Y-m-d
mode compare_value | diff | percent
sort Boolean
Response
Key Type Description
success Boolean
code
msg
data
data.rows [<row>] Описание строк таблицы
data.totalRows Number Общее количество элементов в таблице
data.total <row> Сумма по каждой колонке с учётом невидимых строк
data.page Number Текущая страница
data.perPage Number Количество элементов на странице
data.columns [<column>] Описание столбцов
Описание <row>
Key Type Description
value String
diff String | null
percent Number | null
compare_value String | null
Описание <column>
Key Type Description
field String ID метрики или группировки
type string | number | float
sortable Boolean Можно сортировать или нет
unit String | null Единица измерения.

Например, % у процентных столбцов.