Stat API/ru: Difference between revisions

From Wiki Kaminari Click
(Created page with "=== '''POST /api/stat/filter''' === ===== Request ===== {| class="wikitable mw-collapsible" !Key !Type !Description |- |id |String |Название фильтра |- |searchQuery |String |Поисковой запрос |}")
 
No edit summary
 
(23 intermediate revisions by 2 users not shown)
Line 2: Line 2:
'''[https://kaminari.click/user Где получить ключ]'''  
'''[https://kaminari.click/user Где получить ключ]'''  


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


=== '''Список эндпойнтов:''' ===
=== '''Список эндпойнтов:''' ===
Line 15: Line 15:
|}
|}


=== '''OPTIONS /api/stat/get''' ===
== Как получить список всех доступных метрик и группировок ==
===== Request =====
Чтобы получить все метрики и группировки, сгруппированные по категориям, воспользуйтесь этим URL:
нет параметров
{| class="wikitable"
! Method !! Path
|-
| OPTIONS || /api/stat/get
|}
 
'''Если вы хотите лучше понять, что показывают наши метрики, посетите страницу [[Metrics_and_groups|Metrics and groups]].'''
 
=== Запрос ===
''Нет параметров''
 
=== Ответ ===
<div class="mw-collapsible mw-collapsed" style="width:80%; overflow:auto;">
Пример ответа в JSON
<pre class="mw-collapsible-content">
{
  "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
            }
        ]
      }
  }
}
</pre>
</div>


===== Response =====
==== API ====
{| class="wikitable mw-collapsible"
{| class="wikitable"
! Key !! Type !! Description
! Ключ !! Тип !! Описание
|-
|-
| success || Boolean
| success || Boolean || Был запрос успешным или нет
|-
|-
|code
| code || Number || Статус ответа
|
|
|-
|-
|msg
|msg || [String] || Сообщение об ошибке
|
|
|-
|-
| colspan="3" |data
| colspan="3" |data
Line 42: Line 615:
|{ metricTitle: ['''<item>''', …] }
|{ metricTitle: ['''<item>''', …] }
|См. ниже описание '''<item>'''
|См. ниже описание '''<item>'''
|-
|data.periods
|[ 'today', 'yesterday', '7days', 'currentWeek', 'month' ]
|
|}
|}
{| class="wikitable mw-collapsible"
{| class="wikitable mw-collapsible"
|+Описание '''<item>'''
|+Описание '''<item>'''
!Key
!Ключ
!Type
!Тип
!Description
!Описание
|-
|-
|id
|id
|String
|String
|<groupTitle или metricTitle>
|<groupTitle или metricTitle>
+ подчёркивание  
+ подчёркивание


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


|-
|-
|icon
|icon
|<code>date</code><nowiki> | </nowiki><code>text</code><nowiki> | </nowiki><code>number</code>
|<code>date</code><nowiki> | </nowiki><code>text</code><nowiki> | </nowiki><code>number</code>
|Иконка типа
|Тип возвращаемого контента
|-
|sources
|[Number]
|
|-
|-
|filterType
|filterType
|<code>range</code><nowiki> | </nowiki><code>list</code><nowiki> | </nowiki><code>value</code><nowiki> | </nowiki><code>value_like</code><nowiki> | </nowiki><code>value_combined</code>
|<code>range</code><nowiki> | </nowiki><code>list</code><nowiki> | </nowiki><code>binary</code>
|см. Описание filterType
|См. ниже описание '''<filters>'''
|-
|-
|filterSync
|filterSync
Line 78: Line 644:
|}
|}


