Stat API/ru: Difference between revisions

From Wiki Kaminari Click
(Updating to match new version of source page)
No edit summary
 
(13 intermediate revisions by 2 users not shown)
Line 2: Line 2:
'''[https://kaminari.click/user Где получить ключ]'''  
'''[https://kaminari.click/user Где получить ключ]'''  


<div class="mw-translate-fuzzy">
'''[https://kaminari.click/api Подробное описание запросов (request) и ответов (response) по каждому эндпойнту].'''
'''[https://kaminari.click/api-doc Подробное описание request-response по каждому эндпойнту].'''
</div>


=== '''Список эндпойнтов:''' ===
=== '''Список эндпойнтов:''' ===
Line 879: Line 877:
|Группы, которые вы хотите видеть в таблице в виде колонок
|Группы, которые вы хотите видеть в таблице в виде колонок


<div class="mw-translate-fuzzy">
Возможные значения см. ниже в '''<groups>'''
'''Возможные значения:''' 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
</div>


<div class="mw-translate-fuzzy">
'''Полный список группировок вы можете получить с помощью этого [[#How_to_get_all_possible_groupings_and_metrics|URL]].'''
|-
|-
|metrics
|metrics
|[String]
|[String]
|Метрики, которые вы хотите видеть в таблице в виде колонок
|Метрики, которые вы хотите видеть в таблице в виде колонок
</div>


<div class="mw-translate-fuzzy">
Возможные значения см. ниже в '''<metrics>'''
'''Возможные значения:''' 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|Behavioral analysis]] is turned on for you integration'': beAn_pageVisibility, beAn_pageVisibilityPc, beAn_pageActivity, beAn_pageActivityPc, beAn_pageAcceptance, beAn_pageAcceptancePc
</div>