=== '''POST /api/stat/filter''' ===
== Как получить все возможные значения фильтра ==
===== Request =====
Чтобы получить значения какого-то фильтра, используйте URL:
{| class="wikitable mw-collapsible"
{| class="wikitable"
!Key
! Method !! Path
!Type
|-
!Description
| POST || /api/stat/filter
|}
 
=== Запрос ===
<div class="mw-collapsible" style="width:80%; overflow:auto;">
Пример запроса в JSON
<pre class="mw-collapsible-content">
{
  "id":"geo_language",
  "searchQuery":"en",
  "dateFrom":"2024-04-10",
  "dateTo":"2024-04-10"
}
</pre>
</div>
 
==== API ====
{| class="wikitable"
!Ключ
!Тип
!Описание
|-
|-
|id
|id
Line 91: Line 677:
|searchQuery
|searchQuery
|String
|String
|Поисковой запрос
|Поисковый запрос
|-
|dateFrom
|String
|Начиная с какой даты мы должны искать? Дата в формате Y-m-d.
|-
|dateTo
|String
|По какую дату мы должны искать? Дата в формате Y-m-d.
|}
|}


===== Response =====
=== Ответ ===
{| class="wikitable mw-collapsible"
<div class="mw-collapsible mw-collapsed" style="width:80%; overflow:auto;">
!Key
Пример ответа в JSON
!Type
<pre class="mw-collapsible-content">
!Description
{
  "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"
        }
      ]
  }
}
</pre>
</div>
 
==== API ====
{| class="wikitable"
! Ключ !! Тип !! Описание
|-
|-
|success
| success || Boolean || Был запрос успешным или нет
|Boolean
|
|-
|-
|code
| code || Number || Статус ответа
|
|
|-
|-
|msg
|msg || [String] || Сообщение об ошибке
|
|
|-
|-
| colspan="3" |data
| colspan="3" |data
Line 119: Line 809:
|}
|}


=== '''POST /api/stat/data''' ===
== Как запросить статистику ==
{| class="wikitable mw-collapsible"
Чтобы получить данные по статистике, воспользуйтесь URL:
|+Request
{| class="wikitable"
!Key
! Method !! Path
!Type
|-
!Description
| POST || /api/stat/data
|}
 
=== Запрос ===
<div class="mw-collapsible mw-collapsed" style="width:80%; overflow:auto;">
Пример запроса в JSON
<pre class="mw-collapsible-content">
{
  "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
}
</pre>
</div>
 
==== API ====
{| class="wikitable"
!Ключ
!Тип
!Описание
|-
|-
|id
|id
|String
|String
|
|Необязательный параметр
|-
|-
|name
|name
|String
|String
|
|Необязательный параметр
|-
|-
|perPage
|perPage
|Number
|Number
|Значение по умолчанию 50
|Количество строк, возвращаемых в запросе. Значение по умолчанию 50.
|-
|-
|page
|page
|Number
|Number
|Значение по умолчанию 1
|Номер текущей страницы. Значение по умолчанию 1.
|-
|groups
|[String]
|Группы, которые вы хотите видеть в таблице в виде колонок
 
Возможные значения см. ниже в '''<groups>'''
 
|-
|-
|metrics
|metrics
|[String]
|[String]
|
|Метрики, которые вы хотите видеть в таблице в виде колонок
 
Возможные значения см. ниже в '''<metrics>'''
 
|-
|-
| colspan="3" |filters
| colspan="3" |filters
|-
|-
|dateFrom
|filters.dateFrom
|String
|String
|Дата в формате Y-m-d
|Дата в формате Y-m-d. Если вы указываете period, dateFrom не будет учитываться, потому что period имеет больший приоритет.
|-
|-
|dateTo
|filters.dateTo
|String
|String
|Дата в формате Y-m-d
|Дата в формате Y-m-d. Если вы указываете period, dateTo не будет учитываться, потому что period имеет больший приоритет.
|-
|filters.period
|<nowiki>today | yesterday | currentWeek | 7days| month | null</nowiki>
|Если вы указываете period, то dateFrom и dateTo не будут учитываться. Period имеет больший приоритет.
|-
|filters.timezone
|Number
|От -12 до +12. Значение по умолчанию равно 0, что значит, что все данные будут возвращены в UTC.
|-
|-
|filters.filters
|filters.filters
|'''<filters>'''
|['''<filters>''']
|См. ниже описание '''<filters>'''
|-
|compare
|'''<compare>'''
|См. ниже описание '''<compare>'''
|}
 
{| class="wikitable"
|+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|Additional subs]] is on
|-
|sub_9
|Sub9
|This group is available only if feature [[Additional_subs|Additional subs]] is on
|-
|sub_10
|Sub10
|This group is available only if feature [[Additional_subs|Additional subs]] is on
|-
|sub_conversionType
|Conversion status
|This group is available only if feature [[Conversions|Conversions]] is on
|-
|sub_cnvId
|Conversion ID
|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
|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
|
|}
 
{| class="wikitable"
|+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 and fraud 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
|Suspicious visits total
|-
|lowQuality_proxy
|Proxy
|
|-
|lowQuality_spoofing
|Spoofing SV
|Suspicious visits, that may be spoofing
|-
|lowQuality_automated
|Automated SV
|Suspicious visits, that may be automated bots
|-
|lowQuality_trafficCheats
|Fraud SV
|Other types of suspicious visits
|-
|lowQuality_totalPc
|SV total, %
|
|-
|lowQuality_proxyPc
|Proxy, %
|
|-
|lowQuality_spoofingPc
|Spoofing SV, %
|
|-
|lowQuality_automatedPc
|Automated SV, %
|
|-
|lowQuality_trafficCheatsPc
|Fraud SV, %
|
|-
|conversions_total
|Conversions
|This metric is available only if feature [[Conversions|Conversions]] is on
|-
|conversions_l1
|L1
|This metric is available only if feature [[Conversions|Conversions]] is on
|-
|conversions_l2
|L2
|This metric is available only if feature [[Conversions|Conversions]] is on
|-
|conversions_l3
|L3
|This metric is available only if feature [[Conversions|Conversions]] is on
|-
|conversions_l4
|L4
|This metric is available only if feature [[Conversions|Conversions]] is on
|-
|conversions_totalPc
|Conversions, %
|This metric is available only if feature [[Conversions|Conversions]] is on
|-
|conversions_l1Pc
|L1, %
|This metric is available only if feature [[Conversions|Conversions]] is on
|-
|conversions_l2Pc
|L2, %
|This metric is available only if feature [[Conversions|Conversions]] is on
|-
|conversions_l3Pc
|L3, %
|This metric is available only if feature [[Conversions|Conversions]] is on
|-
|conversions_l4Pc
|L4, %
|This metric is available only if feature [[Conversions|Conversions]] is on
|-
|feature_adBlock
|AdBlock
|
|-
|feature_isMobile
|Is mobile
|
|-
|feature_webView
|WebView
|
|-
|feature_iFrame
|IFrame
|
|-
|feature_pushNotifications
|Push notifications
|
|-
|feature_adBlockPc
|AdBlock, %
|
|
|-
|-
|period
|feature_isMobilePc
|<nowiki>today | yesterday | currentWeek | 7days| month | null</nowiki>
|Is mobile, %
|
|
|-
|-
|timezone
|feature_webViewPc
|Number
|WebView, %
|От -12 до +12
|
|-
|-
|groups
|feature_iFramePc
|[String]
|IFrame, %
|'''Допустимые значения:'''
|
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
|feature_pushNotificationsPc
|'''<compare>'''
|Push notifications, %
|
|
|-
|beAn_pageVisibility
|Visible page
|This metric is available only if feature [[Behavioral_analysis|Behavioral analysis]] is on
|-
|beAn_pageActivity
|Active page
|This metric is available only if feature [[Behavioral_analysis|Behavioral analysis]] is on
|-
|beAn_pageAcceptance
|Accepted page
|This metric is available only if feature [[Behavioral_analysis|Behavioral analysis]] is on
|-
|beAn_pageVisibilityPc
|Visible page, %
|This metric is available only if feature [[Behavioral_analysis|Behavioral analysis]] is on
|-
|beAn_pageActivityPc
|Active page, %
|This metric is available only if feature [[Behavioral_analysis|Behavioral analysis]] is on
|-
|beAn_pageAcceptancePc
|Accepted page, %
|This metric is available only if feature [[Behavioral_analysis|Behavioral analysis]] is on
|-
|view_renderedImpression
|Rendered impression
|The creative has been added to the DOM and started rendering, and is not hidden via display:none. This metric is available only if feature [[Viewability|Viewability]] is on.
|-
|view_viewableImpression
|Viewable impression
|At least 50% of the creative area was within the visible viewport continuously for at least 1 second (2 seconds for video). This metric is available only if feature [[Viewability|Viewability]] is on.
|-
|view_viewabilityRate
|Viewable rate
|The ratio of viewable impressions to total rendered impressions, expressed as a percentage. This metric is available only if feature [[Viewability|Viewability]] is on.
|-
|view_inView
|% In view
|The share of the creative area currently within the visible viewport at a given moment. This metric is available only if feature [[Viewability|Viewability]] is on.
|-
|view_viewableTime
|Viewable time
|Median time in seconds during which the creative met the visibility threshold with the browser tab in the foreground. This metric is available only if feature [[Viewability|Viewability]] is on.
|-
|view_dwellTime
|Dwell time
|Median time in seconds from the moment the creative was found on the page until the user left or closed the page. This metric is available only if feature [[Viewability|Viewability]] is on.
|-
|view_inFocusTime
|In focus time
|Median time in seconds during which the browser tab containing the creative was active and visible to the user. This metric is available only if feature [[Viewability|Viewability]] is on.
|-
|view_videoStart
|Video start
|Recorded on the first playback of the video. Subsequent plays after pause are not counted. This metric is available only if feature [[Viewability|Viewability]] is on.
|-
|view_videoQ25
|Video 25%
|The user has watched at least 25% of the video duration. Recorded once per session. This metric is available only if feature [[Viewability|Viewability]] is on.
|-
|view_videoQ50
|Video 50%
|The user has watched at least 50% of the video duration. Recorded once per session. This metric is available only if feature [[Viewability|Viewability]] is on.
|-
|view_videoQ75
|Video 75%
|The user has watched at least 75% of the video duration. Recorded once per session. This metric is available only if feature [[Viewability|Viewability]] is on.
|-
|view_videoQ100
|Video 100%
|The user watched the video to the end. For looped videos, recorded on the first complete playthrough. This metric is available only if feature [[Viewability|Viewability]] is on.
|-
|view_videoCompletionRate
|Video completion rate
|The share of sessions in which the video was watched to completion, out of all sessions where the video was started. This metric is available only if feature [[Viewability|Viewability]] is on.
|-
|view_videoTimeInView
|Time in view
|Total seconds during which the video was simultaneously playing, within the visible viewport, and the browser tab was in focus. This metric is available only if feature [[Viewability|Viewability]] is on.
|-
|view_videoMuted
|Muted
|Audio status of the video: 1 — sound is muted, 0 — sound is on. Updated on every volume change event. This metric is available only if feature [[Viewability|Viewability]] is on.
|-
|view_videoAutoplay
|Autoplay
|Indicates that the video started playing automatically without user interaction. Determined by the autoplay attribute. This metric is available only if feature [[Viewability|Viewability]] is on.
|-
|view_videoAudibleTime
|Video audible time
|Total seconds during which the video was playing with sound unmuted and volume greater than zero. This metric is available only if feature [[Viewability|Viewability]] is on.
|}
|}
{| class="wikitable mw-collapsible"
{| class="wikitable mw-collapsible"
|+Описание <filters>
|+Description <filters>
!Key
!Ключ
!Type
!Тип
!Description
!Описание
|-
|-
|id
|id
|String
|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
 
См. возможные значения выше в '''<groups>''' и '''<metrics>'''
 
|-
|-
|type
|type
|String
|<code>range</code><nowiki> | </nowiki><code>list</code><nowiki> | </nowiki><code>binary</code>
|
|
|-
|-
|range
|range
|{from: Number, to: Number}
|{from: Number, to: Number}
|
|Используется в фильтрах с типом <code>range</code>
|-
|include
|[Any]
|Используется в фильтрах с типом <code>list</code> и <code>binary</code>. Чтобы выводить только строки, в которых встречаются искомые значения.
|-
|exclude
|[Any]
|Используется в фильтрах с типом <code>list</code> и <code>binary</code>. Чтобы выводить все строки, кроме тех, в которых встречаются искомые значения.
|}
|}
===== Примеры фильтров =====
'''Тип <code>list</code>, include включён.''' Ищет визиты только из Камбоджи ("KH") или Китая ("CN").
<pre>
{
  ...
  "filters":{
      "filters":[
        {
            "id":"geo_country",
            "type":"list",
            "include":["KH","CN"],
            "exclude":[]
        }
      ],
      "period":"today",
      "timezone":-3
  }
}
</pre>
'''Тип <code>list</code>, exclude включён.''' Ищет визиты из всех стран, кроме Камбоджи ("KH") и Китая ("CN").
<pre>
{
  ...
  "filters":{
      "filters":[
        {
            "id":"geo_country",
            "type":"list",
            "include":[],
            "exclude":["KH","CN"]
        }
      ],
      "period":"today",
      "timezone":-3
  }
}
</pre>
'''Тип <code>binary</code>, include включён.'''
Ищет визиты, которые были совершены краулерами (то есть ботами поисковых систем и социальных сетей).
<pre>
{
  ...
  "filters":{
      "filters":[
        {
            "id":"bots_crawler",
            "type":"binary",
            "include":[1],
            "exclude":[]
        }
      ],
      "period":"today",
      "timezone":-3
  }
}
</pre>
'''Тип <code>binary</code>, exclude включён.''' Не показывает визиты, совершённые краулерами.
<pre>
{
  ...
  "filters":{
      "filters":[
        {
            "id":"bots_crawler",
            "type":"binary",
            "include":[],
            "exclude":[1]
        }
      ],
      "period":"today",
      "timezone":-3
  }
}
</pre>
'''Тип <code>range</code>.''' Ищет срезы, на которых общее количество ботовых визитов находится между одной и десятью тысячами.
<pre>
{
  ...
  "filters":{
      "filters":[
        {
            "id":"bots_total",
            "type":"range",
            "range":{
              "from":1000,
              "to":10000
            }
        }
      ],
      "period":"today",
      "timezone":-3
  }
}
</pre>
Тип <code>range</code>. Ищет срезы, на которых более 50% визитов совершены с мобильных устройств.
<pre>
{
  ...
  "filters":{
      "filters":[
        {
            "id":"feature_isMobilePc",
            "type":"range",
            "range":{
              "from":50,
              "to":null
            }
        }
      ],
      "period":"today",
      "timezone":-3
  }
}
</pre>
Тип <code>range</code>. Ищет визиты, совершённые до 10 часов утра по UTC-3.
<pre>
{
  ...
  "filters":{
      "filters":[
        {
            "id":"time_hour",
            "type":"range",
            "range":{
              "from":null,
              "to":10
            }
        }
      ],
      "period":"today",
      "timezone":-3
  }
}
</pre>
{| class="wikitable mw-collapsible"
{| class="wikitable mw-collapsible"
|+Описание <compare>
|+Описание <compare>
!Key
!Ключ
!Type
!Тип
!Description
!Описание
|-
|-
|dateFrom
|dateFrom
Line 218: Line 1,577:
|
|
|}
|}
{| class="wikitable mw-collapsible"
 
|+Response
=== Ответ ===
!Key
<div class="mw-collapsible mw-collapsed" style="width:80%; overflow:auto;">
!Type
Примера ответа в JSON
!Description
<pre class="mw-collapsible-content">
{
  "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
        }
      }
  }
}
</pre>
</div>
 