<div class="mw-translate-fuzzy">
'''Полный список метрик вы можете получить с помощью этого [[#How_to_get_all_possible_groupings_and_metrics|URL]].'''
|-
|-
| colspan="3" |filters
| colspan="3" |filters
Line 924: Line 913:
|См. ниже описание '''<compare>'''
|См. ниже описание '''<compare>'''
|}
|}
{| class="wikitable mw-collapsible"
|+Описание <filters>
!Ключ
!Тип
!Описание
|-
|id
|String
|Колонка, по которой вы бы хотели фильтровать.
</div>


<div lang="en" dir="ltr" class="mw-content-ltr">
{| class="wikitable"
{| class="wikitable"
|+Description <groups>
|+Description <groups>
Line 1,021: Line 999:
|Conversion ID
|Conversion ID
|This group is available only if feature [[Conversions|Conversions]] is on
|This group is available only if feature [[Conversions|Conversions]] is on
|-
|sub_viewType
|Creative type
|This metric is available only if feature [[Viewability|Viewability]] is on
|-
|-
|geo_language
|geo_language
Line 1,098: Line 1,080:
|
|
|}
|}
</div>


<div lang="en" dir="ltr" class="mw-content-ltr">
```wikitext
{| class="wikitable"
{| class="wikitable"
|+Description <metrics>
|+Description <metrics>
Line 1,137: Line 1,118:
|bots_total
|bots_total
|IVT total
|IVT total
|Bots and fraud total
|Боты и фрод, итого
|-
|-
|bots_crawler
|bots_crawler
Line 1,193: Line 1,174:
|lowQuality_total
|lowQuality_total
|SV total
|SV total
|Suspicious visits total
|Подозрительные визиты, итого
|-
|-
|lowQuality_proxy
|lowQuality_proxy
Line 1,201: Line 1,182:
|lowQuality_spoofing
|lowQuality_spoofing
|Spoofing SV
|Spoofing SV
|Suspicious visits, that may be spoofing
|Подозрительные визиты, которые могут быть spoofing
|-
|-
|lowQuality_automated
|lowQuality_automated
|Automated SV
|Automated SV
|Suspicious visits, that may be automated bots
|Подозрительные визиты, которые могут быть automated-ботами
|-
|-
|lowQuality_trafficCheats
|lowQuality_trafficCheats
|Fraud SV
|Fraud SV
|Other types of suspicious visits
|Другие типы подозрительных визитов
|-
|-
|lowQuality_totalPc
|lowQuality_totalPc
Line 1,233: Line 1,214:
|conversions_total
|conversions_total
|Conversions
|Conversions
|This metric is available only if feature [[Conversions|Conversions]] is on
|Метрика доступна только при включённой фиче [[Conversions|Conversions]]
|-
|-
|conversions_l1
|conversions_l1
|L1
|L1
|This metric is available only if feature [[Conversions|Conversions]] is on
|Метрика доступна только при включённой фиче [[Conversions|Conversions]]
|-
|-
|conversions_l2
|conversions_l2
|L2
|L2
|This metric is available only if feature [[Conversions|Conversions]] is on
|Метрика доступна только при включённой фиче [[Conversions|Conversions]]
|-
|-
|conversions_l3
|conversions_l3
|L3
|L3
|This metric is available only if feature [[Conversions|Conversions]] is on
|Метрика доступна только при включённой фиче [[Conversions|Conversions]]
|-
|-
|conversions_l4
|conversions_l4
|L4
|L4
|This metric is available only if feature [[Conversions|Conversions]] is on
|Метрика доступна только при включённой фиче [[Conversions|Conversions]]
|-
|-
|conversions_totalPc
|conversions_totalPc
|Conversions, %
|Conversions, %
|This metric is available only if feature [[Conversions|Conversions]] is on
|Метрика доступна только при включённой фиче [[Conversions|Conversions]]
|-
|-
|conversions_l1Pc
|conversions_l1Pc
|L1, %
|L1, %
|This metric is available only if feature [[Conversions|Conversions]] is on
|Метрика доступна только при включённой фиче [[Conversions|Conversions]]
|-
|-
|conversions_l2Pc
|conversions_l2Pc
|L2, %
|L2, %
|This metric is available only if feature [[Conversions|Conversions]] is on
|Метрика доступна только при включённой фиче [[Conversions|Conversions]]
|-
|-
|conversions_l3Pc
|conversions_l3Pc
|L3, %
|L3, %
|This metric is available only if feature [[Conversions|Conversions]] is on
|Метрика доступна только при включённой фиче [[Conversions|Conversions]]
|-
|-
|conversions_l4Pc
|conversions_l4Pc
|L4, %
|L4, %
|This metric is available only if feature [[Conversions|Conversions]] is on
|Метрика доступна только при включённой фиче [[Conversions|Conversions]]
|-
|-
|feature_adBlock
|feature_adBlock
Line 1,313: Line 1,294:
|beAn_pageVisibility
|beAn_pageVisibility
|Visible page
|Visible page
|This metric is available only if feature [[Behavioral_analysis|Behavioral analysis]] is on
|Метрика доступна только при включённой фиче [[Behavioral_analysis|Behavioral analysis]]
|-
|-
|beAn_pageActivity
|beAn_pageActivity
|Active page
|Active page
|This metric is available only if feature [[Behavioral_analysis|Behavioral analysis]] is on
|Метрика доступна только при включённой фиче [[Behavioral_analysis|Behavioral analysis]]
|-
|-
|beAn_pageAcceptance
|beAn_pageAcceptance
|Accepted page
|Accepted page
|This metric is available only if feature [[Behavioral_analysis|Behavioral analysis]] is on
|Метрика доступна только при включённой фиче [[Behavioral_analysis|Behavioral analysis]]
|-
|-
|beAn_pageVisibilityPc
|beAn_pageVisibilityPc
|Visible page, %
|Visible page, %
|This metric is available only if feature [[Behavioral_analysis|Behavioral analysis]] is on
|Метрика доступна только при включённой фиче [[Behavioral_analysis|Behavioral analysis]]
|-
|-
|beAn_pageActivityPc
|beAn_pageActivityPc
|Active page, %
|Active page, %
|This metric is available only if feature [[Behavioral_analysis|Behavioral analysis]] is on
|Метрика доступна только при включённой фиче [[Behavioral_analysis|Behavioral analysis]]
|-
|-
|beAn_pageAcceptancePc
|beAn_pageAcceptancePc
|Accepted page, %
|Accepted page, %
|This metric is available only if feature [[Behavioral_analysis|Behavioral analysis]] is on
|Метрика доступна только при включённой фиче [[Behavioral_analysis|Behavioral analysis]]
|-
|view_renderedImpression
|Rendered impression
|Креатив добавлен в DOM, начал отрисовку и не скрыт через display:none. Метрика доступна только при включённой фиче [[Viewability|Viewability]].
|-
|view_viewableImpression
|Viewable impression
|Не менее 50% площади креатива непрерывно находилось в видимой области viewport не менее 1 секунды (2 секунды для видео). Метрика доступна только при включённой фиче [[Viewability|Viewability]].
|-
|view_viewabilityRate
|Viewable rate
|Отношение viewable impressions к rendered impressions, в процентах. Метрика доступна только при включённой фиче [[Viewability|Viewability]].
|-
|view_inView
|% In view
|Доля площади креатива, находящаяся в видимой области viewport в данный момент. Метрика доступна только при включённой фиче [[Viewability|Viewability]].
|-
|view_viewableTime
|Viewable time
|Медианное время в секундах, в течение которого креатив соответствовал порогу видимости при активной вкладке браузера. Метрика доступна только при включённой фиче [[Viewability|Viewability]].
|-
|view_dwellTime
|Dwell time
|Медианное время в секундах от момента обнаружения креатива на странице до ухода пользователя или закрытия страницы. Метрика доступна только при включённой фиче [[Viewability|Viewability]].
|-
|view_inFocusTime
|In focus time
|Медианное время в секундах, в течение которого вкладка браузера с креативом была активна и видна пользователю. Метрика доступна только при включённой фиче [[Viewability|Viewability]].
|-
|view_videoStart
|Video start
|Фиксируется при первом запуске видео. Повторные запуски после паузы не учитываются. Метрика доступна только при включённой фиче [[Viewability|Viewability]].
|-
|view_videoQ25
|Video 25%
|Пользователь посмотрел не менее 25% длительности видео. Фиксируется один раз за сессию. Метрика доступна только при включённой фиче [[Viewability|Viewability]].
|-
|view_videoQ50
|Video 50%
|Пользователь посмотрел не менее 50% длительности видео. Фиксируется один раз за сессию. Метрика доступна только при включённой фиче [[Viewability|Viewability]].
|-
|view_videoQ75
|Video 75%
|Пользователь посмотрел не менее 75% длительности видео. Фиксируется один раз за сессию. Метрика доступна только при включённой фиче [[Viewability|Viewability]].
|-
|view_videoQ100
|Video 100%
|Пользователь досмотрел видео до конца. Для зацикленных видео фиксируется при первом полном просмотре. Метрика доступна только при включённой фиче [[Viewability|Viewability]].
|-
|view_videoCompletionRate
|Video completion rate
|Доля сессий, в которых видео было досмотрено до конца, среди всех сессий с запуском видео. Метрика доступна только при включённой фиче [[Viewability|Viewability]].
|-
|view_videoTimeInView
|Time in view
|Суммарное время в секундах, когда видео одновременно воспроизводилось, находилось в видимой области viewport и вкладка браузера была в фокусе. Метрика доступна только при включённой фиче [[Viewability|Viewability]].
|-
|view_videoMuted
|Muted
|Статус звука видео: 1 — звук выключен, 0 — звук включён. Обновляется при каждом изменении громкости. Метрика доступна только при включённой фиче [[Viewability|Viewability]].
|-
|view_videoAutoplay
|Autoplay
|Видео запустилось автоматически без действия пользователя. Определяется по атрибуту autoplay. Метрика доступна только при включённой фиче [[Viewability|Viewability]].
|-
|view_videoAudibleTime
|Video audible time
|Суммарное время в секундах, когда видео воспроизводилось со звуком и громкостью больше нуля. Метрика доступна только при включённой фиче [[Viewability|Viewability]].
|-
|feature_hiddenPage
|Hidden Page
|Показывает, открылась ли рекламная страница в скрытой вкладке — True; в активной — False.
|-
|feature_hiddenPagePc
|Hidden Page, %
|Показывает, открылась ли рекламная страница в скрытой вкладке — True; в активной — False.
|}
|}
</div>
```


<div lang="en" dir="ltr" class="mw-content-ltr">
{| class="wikitable mw-collapsible"
{| class="wikitable mw-collapsible"
|+Description <filters>
|+Description <filters>
!Key
!Ключ
!Type
!Тип
!Description
!Описание
|-
|-
|id
|id
|String
|String
|Column by which you would like to filter.
|Колонка, по которой вы хотите фильтровать.
</div>


<div lang="en" dir="ltr" class="mw-content-ltr">
См. возможные значения выше в '''<groups>''' и '''<metrics>'''
See above allowed values in '''<groups>''' and '''<metrics>'''
</div>


<div class="mw-translate-fuzzy">
'''Полный список метрик вы можете получить с помощью этого [[#How_to_get_all_possible_groupings_and_metrics|URL]].'''
|-
|-
|type
|type
Line 1,372: Line 1,423:
|Используется в фильтрах с типом <code>list</code> и <code>binary</code>. Чтобы выводить все строки, кроме тех, в которых встречаются искомые значения.
|Используется в фильтрах с типом <code>list</code> и <code>binary</code>. Чтобы выводить все строки, кроме тех, в которых встречаются искомые значения.
|}
|}
</div>


===== Примеры фильтров =====
===== Примеры фильтров =====

Latest revision as of 08:52, 4 August 2026

Other languages:

Где получить ключ

Подробное описание запросов (request) и ответов (response) по каждому эндпойнту.

Список эндпойнтов:

Method Path Description
OPTIONS /api/stat/get Возвращает все возможные группировки и метрики, сгруппированные по категориям.
POST /api/stat/filter получение данных для фильтра
POST /api/stat/data получение данных для таблицы

Как получить список всех доступных метрик и группировок

Чтобы получить все метрики и группировки, сгруппированные по категориям, воспользуйтесь этим URL:

Method Path
OPTIONS /api/stat/get

Если вы хотите лучше понять, что показывают наши метрики, посетите страницу Metrics and groups.

Запрос

Нет параметров

Ответ

Пример ответа в JSON 

{
   "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

Ключ Тип Описание
success Boolean Был запрос успешным или нет
code Number Статус ответа
msg [String] Сообщение об ошибке
data
data.groups { groupTitle: [<item>, …] } См. ниже описание <item>
data.metrics { metricTitle: [<item>, …] } См. ниже описание <item>
Описание <item>
Ключ Тип Описание
id String <groupTitle или metricTitle>

+ подчёркивание

+ <название метрики или группировки> (groupTitle_id, например: lowQuality_total, feature_adBlock)

icon date | text | number Тип возвращаемого контента
filterType range | list | binary См. ниже описание <filters>
filterSync Boolean * list с поиском на сервере

Как получить все возможные значения фильтра

Чтобы получить значения какого-то фильтра, используйте URL:

Method Path
POST /api/stat/filter

Запрос

Пример запроса в JSON 

{
   "id":"geo_language",
   "searchQuery":"en",
   "dateFrom":"2024-04-10",
   "dateTo":"2024-04-10"
}

API

Ключ Тип Описание
id String Название фильтра
searchQuery String Поисковый запрос
dateFrom String Начиная с какой даты мы должны искать? Дата в формате Y-m-d.
dateTo String По какую дату мы должны искать? Дата в формате Y-m-d.

Ответ

Пример ответа в JSON 

{
   "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

Ключ Тип Описание
success Boolean Был запрос успешным или нет
code Number Статус ответа
msg [String] Сообщение об ошибке
data
data.items [{ id: Number, label: String }] { id: 1, label: "Param A" }

Как запросить статистику

Чтобы получить данные по статистике, воспользуйтесь URL:

Method Path
POST /api/stat/data

Запрос

Пример запроса в JSON 

{
   "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

Ключ Тип Описание
id String Необязательный параметр
name String Необязательный параметр
perPage Number Количество строк, возвращаемых в запросе. Значение по умолчанию 50.
page Number Номер текущей страницы. Значение по умолчанию 1.
groups [String] Группы, которые вы хотите видеть в таблице в виде колонок

Возможные значения см. ниже в <groups>

metrics [String] Метрики, которые вы хотите видеть в таблице в виде колонок

Возможные значения см. ниже в <metrics>

filters
filters.dateFrom String Дата в формате Y-m-d. Если вы указываете period, dateFrom не будет учитываться, потому что period имеет больший приоритет.
filters.dateTo String Дата в формате Y-m-d. Если вы указываете period, dateTo не будет учитываться, потому что period имеет больший приоритет.
filters.period today | yesterday | currentWeek | 7days| month | null Если вы указываете period, то dateFrom и dateTo не будут учитываться. Period имеет больший приоритет.
filters.timezone Number От -12 до +12. Значение по умолчанию равно 0, что значит, что все данные будут возвращены в UTC.
filters.filters [<filters>] См. ниже описание <filters>
compare <compare> См. ниже описание <compare>
Description <groups>
API name Name in UI Comment
time_hour Hour
time_day Day
time_week Week
time_month Month
time_dateTime Date time
sub_integration Integration
sub_botType Bot or fraud type
sub_referer Referer
sub_1 Sub1
sub_2 Sub2
sub_3 Sub3
sub_4 Sub4
sub_5 Sub5
sub_6 Sub6
sub_7 Sub7
sub_8 Sub8 This group is available only if feature Additional subs is on
sub_9 Sub9 This group is available only if feature Additional subs is on
sub_10 Sub10 This group is available only if feature Additional subs is on
sub_conversionType Conversion status This group is available only if feature Conversions is on
sub_cnvId Conversion ID This group is available only if feature Conversions is on
sub_viewType Creative type This metric is available only if feature Viewability is on
geo_language Browsers language
geo_timezonename Browsers time zone
geo_country Country from IP
geo_city City from IP
geo_timezone Time zone from IP
geo_provider Provider from IP
geo_ip Truncated IP We store IP without the last octet
device_browserEngine Real browser engine
device_realOs Real OS
device_connectionType Connection type
device_browser Browser from UA
device_os OS from UA
device_device Device from UA
device_type Device type from UA
device_useragent User agent
screen_width Screen width
screen_height Screen height
screen_orientation Ccreen orientation
screen_pixelDensity Pixel density

```wikitext

Description <metrics>
API name Name in UI Comment
summary_totalVisits Hits
summary_validVisits Good
summary_techLosses Tech. losses
summary_uniqUsers Unique users
summary_validVisitsPc Good, %
summary_techLossesPc Tech. losses, %
summary_uniqUsersPc Unique users, %
bots_total IVT total Боты и фрод, итого
bots_crawler Crawler bots
bots_spoofing Spoofing bots
bots_automated Automated bots
bots_iFrame Incorrect requests
bots_badReputationIp Bad reputation IP bots
bots_blocked Blocked hits
bots_totalPc IVT total, %
bots_crawlerPc Crawler bots, %
bots_spoofingPc Spoofing bots, %
bots_automatedPc Automated bots, %
bots_iFramePc Incorrect requests, %
bots_badReputationIpPc Bad reputation IP bots, %
bots_blockedPc Blocked hits, %
lowQuality_total SV total Подозрительные визиты, итого
lowQuality_proxy Proxy
lowQuality_spoofing Spoofing SV Подозрительные визиты, которые могут быть spoofing
lowQuality_automated Automated SV Подозрительные визиты, которые могут быть automated-ботами
lowQuality_trafficCheats Fraud SV Другие типы подозрительных визитов
lowQuality_totalPc SV total, %
lowQuality_proxyPc Proxy, %
lowQuality_spoofingPc Spoofing SV, %
lowQuality_automatedPc Automated SV, %
lowQuality_trafficCheatsPc Fraud SV, %
conversions_total Conversions Метрика доступна только при включённой фиче Conversions
conversions_l1 L1 Метрика доступна только при включённой фиче Conversions
conversions_l2 L2 Метрика доступна только при включённой фиче Conversions
conversions_l3 L3 Метрика доступна только при включённой фиче Conversions
conversions_l4 L4 Метрика доступна только при включённой фиче Conversions
conversions_totalPc Conversions, % Метрика доступна только при включённой фиче Conversions
conversions_l1Pc L1, % Метрика доступна только при включённой фиче Conversions
conversions_l2Pc L2, % Метрика доступна только при включённой фиче Conversions
conversions_l3Pc L3, % Метрика доступна только при включённой фиче Conversions
conversions_l4Pc L4, % Метрика доступна только при включённой фиче Conversions
feature_adBlock AdBlock
feature_isMobile Is mobile
feature_webView WebView
feature_iFrame IFrame
feature_pushNotifications Push notifications
feature_adBlockPc AdBlock, %
feature_isMobilePc Is mobile, %
feature_webViewPc WebView, %
feature_iFramePc IFrame, %
feature_pushNotificationsPc Push notifications, %
beAn_pageVisibility Visible page Метрика доступна только при включённой фиче Behavioral analysis
beAn_pageActivity Active page Метрика доступна только при включённой фиче Behavioral analysis
beAn_pageAcceptance Accepted page Метрика доступна только при включённой фиче Behavioral analysis
beAn_pageVisibilityPc Visible page, % Метрика доступна только при включённой фиче Behavioral analysis
beAn_pageActivityPc Active page, % Метрика доступна только при включённой фиче Behavioral analysis
beAn_pageAcceptancePc Accepted page, % Метрика доступна только при включённой фиче Behavioral analysis
view_renderedImpression Rendered impression Креатив добавлен в DOM, начал отрисовку и не скрыт через display:none. Метрика доступна только при включённой фиче Viewability.
view_viewableImpression Viewable impression Не менее 50% площади креатива непрерывно находилось в видимой области viewport не менее 1 секунды (2 секунды для видео). Метрика доступна только при включённой фиче Viewability.
view_viewabilityRate Viewable rate Отношение viewable impressions к rendered impressions, в процентах. Метрика доступна только при включённой фиче Viewability.
view_inView % In view Доля площади креатива, находящаяся в видимой области viewport в данный момент. Метрика доступна только при включённой фиче Viewability.
view_viewableTime Viewable time Медианное время в секундах, в течение которого креатив соответствовал порогу видимости при активной вкладке браузера. Метрика доступна только при включённой фиче Viewability.
view_dwellTime Dwell time Медианное время в секундах от момента обнаружения креатива на странице до ухода пользователя или закрытия страницы. Метрика доступна только при включённой фиче Viewability.
view_inFocusTime In focus time Медианное время в секундах, в течение которого вкладка браузера с креативом была активна и видна пользователю. Метрика доступна только при включённой фиче Viewability.
view_videoStart Video start Фиксируется при первом запуске видео. Повторные запуски после паузы не учитываются. Метрика доступна только при включённой фиче Viewability.
view_videoQ25 Video 25% Пользователь посмотрел не менее 25% длительности видео. Фиксируется один раз за сессию. Метрика доступна только при включённой фиче Viewability.
view_videoQ50 Video 50% Пользователь посмотрел не менее 50% длительности видео. Фиксируется один раз за сессию. Метрика доступна только при включённой фиче Viewability.
view_videoQ75 Video 75% Пользователь посмотрел не менее 75% длительности видео. Фиксируется один раз за сессию. Метрика доступна только при включённой фиче Viewability.
view_videoQ100 Video 100% Пользователь досмотрел видео до конца. Для зацикленных видео фиксируется при первом полном просмотре. Метрика доступна только при включённой фиче Viewability.
view_videoCompletionRate Video completion rate Доля сессий, в которых видео было досмотрено до конца, среди всех сессий с запуском видео. Метрика доступна только при включённой фиче Viewability.
view_videoTimeInView Time in view Суммарное время в секундах, когда видео одновременно воспроизводилось, находилось в видимой области viewport и вкладка браузера была в фокусе. Метрика доступна только при включённой фиче Viewability.
view_videoMuted Muted Статус звука видео: 1 — звук выключен, 0 — звук включён. Обновляется при каждом изменении громкости. Метрика доступна только при включённой фиче Viewability.
view_videoAutoplay Autoplay Видео запустилось автоматически без действия пользователя. Определяется по атрибуту autoplay. Метрика доступна только при включённой фиче Viewability.
view_videoAudibleTime Video audible time Суммарное время в секундах, когда видео воспроизводилось со звуком и громкостью больше нуля. Метрика доступна только при включённой фиче Viewability.
feature_hiddenPage Hidden Page Показывает, открылась ли рекламная страница в скрытой вкладке — True; в активной — False.
feature_hiddenPagePc Hidden Page, % Показывает, открылась ли рекламная страница в скрытой вкладке — True; в активной — False.

```

Description <filters>
Ключ Тип Описание
id String Колонка, по которой вы хотите фильтровать.

См. возможные значения выше в <groups> и <metrics>

type range | list | binary
range {from: Number, to: Number} Используется в фильтрах с типом range
include [Any] Используется в фильтрах с типом list и binary. Чтобы выводить только строки, в которых встречаются искомые значения.
exclude [Any] Используется в фильтрах с типом list и binary. Чтобы выводить все строки, кроме тех, в которых встречаются искомые значения.
Примеры фильтров

Тип list, include включён. Ищет визиты только из Камбоджи ("KH") или Китая ("CN"). 

{
   ...
   "filters":{
      "filters":[
         {
            "id":"geo_country",
            "type":"list",
            "include":["KH","CN"],
            "exclude":[]
         }
      ],
      "period":"today",
      "timezone":-3
   }
}

Тип list, exclude включён. Ищет визиты из всех стран, кроме Камбоджи ("KH") и Китая ("CN"). 

{
   ...
   "filters":{
      "filters":[
         {
            "id":"geo_country",
            "type":"list",
            "include":[],
            "exclude":["KH","CN"]
         }
      ],
      "period":"today",
      "timezone":-3
   }
}

Тип binary, include включён. Ищет визиты, которые были совершены краулерами (то есть ботами поисковых систем и социальных сетей). 

{
   ...
   "filters":{
      "filters":[
         {
            "id":"bots_crawler",
            "type":"binary",
            "include":[1],
            "exclude":[]
         }
      ],
      "period":"today",
      "timezone":-3
   }
}

Тип binary, exclude включён. Не показывает визиты, совершённые краулерами. 

{
   ...
   "filters":{
      "filters":[
         {
            "id":"bots_crawler",
            "type":"binary",
            "include":[],
            "exclude":[1]
         }
      ],
      "period":"today",
      "timezone":-3
   }
}

Тип range. Ищет срезы, на которых общее количество ботовых визитов находится между одной и десятью тысячами. 

{
   ...
   "filters":{
      "filters":[
         {
            "id":"bots_total",
            "type":"range",
            "range":{
               "from":1000,
               "to":10000
            }
         }
      ],
      "period":"today",
      "timezone":-3
   }
}

Тип range. Ищет срезы, на которых более 50% визитов совершены с мобильных устройств. 

{
   ...
   "filters":{
      "filters":[
         {
            "id":"feature_isMobilePc",
            "type":"range",
            "range":{
               "from":50,
               "to":null
            }
         }
      ],
      "period":"today",
      "timezone":-3
   }
}

Тип range. Ищет визиты, совершённые до 10 часов утра по UTC-3. 

{
   ...
   "filters":{
      "filters":[
         {
            "id":"time_hour",
            "type":"range",
            "range":{
               "from":null,
               "to":10
            }
         }
      ],
      "period":"today",
      "timezone":-3
   }
}
Описание <compare>
Ключ Тип Описание
dateFrom String Дата в формате Y-m-d
dateTo String Дата в формате Y-m-d
mode compare_value | diff | percent
sort Boolean

Ответ

Примера ответа в JSON 

{
   "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

Ключ Тип Описание
success Boolean Был запрос успешным или нет
code Number Статус ответа
msg [String] Сообщение об ошибке
data
data.rows [<row>] Описание строк таблицы
data.totalRows Number Общее количество строк в таблице
data.total <row> Сумма по каждой колонке с учётом невидимых строк
data.page Number Текущая страница
data.perPage Number Количество элементов на странице
data.columns [<column>] Описание столбцов таблицы
Description <row>
Ключ Тип Описание
value String Значение в человеко-читаемом виде
rawValue String Сырое значение
diff String | null
percent Number | null Является значение процентом или нет
compare_value String | null Сравниваемое значение (в случае, если запрос отправлен в режиме compare)
Описание <column>
Ключ Тип Описание
field String ID метрики или группировки
type String | Number | Float
sortable Boolean Можно сортировать или нет
unit String | null Единица измерения.

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

Примеры запросов.

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)
Retrieved from "https://wiki.kaminari.click/index.php?title=Stat_API/ru&oldid=1519"