==== API ====
{| class="wikitable"
! Ключ !! Тип !! Описание
|-
|-
|success
| success || Boolean || Был запрос успешным или нет
|Boolean
|
|-
|-
|code
| code || Number || Статус ответа
|
|
|-
|-
|msg
|msg || [String] || Сообщение об ошибке
|
|
|-
|-
| colspan="3" |data
| colspan="3" |data
Line 244: Line 2,938:
|data.totalRows
|data.totalRows
|Number
|Number
|Общее количество элементов в таблице
|Общее количество строк в таблице
|-
|-
|data.total
|data.total
Line 260: Line 2,954:
|data.columns
|data.columns
|['''<column>''']
|['''<column>''']
|Описание столбцов
|Описание столбцов таблицы
|}
|}
{| class="wikitable mw-collapsible"
{| class="wikitable mw-collapsible"
|+
|+
Описание <row>
Description <row>
!Key
!Ключ
!Type
!Тип
!Description
!Описание
|-
|-
|value
|value
|String
|String
|
|Значение в человеко-читаемом виде
|-
|rawValue
|String
|Сырое значение
|-
|-
|diff
|diff
Line 279: Line 2,977:
|percent
|percent
|<nowiki>Number | null</nowiki>
|<nowiki>Number | null</nowiki>
|
|Является значение процентом или нет
|-
|-
|compare_value
|compare_value
|<nowiki>String | null</nowiki>
|<nowiki>String | null</nowiki>
|
|Сравниваемое значение (в случае, если запрос отправлен в режиме compare)
|}
|}
{| class="wikitable mw-collapsible"
{| class="wikitable mw-collapsible"
|+
|+
Описание <column>
Описание <column>
!Key
!Ключ
!Type
!Тип
!Description
!Описание
|-
|-
|field
|field
Line 297: Line 2,995:
|-
|-
|type
|type
|<nowiki>string | number | float</nowiki>
|<nowiki>String | Number | Float</nowiki>
|
|
|-
|-
Line 307: Line 3,005:
|<nowiki>String | null</nowiki>
|<nowiki>String | null</nowiki>
|Единица измерения.
|Единица измерения.
Например, % у процентных столбцов.
Например, % у процентных столбцов
|}
|}


<span id="Request_examples"></span>
=== '''Примеры запросов.''' ===
=== '''Примеры запросов.''' ===


Line 325: Line 3,024:
</pre>
</pre>


==== NodeJS ====
=== NodeJS ===
  const https = require('https');
  const https = require('https');
   
   
Line 356: Line 3,055:
  <nowiki> </nowiki>  });
  <nowiki> </nowiki>  });


==== PHP ====
=== PHP ===
  <?php
  <?php
  $ch = curl_init();
  $ch = curl_init();
Line 370: Line 3,069:
  curl_close($ch);
  curl_close($ch);


==== Python ====
=== Python ===
  import requests
  import requests
   
   
Line 379: Line 3,078:
  response = requests.options('<nowiki>https://kaminari.click/api/stat/get'</nowiki>, headers=headers)
  response = requests.options('<nowiki>https://kaminari.click/api/stat/get'</nowiki>, headers=headers)
  response = requests.options('<nowiki>http://Authorization</nowiki>: Bearer <YOUR API_TOKEN>', headers=headers)
  response = requests.options('<nowiki>http://Authorization</nowiki>: Bearer <YOUR API_TOKEN>', headers=headers)
[[Category:Private]]

Latest revision as of 14:20, 1 July 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
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 and fraud 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 Suspicious visits total
lowQuality_proxy Proxy
lowQuality_spoofing Spoofing SV Suspicious visits, that may be spoofing
lowQuality_automated Automated SV Suspicious visits, that may be automated bots
lowQuality_trafficCheats Fraud SV Other types of suspicious visits
lowQuality_totalPc SV total, %
lowQuality_proxyPc Proxy, %
lowQuality_spoofingPc Spoofing SV, %
lowQuality_automatedPc Automated SV, %
lowQuality_trafficCheatsPc Fraud SV, %
conversions_total Conversions This metric is available only if feature Conversions is on
conversions_l1 L1 This metric is available only if feature Conversions is on
conversions_l2 L2 This metric is available only if feature Conversions is on
conversions_l3 L3 This metric is available only if feature Conversions is on
conversions_l4 L4 This metric is available only if feature Conversions is on
conversions_totalPc Conversions, % This metric is available only if feature Conversions is on
conversions_l1Pc L1, % This metric is available only if feature Conversions is on
conversions_l2Pc L2, % This metric is available only if feature Conversions is on
conversions_l3Pc L3, % This metric is available only if feature Conversions is on
conversions_l4Pc L4, % This metric is available only if feature Conversions is on
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 This metric is available only if feature Behavioral analysis is on
beAn_pageActivity Active page This metric is available only if feature Behavioral analysis is on
beAn_pageAcceptance Accepted page This metric is available only if feature Behavioral analysis is on
beAn_pageVisibilityPc Visible page, % This metric is available only if feature Behavioral analysis is on
beAn_pageActivityPc Active page, % This metric is available only if feature Behavioral analysis is on
beAn_pageAcceptancePc Accepted page, % This metric is available only if feature Behavioral analysis is on
view_renderedImpression Rendered impression The creative has been added to the DOM and started rendering, and is not hidden via display:none. This metric is available only if feature Viewability is on.
view_viewableImpression Viewable impression At least 50% of the creative area was within the visible viewport continuously for at least 1 second (2 seconds for video). This metric is available only if feature Viewability is on.
view_viewabilityRate Viewable rate The ratio of viewable impressions to total rendered impressions, expressed as a percentage. This metric is available only if feature Viewability is on.
view_inView % In view The share of the creative area currently within the visible viewport at a given moment. This metric is available only if feature Viewability is on.
view_viewableTime Viewable time Median time in seconds during which the creative met the visibility threshold with the browser tab in the foreground. This metric is available only if feature Viewability is on.
view_dwellTime Dwell time Median time in seconds from the moment the creative was found on the page until the user left or closed the page. This metric is available only if feature Viewability is on.
view_inFocusTime In focus time Median time in seconds during which the browser tab containing the creative was active and visible to the user. This metric is available only if feature Viewability is on.
view_videoStart Video start Recorded on the first playback of the video. Subsequent plays after pause are not counted. This metric is available only if feature Viewability is on.
view_videoQ25 Video 25% The user has watched at least 25% of the video duration. Recorded once per session. This metric is available only if feature Viewability is on.
view_videoQ50 Video 50% The user has watched at least 50% of the video duration. Recorded once per session. This metric is available only if feature Viewability is on.
view_videoQ75 Video 75% The user has watched at least 75% of the video duration. Recorded once per session. This metric is available only if feature Viewability is on.
view_videoQ100 Video 100% The user watched the video to the end. For looped videos, recorded on the first complete playthrough. This metric is available only if feature Viewability is on.
view_videoCompletionRate Video completion rate The share of sessions in which the video was watched to completion, out of all sessions where the video was started. This metric is available only if feature Viewability is on.
view_videoTimeInView Time in view Total seconds during which the video was simultaneously playing, within the visible viewport, and the browser tab was in focus. This metric is available only if feature Viewability is on.
view_videoMuted Muted Audio status of the video: 1 — sound is muted, 0 — sound is on. Updated on every volume change event. This metric is available only if feature Viewability is on.
view_videoAutoplay Autoplay Indicates that the video started playing automatically without user interaction. Determined by the autoplay attribute. This metric is available only if feature Viewability is on.
view_videoAudibleTime Video audible time Total seconds during which the video was playing with sound unmuted and volume greater than zero. This metric is available only if feature Viewability is on.
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=1514"