Wiki Kaminari Click - User contributions [en]

Ping back URL/ru

2026-05-05T09:30:31Z

FuzzyBot: Updating to match new version of source page

<languages/>
Если вы хотите получать на свой URL результат проверки по каждому клику, это можно сделать с помощью опции '''Ping-back URL'''.

= Подключение опции =
Закажите у менеджера включение опции '''Ping-back URL''' на своей интеграции.

После того как её включат, укажите в настройках свой URL.

[[File:Ping back url.png]]

== kmnrId ==
Чтобы понимать какой показ мы проверили вам надо пометить его.

Если у вас интеграция типа '''JS check''', то добавьте в <code>window.kmnr</code> ключ <code>kmnrId</code> с любым удобным для вас уникальным идентификатором, по которому сможете потом узнать показ.

[[File:Ping back url2.png]]

В интеграции типа '''Redirect''' добавьте kmnrId в URL:

<pre>https://kaminari.systems/v1/click?kmnrKey=111111111&kmnrId=IMPRESSION_UNIQ_ID&u=https%3A%2F%2Fsome.url</pre>

Допустимые символы: <code>[A-Za-z0-9_]</code> латинские буквы, арабские цифры, знак подчёркивания. Максимальная длина — 200 символов.

= Формат ответа =
После того, как мы получили, обработали данные и вынесли решение о ботовости клика, мы отсылаем решение вам в формате JSON POST.
<pre>{
"kmnrId": "50d9ecc6-402b-4a74-9397-fc20f2980567",
"kmnrKey": 111111111,
"fraud": 1,
"block": 1,
"sub1": "sub1 value",
"sub2": "sub2 value",
"sub3": "sub3 value",
"sub4": 444,
"sub5": 555,
"sub6": "",
"sub7": ""
}</pre>

По kmnrId и меткам вы сможете найти показ на своей стороне.

<div class="mw-translate-fuzzy">
{| class="wikitable"
|-
! Название !! Значение
|-
| kmnrId || kmnrId, уникальный идентификатор
|-
| kmnrKey || Идентификатор интеграции
|-
| fraud || 1 если переход фродовый, 0 если переход нефродовый, -1 если переход не удалось проверить
|-
| block || 1 если переход был заблокирован в соответствии с настройками интеграции, 0 если переход не был заблокирован
|-
| sub1 || метки, отправленные нам вместе с запросом
|-
| sub2 || ...
|-
| sub3 || ...
|-
| sub4 || ...
|-
| sub5 || ...
|-
| sub6 || ...
|-
| sub7 || ...
|}
</div>

<div class="mw-translate-fuzzy">
После успешного получения ping-back ваш сервер должен ответить статусом 200. Иначе мы попробуем ещё три раза отправить запрос.

Если ping-back по-прежнему не может быть доставлен, вы всегда можете получить статус любого клика через наш API, который служит надежным источником информации независимо от успешности доставки.
</div>

[[Category:Features]]

Ping back URL/en

2026-05-05T09:30:29Z

FuzzyBot: Updating to match new version of source page

<languages/>
If you want to receive the verification results for each click on your own URL, you can do so using the '''Ping-back URL''' option.

= Option activation =
Ask your manager to activate the '''Ping-back URL''' option on your integration.

Once enabled, specify your URL in the settings.

[[File:Ping back url.png]]

== kmnrId ==
To understand which impression we've checked, you need to mark it.

If you have an '''JS check'''-type integration, add the <code>kmnrId</code> key to <code>window.kmnr</code> with any unique identifier convenient for you. By this identifier you can later recognize the impression.

[[File:Ping back url2.png]]

If you have an '''Redirect'''-type integration, add kmnrId to URL:

<pre>https://kaminari.systems/v1/click?kmnrKey=111111111&kmnrId=IMPRESSION_UNIQ_ID&u=https%3A%2F%2Fsome.url</pre>

Acceptable characters: [A-Za-z0-9_] Latin letters, Arabic numerals, underscore. Maximum length is 200 characters.

= Response format =
After receiving, processing the data, and making a decision about the bot status of the click, we send the decision to you in JSON POST format.
<pre>{
"kmnrId": "50d9ecc6-402b-4a74-9397-fc20f2980567",
"kmnrKey": 111111111,
"fraud": 1,
"block": 1,
"sub1": "sub1 value",
"sub2": "sub2 value",
"sub3": "sub3 value",
"sub4": 444,
"sub5": 555,
"sub6": "",
"sub7": ""
}</pre>

By kmnrId and sub-tags you can find the impression in your stat.

{| class="wikitable"
|-
! Name !! Value
|-
| kmnrId || Unique identifier convenient for you
|-
| kmnrKey || Integration identifier
|-
| fraud || 1 if the hit is fraudulent, 0 if the hit is non-fraudulent,
|-
| block || 1 if the hit was blocked according to the integration settings, 0 if the hit wasn't blocked
|-
| sub1 || Sub-tags that were sent with the hit
|-
| sub2 || ...
|-
| sub3 || ...
|-
| sub4 || ...
|-
| sub5 || ...
|-
| sub6 || ...
|-
| sub7 || ...
|}

If you receive a ping-back, your server should respond with a status 200. Otherwise, we make three more attempts to send the request. If the ping-back still cannot be delivered, you can always retrieve the status for any click via our API, which serves as the reliable source of truth regardless of delivery success.

[[Category:Features]]

Translations:Ping back URL/15/en

2026-05-05T09:30:25Z

FuzzyBot: Importing a new version from external source

If you receive a ping-back, your server should respond with a status 200. Otherwise, we make three more attempts to send the request. If the ping-back still cannot be delivered, you can always retrieve the status for any click via our API, which serves as the reliable source of truth regardless of delivery success.

Translations:Ping back URL/5/en

2026-05-05T09:30:25Z

FuzzyBot: Importing a new version from external source

{| class="wikitable"
|-
! Name !! Value
|-
| kmnrId || Unique identifier convenient for you
|-
| kmnrKey || Integration identifier
|-
| fraud || 1 if the hit is fraudulent, 0 if the hit is non-fraudulent,
|-
| block || 1 if the hit was blocked according to the integration settings, 0 if the hit wasn't blocked
|-
| sub1 || Sub-tags that were sent with the hit
|-
| sub2 || ...
|-
| sub3 || ...
|-
| sub4 || ...
|-
| sub5 || ...
|-
| sub6 || ...
|-
| sub7 || ...
|}

Stat API/en

2026-02-19T07:11:31Z

FuzzyBot: Updating to match new version of source page

<languages/>
'''[https://kaminari.click/user How to obtain the token]'''

'''[https://kaminari.click/api Detailed description of the requests and responses for each endpoint].'''

=== '''Endpoint list:''' ===
{| class="wikitable"
! Method !! Path !! Description
|-
| OPTIONS || /api/stat/get || Returns all possible groupings and metrics grouped by categories
|-
| POST || /api/stat/filter || Obtaining data for filter
|-
| POST || /api/stat/data || Obtaining data for the table
|}

== How to get all possible groupings and metrics ==
To obtain all possible groupings and metrics grouped by categories use this URL:
{| class="wikitable"
! Method !! Path
|-
| OPTIONS || /api/stat/get
|}

'''If you want to better understand what our metrics mean, visit page [[Metrics_and_groups|Metrics and groups]].'''

=== Request ===
''No parameters''

=== Response ===
<div class="mw-collapsible mw-collapsed" style="width:80%; overflow:auto;">
Response example
<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>

==== API ====
{| class="wikitable"
! Key !! Type !! Description
|-
| success || Boolean || Was the request successful or it failed
|-
| code || Number || Response status code
|-
|msg || [String] || Error message
|-
| colspan="3" |data
|-
|data.groups
|{ groupTitle: ['''<item>''', …] }
|See bellow description '''<item>'''
|-
|data.metrics
|{ metricTitle: ['''<item>''', …] }
|See bellow description '''<item>'''
|}

{| class="wikitable mw-collapsible"
|+Description '''<item>'''
!Key
!Type
!Description
|-
|id
|String
|<groupTitle or metricTitle>
+ underscore

+ <metric or group's name> (groupTitle_id, for example: lowQuality_total, feature_adBlock)

|-
|icon
|<code>date</code><nowiki> | </nowiki><code>text</code><nowiki> | </nowiki><code>number</code>
|Type of content served
|-
|filterType
|<code>range</code><nowiki> | </nowiki><code>list</code><nowiki> | </nowiki><code>binary</code>
|See bellow description '''<filters>'''
|-
|filterSync
|Boolean *
|<code>list</code> with server-side search
|}

== How to get all possible values for filter ==
To obtain values use this URL:
{| class="wikitable"
! Method !! Path
|-
| POST || /api/stat/filter
|}

=== Request ===
<div class="mw-collapsible" style="width:80%; overflow:auto;">
Request example
<pre class="mw-collapsible-content">
{
"id":"geo_language",
"searchQuery":"en",
"dateFrom":"2024-04-10",
"dateTo":"2024-04-10"
}
</pre>
</div>

==== API ====
{| class="wikitable"
!Key
!Type
!Description
|-
|id
|String
|Filter name
|-
|searchQuery
|String
|Search query
|-
|dateFrom
|String
|What date should we start searching? Date in the format Y-m-d.
|-
|dateTo
|String
|Until what date should we continue searching?? Date in the format Y-m-d.
|}

=== Response ===
<div class="mw-collapsible mw-collapsed" style="width:80%; overflow:auto;">
Response example
<pre class="mw-collapsible-content">
{
"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"
!Key
!Type
!Description
|-
| success || Boolean || Was the request successful or it failed
|-
| code || Number || Response status code
|-
|msg || [String] || Error message
|-
| colspan="3" |data
|-
|data.items
|[{ id: Number, label: String }]
|{ id: 1, label: "Param A" }
|}

== How to get full statistic data ==
To obtain such data use this URL:
{| class="wikitable"
! Method !! Path
|-
| POST || /api/stat/data
|}

=== Request ===
<div class="mw-collapsible mw-collapsed" style="width:80%; overflow:auto;">
Request example
<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"
!Key
!Type
!Description
|-
|id
|String
|Optional parameter
|-
|name
|String
|Optional parameter
|-
|perPage
|Number
|Number of lines shown simultaneously. Default value is 50.
|-
|page
|Number
|Current page number. Default value is 1.
|-
|groups
|[String]
|Groups you would like to see in statistics.

See bellow allowed values in '''<groups>'''

|-
|metrics
|[String]
|Metrics you would like to see in statistics.

See bellow allowed values in '''<metrics>'''

<div class="mw-translate-fuzzy">
|-
| colspan="3" |filters
|-
|filters.dateFrom
|String
|Date in the format Y-m-d. If you specify a period, dateFrom will not work. The period has high priority.
|-
|filters.dateTo
|String
|Date in the format Y-m-d. If you specify a period, dateTo will not work. The period has high priority.
|-
|filters.period
|<nowiki>today | yesterday | currentWeek | 7days| month | null</nowiki>
|If you specify a period, dateFrom and dateTo will not work. The period has high priority
|-
|filters.timezone
|Number
|From -12 to +12. Default value is 0, which means that the data will be output in UTC.
|-
|filters.filters
|['''<filters>''']
|See bellow description '''<filters>'''
|-
|compare
|'''<compare>'''
|See bellow description '''<compare>'''
|}
</div>

{| 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
|-
|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, %
|
|-
|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|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
|}

{| class="wikitable mw-collapsible"
|+Description <filters>
!Key
!Type
!Description
|-
|id
|String
|Column by which you would like to filter.

See above allowed values in '''<groups>''' and '''<metrics>'''

|-
|type
|<code>range</code><nowiki> | </nowiki><code>list</code><nowiki> | </nowiki><code>binary</code>
|
|-
|range
|{from: Number, to: Number}
|For filters with type <code>range</code>
|-
|include
|[Any]
|For filters with type <code>list</code> and <code>binary</code>. Show only records with included values.
|-
|exclude
|[Any]
|For filters with type <code>list</code> and <code>binary</code>. Show only records without included values.
|}

===== Filters examples =====
'''Type <code>list</code>, include in on.''' Search the visits only from Cambodia ("KH") or China ("CN").
<pre>
{
...
"filters":{
"filters":[
{
"id":"geo_country",
"type":"list",
"include":["KH","CN"],
"exclude":[]
}
],
"period":"today",
"timezone":-3
}
}
</pre>

'''Type <code>list</code>, exclude in on.''' Search the visits from any country except Cambodia ("KH") andr China ("CN").
<pre>
{
...
"filters":{
"filters":[
{
"id":"geo_country",
"type":"list",
"include":[],
"exclude":["KH","CN"]
}
],
"period":"today",
"timezone":-3
}
}
</pre>

'''Type <code>binary</code>, include is on.''' Search for visits made only by crawlers (i.e. search engine and social network bots).
<pre>
{
...
"filters":{
"filters":[
{
"id":"bots_crawler",
"type":"binary",
"include":[1],
"exclude":[]
}
],
"period":"today",
"timezone":-3
}
}
</pre>

'''Type <code>binary</code>, exclude is on.''' Do not show visits made by crawlers.
<pre>
{
...
"filters":{
"filters":[
{
"id":"bots_crawler",
"type":"binary",
"include":[],
"exclude":[1]
}
],
"period":"today",
"timezone":-3
}
}
</pre>

'''Type <code>range</code>.''' Search for slices, where total amount of bot visits is between 1 000 and 10 000 hits.
<pre>
{
...
"filters":{
"filters":[
{
"id":"bots_total",
"type":"range",
"range":{
"from":1000,
"to":10000
}
}
],
"period":"today",
"timezone":-3
}
}
</pre>

Type <code>range</code>. Search for slices, where more than 50% of visits made from mobile devices.
<pre>
{
...
"filters":{
"filters":[
{
"id":"feature_isMobilePc",
"type":"range",
"range":{
"from":50,
"to":null
}
}
],
"period":"today",
"timezone":-3
}
}
</pre>

Type <code>range</code>. Search for visits made before 10 a.m. UTC-3.
<pre>
{
...
"filters":{
"filters":[
{
"id":"time_hour",
"type":"range",
"range":{
"from":null,
"to":10
}
}
],
"period":"today",
"timezone":-3
}
}
</pre>

{| class="wikitable mw-collapsible"
|+Description <compare>
!Key
!Type
!Description
|-
|dateFrom
|String
|Date in the format Y-m-d
|-
|dateTo
|String
|Date in the format Y-m-d
|-
|mode
|<nowiki>compare_value | diff | percent</nowiki>
|
|-
|sort
|Boolean
|
|}

=== Response ===
<div class="mw-collapsible mw-collapsed" style="width:80%; overflow:auto;">
Response example
<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"
!Key
!Type
!Description
|-
| success || Boolean || Was the request successful or it failed
|-
| code || Number || Response status code
|-
|msg || [String] || Error message
|-
| colspan="3" |data
|-
|data.rows
|['''<row>''']
|Description of table rows
|-
|data.totalRows
|Number
|Total number of items in the table
|-
|data.total
|'''<row>'''
|Sum for each column considering invisible rows
|-
|data.page
|Number
|Current page
|-
|data.perPage
|Number
|Number of items per page
|-
|data.columns
|['''<column>''']
|Description of columns
|}
{| class="wikitable mw-collapsible"
|+
Description <row>
!Key
!Type
!Description
|-
|value
|String
|Human readable value
|-
|rawValue
|String
|Raw value
|-
|diff
|<nowiki>String | null</nowiki>
|
|-
|percent
|<nowiki>Number | null</nowiki>
|Is the value a percentage or not?
|-
|compare_value
|<nowiki>String | null</nowiki>
|Comparison value if compare is on in request
|}
{| class="wikitable mw-collapsible"
|+
Description <column>
!Key
!Type
!Description
|-
|field
|String
|ID of the metric or group
|-
|type
|<nowiki>String | Number | Float</nowiki>
|
|-
|sortable
|Boolean
|Sortable or not
|-
|unit
|<nowiki>String | null</nowiki>
|Unit of measurement
For example, % for percentage columns
|}

== Request examples ==

=== CURL ===
<pre>
curl -X 'OPTIONS' \ '<nowiki>https://kaminari.click/api/stat/get'</nowiki> \ -H 'accept: */*' 'Authorization: Bearer <YOUR API_TOKEN>'
</pre>

<pre>
curl -X POST '<nowiki>https://kaminari.click/api/stat/filter'</nowiki> -d '{"id":"device_type","searchQuery":"","dateFrom":"2023-01-05","dateTo":"2023-01-05"}' -H 'content-type: application/json' -H 'Authorization: Bearer <YOUR API_TOKEN>'
</pre>

<pre>
curl -X POST '<nowiki>https://kaminari.click/api/stat/data'</nowiki> -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>'
</pre>

=== NodeJS ===
const https = require('https');

const options = {
<nowiki> </nowiki> host: 'kaminari.click',
<nowiki> </nowiki> port: 443,
<nowiki> </nowiki> path: '/api/stat/get',
<nowiki> </nowiki> method: 'POST',
<nowiki> </nowiki> headers: { 'Authorization': 'Bearer <YOUR API_TOKEN>' }
};

https
<nowiki> </nowiki> .get(options, (resp) => {
<nowiki> </nowiki> let data = <nowiki>''</nowiki>;

<nowiki> </nowiki> resp.on('data', (chunk) => {
<nowiki> </nowiki> data += chunk;
<nowiki> </nowiki> });

<nowiki> </nowiki> resp.on('end', () => {
<nowiki> </nowiki> try {
<nowiki> </nowiki> data = JSON.parse(data);
<nowiki> </nowiki> } catch {
<nowiki> </nowiki> console.log(data);
<nowiki> </nowiki> }
<nowiki> </nowiki> });
<nowiki> </nowiki> })
<nowiki> </nowiki> .on("error", (err) => {
<nowiki> </nowiki> console.log("Error: " + err.message);
<nowiki> </nowiki> });

=== PHP ===
<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, '<nowiki>https://kaminari.click/api/stat/get'</nowiki>);
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('<nowiki>https://kaminari.click/api/stat/get'</nowiki>, headers=headers)
response = requests.options('<nowiki>http://Authorization</nowiki>: Bearer <YOUR API_TOKEN>', headers=headers)

Stat API/ru

2026-02-19T07:11:29Z

FuzzyBot: Updating to match new version of source page

<languages/>
'''[https://kaminari.click/user Где получить ключ]'''

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

=== '''Список эндпойнтов:''' ===
{| class="wikitable"
! Method !! Path !! Description
|-
| OPTIONS || /api/stat/get || Возвращает все возможные группировки и метрики, сгруппированные по категориям.
|-
| POST || /api/stat/filter || получение данных для фильтра
|-
| POST || /api/stat/data || получение данных для таблицы
|}

== Как получить список всех доступных метрик и группировок ==
Чтобы получить все метрики и группировки, сгруппированные по категориям, воспользуйтесь этим 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>

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

{| class="wikitable mw-collapsible"
|+Описание '''<item>'''
!Ключ
!Тип
!Описание
|-
|id
|String
|<groupTitle или metricTitle>
+ подчёркивание

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

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

== Как получить все возможные значения фильтра ==
Чтобы получить значения какого-то фильтра, используйте URL:
{| class="wikitable"
! Method !! Path
|-
| 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
|String
|Название фильтра
|-
|searchQuery
|String
|Поисковый запрос
|-
|dateFrom
|String
|Начиная с какой даты мы должны искать? Дата в формате Y-m-d.
|-
|dateTo
|String
|По какую дату мы должны искать? Дата в формате Y-m-d.
|}

=== Ответ ===
<div class="mw-collapsible mw-collapsed" style="width:80%; overflow:auto;">
Пример ответа в JSON
<pre class="mw-collapsible-content">
{
"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 || Boolean || Был запрос успешным или нет
|-
| code || Number || Статус ответа
|-
|msg || [String] || Сообщение об ошибке
|-
| colspan="3" |data
|-
|data.items
|[{ id: Number, label: String }]
|{ id: 1, label: "Param A" }
|}

== Как запросить статистику ==
Чтобы получить данные по статистике, воспользуйтесь URL:
{| class="wikitable"
! Method !! Path
|-
| 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
|String
|Необязательный параметр
|-
|name
|String
|Необязательный параметр
|-
|perPage
|Number
|Количество строк, возвращаемых в запросе. Значение по умолчанию 50.
|-
|page
|Number
|Номер текущей страницы. Значение по умолчанию 1.
|-
|groups
|[String]
|Группы, которые вы хотите видеть в таблице в виде колонок

<div class="mw-translate-fuzzy">
'''Возможные значения:''' time_hour, time_day, time_week, time_month, time_dateTime, sub_integration, sub_botType, sub_referer, sub_1, sub_2, sib_3, sub_4, sub_5, sub_6, sub_7, geo_language, geo_timezone, geo_country, geo_city, geo_provider, device_browser, device_browserEngine, device_os, device_realOs, device_device, device_type, device_connectionType, device_useragent, screen_width, screen_height, screen_orientation, screen_pixelDensity
</div>

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

<div class="mw-translate-fuzzy">
'''Возможные значения:''' summary_totalVisits, summary_uniqUsers, summary_uniqUsersPc, summary_validVisits, summary_validVisitsPc, summary_techLosses, summary_techLossesPc, bots_total, bots_totalPc, bots_crawler, bots_crawlerPc, bots_spoofing, bots_spoofingPc, bots_automated, bots_automatedPc, bots_iFrame, bots_iFramePc, bots_badReputationIp, bots_badReputationIpPc, bots_blocked, bots_blockedPc, lowQuality_total, lowQuality_totalPc, lowQuality_proxy, lowQuality_proxyPc, lowQuality_spoofing, lowQuality_spoofingPc, lowQuality_automated, lowQuality_automatedPc, lowQuality_trafficCheats, lowQuality_trafficCheatsPc, feature_adBlock, feature_adBlockPc, feature_isMobile, feature_isMobilePc, feature_webView, feature_webViewPc, feature_iFrame, feature_iFramePc, feature_pushNotifications, feature_pushNotificationsPc. ''Those values are allowed only if option [[Behavioral analysis|Behavioral analysis]] is turned on for you integration'': beAn_pageVisibility, beAn_pageVisibilityPc, beAn_pageActivity, beAn_pageActivityPc, beAn_pageAcceptance, beAn_pageAcceptancePc
</div>

<div class="mw-translate-fuzzy">
'''Полный список метрик вы можете получить с помощью этого [[#How_to_get_all_possible_groupings_and_metrics|URL]].'''
|-
| colspan="3" |filters
|-
|filters.dateFrom
|String
|Дата в формате Y-m-d. Если вы указываете period, dateFrom не будет учитываться, потому что period имеет больший приоритет.
|-
|filters.dateTo
|String
|Дата в формате 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>'''
|-
|compare
|'''<compare>'''
|См. ниже описание '''<compare>'''
|}
{| class="wikitable mw-collapsible"
|+Описание <filters>
!Ключ
!Тип
!Описание
|-
|id
|String
|Колонка, по которой вы бы хотели фильтровать.
</div>

<div lang="en" dir="ltr" class="mw-content-ltr">
{| 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
|-
|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
|
|}
</div>

<div lang="en" dir="ltr" class="mw-content-ltr">
{| 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, %
|
|-
|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|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
|}
</div>

<div lang="en" dir="ltr" class="mw-content-ltr">
{| class="wikitable mw-collapsible"
|+Description <filters>
!Key
!Type
!Description
|-
|id
|String
|Column by which you would like to filter.
</div>

<div lang="en" dir="ltr" class="mw-content-ltr">
See above allowed values in '''<groups>''' and '''<metrics>'''
</div>

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

===== Примеры фильтров =====
'''Тип <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"
|+Описание <compare>
!Ключ
!Тип
!Описание
|-
|dateFrom
|String
|Дата в формате Y-m-d
|-
|dateTo
|String
|Дата в формате Y-m-d
|-
|mode
|<nowiki>compare_value | diff | percent</nowiki>
|
|-
|sort
|Boolean
|
|}

=== Ответ ===
<div class="mw-collapsible mw-collapsed" style="width:80%; overflow:auto;">
Примера ответа в JSON
<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 || Boolean || Был запрос успешным или нет
|-
| code || Number || Статус ответа
|-
|msg || [String] || Сообщение об ошибке
|-
| colspan="3" |data
|-
|data.rows
|['''<row>''']
|Описание строк таблицы
|-
|data.totalRows
|Number
|Общее количество строк в таблице
|-
|data.total
|'''<row>'''
|Сумма по каждой колонке с учётом невидимых строк
|-
|data.page
|Number
|Текущая страница
|-
|data.perPage
|Number
|Количество элементов на странице
|-
|data.columns
|['''<column>''']
|Описание столбцов таблицы
|}
{| class="wikitable mw-collapsible"
|+
Description <row>
!Ключ
!Тип
!Описание
|-
|value
|String
|Значение в человеко-читаемом виде
|-
|rawValue
|String
|Сырое значение
|-
|diff
|<nowiki>String | null</nowiki>
|
|-
|percent
|<nowiki>Number | null</nowiki>
|Является значение процентом или нет
|-
|compare_value
|<nowiki>String | null</nowiki>
|Сравниваемое значение (в случае, если запрос отправлен в режиме compare)
|}
{| class="wikitable mw-collapsible"
|+
Описание <column>
!Ключ
!Тип
!Описание
|-
|field
|String
|ID метрики или группировки
|-
|type
|<nowiki>String | Number | Float</nowiki>
|
|-
|sortable
|Boolean
|Можно сортировать или нет
|-
|unit
|<nowiki>String | null</nowiki>
|Единица измерения.
Например, % у процентных столбцов
|}

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

==== CURL ====
<pre>
curl -X 'OPTIONS' \ '<nowiki>https://kaminari.click/api/stat/get'</nowiki> \ -H 'accept: */*' 'Authorization: Bearer <YOUR API_TOKEN>'
</pre>

<pre>
curl -X POST '<nowiki>https://kaminari.click/api/stat/filter'</nowiki> -d '{"id":"device_type","searchQuery":"","dateFrom":"2023-01-05","dateTo":"2023-01-05"}' -H 'content-type: application/json' -H 'Authorization: Bearer <YOUR API_TOKEN>'
</pre>

<pre>
curl -X POST '<nowiki>https://kaminari.click/api/stat/data'</nowiki> -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>'
</pre>

=== NodeJS ===
const https = require('https');

const options = {
<nowiki> </nowiki> host: 'kaminari.click',
<nowiki> </nowiki> port: 443,
<nowiki> </nowiki> path: '/api/stat/get',
<nowiki> </nowiki> method: 'POST',
<nowiki> </nowiki> headers: { 'Authorization': 'Bearer <YOUR API_TOKEN>' }
};

https
<nowiki> </nowiki> .get(options, (resp) => {
<nowiki> </nowiki> let data = <nowiki>''</nowiki>;

<nowiki> </nowiki> resp.on('data', (chunk) => {
<nowiki> </nowiki> data += chunk;
<nowiki> </nowiki> });

<nowiki> </nowiki> resp.on('end', () => {
<nowiki> </nowiki> try {
<nowiki> </nowiki> data = JSON.parse(data);
<nowiki> </nowiki> } catch {
<nowiki> </nowiki> console.log(data);
<nowiki> </nowiki> }
<nowiki> </nowiki> });
<nowiki> </nowiki> })
<nowiki> </nowiki> .on("error", (err) => {
<nowiki> </nowiki> console.log("Error: " + err.message);
<nowiki> </nowiki> });

=== PHP ===
<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, '<nowiki>https://kaminari.click/api/stat/get'</nowiki>);
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('<nowiki>https://kaminari.click/api/stat/get'</nowiki>, headers=headers)
response = requests.options('<nowiki>http://Authorization</nowiki>: Bearer <YOUR API_TOKEN>', headers=headers)

Translations:Stat API/34/en

2026-02-19T07:11:28Z

FuzzyBot: Importing a new version from external source

|-
|type
|<code>range</code><nowiki> | </nowiki><code>list</code><nowiki> | </nowiki><code>binary</code>
|
|-
|range
|{from: Number, to: Number}
|For filters with type <code>range</code>
|-
|include
|[Any]
|For filters with type <code>list</code> and <code>binary</code>. Show only records with included values.
|-
|exclude
|[Any]
|For filters with type <code>list</code> and <code>binary</code>. Show only records without included values.
|}

Translations:Stat API/48/en

2026-02-19T07:11:28Z

FuzzyBot: Importing a new version from external source

See above allowed values in '''<groups>''' and '''<metrics>'''

Translations:Stat API/47/en

2026-02-19T07:11:28Z

FuzzyBot: Importing a new version from external source

{| class="wikitable mw-collapsible"
|+Description <filters>
!Key
!Type
!Description
|-
|id
|String
|Column by which you would like to filter.

Translations:Stat API/46/en

2026-02-19T07:11:28Z

FuzzyBot: Importing a new version from external source

{| 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, %
|
|-
|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|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
|}

Translations:Stat API/45/en

2026-02-19T07:11:28Z

FuzzyBot: Importing a new version from external source

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

Translations:Stat API/31/en

2026-02-19T07:11:28Z

FuzzyBot: Importing a new version from external source

|-
| colspan="3" |filters
|-
|filters.dateFrom
|String
|Date in the format Y-m-d. If you specify a period, dateFrom will not work. The period has high priority.
|-
|filters.dateTo
|String
|Date in the format Y-m-d. If you specify a period, dateTo will not work. The period has high priority.
|-
|filters.period
|<nowiki>today | yesterday | currentWeek | 7days| month | null</nowiki>
|If you specify a period, dateFrom and dateTo will not work. The period has high priority
|-
|filters.timezone
|Number
|From -12 to +12. Default value is 0, which means that the data will be output in UTC.
|-
|filters.filters
|['''<filters>''']
|See bellow description '''<filters>'''
|-
|compare
|'''<compare>'''
|See bellow description '''<compare>'''
|}

Translations:Stat API/29/en

2026-02-19T07:11:28Z

FuzzyBot: Importing a new version from external source

See bellow allowed values in '''<metrics>'''

Translations:Stat API/28/en

2026-02-19T07:11:28Z

FuzzyBot: Importing a new version from external source

|-
|metrics
|[String]
|Metrics you would like to see in statistics.

Translations:Stat API/27/en

2026-02-19T07:11:28Z

FuzzyBot: Importing a new version from external source

See bellow allowed values in '''<groups>'''

Translations:Stat API/2/en

2026-02-19T07:11:28Z

FuzzyBot: Importing a new version from external source

'''[https://kaminari.click/api Detailed description of the requests and responses for each endpoint].'''

S2S ping/en

2025-12-19T14:16:52Z

FuzzyBot: Updating to match new version of source page

<languages/>
= General workflow =
# The user arrives at your website. You generate a unique <code>kmnrId</code> and send it to Kaminari server via /ping URL, and we save the data in the cache.
# Then you show the user a page with our JavaScript script, adding the same <code>kmnrId</code> to the script call.
# We collect user data and send it to the server.
# On the server, we check in the cache:
## If there is a record with a similar <code>kmnrId</code> (coming from /ping), we combine the data from the cache with the results of the check and write them to the statistics.
## If there is no record with such an <code>kmnrId</code>, we wait up to five minutes. If the second record still does not arrive, we write what we have in the statistics.
## We also periodically check the cache and look for expired clicks that came to /ping but remained unpaired. If we couldn't verify them in any way, we write them to statistics with the status "Technical Losses."

= Client-side configuration =

== Sending data to https://kaminari.systems/v2/ping ==
When a user visits the page, it is necessary to generate a unique display <code>kmnrId</code> on the client-side backend.

Then, using PHP, Python, NodeJS, depending on the technology your website is built on, send initializing information to the https://kaminari.systems/v2/ping in the background.

The request may not be accepted on the first attempt (in which case, the server will respond with a 204 status), so we recommend sending the request in a loop until you receive a response with a 200 status.

The data should be sent using the POST method in JSON format.

List of parameters:

{| class="wikitable"
|-
! Parameter Name !! Parameter Description !! Mandatory?
|-
| kmnrId || Random impression identifier. Generated on the client side. It can be anything - UUID, random number, random string of text. '''Must be sent as a string.''' || yes
|-
| kmnrKey || Integration identifier within which the impression is analyzed. || yes
|-
| sub1 || Filled sub-tags. If you do not use certain tags, there is no need to send them. || no
|-
| sub2 || ... || no
|-
| sub3 || ... || no
|-
| sub4 || ... || no
|-
| sub5 || ... || no
|-
| sub6 || ... || no
|-
| sub7 || ... || no
|}

In addition, the following headers obtained from the user should be added to this request:
{| class="wikitable"
|-
! Parameter Name !! Parameter Description !! Mandatory?
|-
| user-agent || User agent || yes
|-
| referer || Page the user came from || no
|-
| accept-language || Browser interface language || yes
|-
| x-original-ip || Real user IP || yes
|-
| x-forwarded-for || IP || yes
|-
| x-real-ip || IP || no
|-
| x-requested-with || IP || no
|-
| sec-ch-ua-arch || || no
|-
| sec-ch-ua || || no
|-
| sec-ch-ua-full-version || || no
|-
| device-memory || || no
|-
| dpr || || no
|-
| sec-ch-ua-mobile || || no
|-
| sec-ch-ua-model || || no
|-
| sec-ch-ua-platform || || no
|-
| sec-ch-ua-platform-version || || no
|-
| viewport-width || || no
|}

Example in CURL:
<pre>
curl 'https://kaminari.systems/v2/ping' \
-H 'accept: application/json' \
-H 'accept-language: en-US,en;q=0.9,uk;q=0.8' \
-H 'cache-control: no-cache' \
-H 'content-type: application/json;charset=UTF-8' \
-H 'origin: https://test.com' \
-H 'pragma: no-cache' \
-H 'referer: https://test.com/' \
-H 'user-agent: Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/129.0.0.0 Safari/537.36' \
-H 'x-original-ip: 127.0.0.1' \
-H 'x-forwarded-for: 192.168.0.1' \
-H 'sec-ch-ua-arch: "x86"' \
-H 'sec-ch-ua: "Google Chrome";v="129", "Not=A?Brand";v="8", "Chromium";v="129"' \
-H 'sec-ch-ua-full-version: "129.0.6668.100"' \
-H 'device-memory: 8' \
-H 'dpr: 2' \
-H 'sec-ch-ua-mobile: ?0' \
-H 'sec-ch-ua-model: ""' \
-H 'sec-ch-ua-platform: "macOS"' \
-H 'sec-ch-ua-platform-version: "14.5.0"' \
-H 'viewport-width: 981' \
--data-raw '{"kmnrKey":"XXXXXXXX","kmnrId":"1125570260","sub1":"test","sub2":"1001","sub3":"10","sub4":"1385282124113622","sub5":"222","sub6":"555666","sub7":"8833705265931305"}'
--compressed
</pre>

Example in PHP:
<pre>
$url = 'https://kaminari.systems/v2/ping';
$ch = curl_init( $url );
$payload = json_encode([
'kmnrKey' => 'XXXXXXXX',
'kmnrId' => '1125570260',
'sub1' => 'test',
'sub2' => '1001',
'sub3' => '10',
'sub4' => '1385282124113622',
'sub5' => '222',
'sub6' => '555666',
'sub7' => '8833705265931305',
]);

curl_setopt( $ch, CURLOPT_POSTFIELDS, $payload );
curl_setopt( $ch, CURLOPT_HTTPHEADER, [
'Content-Type:application/json;charset=UTF-8',
'Accept-Language:' . $_SERVER['HTTP_ACCEPT_LANGUAGE'],
'User-Agent:' . $_SERVER['HTTP_USER_AGENT'],
isset($_SERVER['HTTP_REFERER']) ? 'Referer:' . $_SERVER['HTTP_REFERER'] : '',
'X-Original-Ip:' . $_SERVER['REMOTE_ADDR'],
isset($_SERVER['X_FORWARDED_FOR']) ? 'X-Forwarded-For:' . $_SERVER['X_FORWARDED_FOR'] : '',
isset($_SERVER['X_REQUESTED_WITH']) ? 'X-Requested-With:' . $_SERVER['X_REQUESTED_WITH'] : '',
isset($_SERVER['HTTP_SEC_CH_UA_ARCH']) ? 'Sec-CH-UA-Arch:' . $_SERVER['HTTP_SEC_CH_UA_ARCH'] : '',
isset($_SERVER['HTTP_SEC_CH_UA']) ? 'Sec-CH-UA:' . $_SERVER['HTTP_SEC_CH_UA'] : '',
isset($_SERVER['HTTP_SEC_CH_UA_FULL_VERSION']) ? 'Sec-CH-UA-Full-Version:' . $_SERVER['HTTP_SEC_CH_UA_FULL_VERSION'] : '',
isset($_SERVER['HTTP_DEVICE_MEMORY']) ? 'Device-Memory:' . $_SERVER['HTTP_DEVICE_MEMORY'] : '',
isset($_SERVER['HTTP_DPR']) ? 'DPR:' . $_SERVER['HTTP_DPR'] : '',
isset($_SERVER['HTTP_SEC_CH_UA_MOBILE']) ? 'Sec-CH-UA-Mobile:' . $_SERVER['HTTP_SEC_CH_UA_MOBILE'] : '',
isset($_SERVER['HTTP_SEC_CH_UA_MODEL']) ? 'Sec-CH-UA-Model:' . $_SERVER['HTTP_SEC_CH_UA_MODEL'] : '',
isset($_SERVER['HTTP_SEC_CH_UA_PLATFORM']) ? 'Sec-CH-UA-Platform:' . $_SERVER['HTTP_SEC_CH_UA_PLATFORM'] : '',
isset($_SERVER['HTTP_SEC_CH_UA_PLATFORM_VERSION']) ? 'Sec-CH-UA-Platform-Version:' . $_SERVER['HTTP_SEC_CH_UA_PLATFORM_VERSION'] : '',
isset($_SERVER['HTTP_VIEWPORT_WIDTH']) ? 'Viewport-Width:' . $_SERVER['HTTP_VIEWPORT_WIDTH'] : '',
]);
curl_exec($ch);
curl_close($ch);
</pre>

== Adding kmnrId to the script ==
The generated <code>kmnrId</code>, as well as the <code>kmnrKey</code> and sub-tags, should then be passed into the call of the JavaScript script on the page.

<pre>
<script>
window.kmnr = {
kmnrKey: 'XXXXXXXX',
kmnrId: '1125570260',
sub1: 'test',
sub2: '1001',
sub3: '10',
sub4: '1385282124113622',
sub5: '222',
sub6: '555666',
sub7: '8833705265931305',
};

var kmnrSc = document.createElement('script');
var kmnrPrnt = document.getElementsByTagName('head')[0] || document.body;
kmnrSc.setAttribute('async', true);
kmnrSc.setAttribute('charset', 'utf-8');
kmnrSc.src = '//kaminari.systems/v1/script.js?kmnrKey=' + window.kmnr.kmnrKey;
kmnrPrnt && kmnrPrnt.appendChild(kmnrSc);
</script>
</pre>

= Testing =

For testing data transmission and ensuring their compatibility with the API, you can use the following URL: https://kaminari.systems/v1/pingtest

=== Example in PHP: ===
<pre>
$url = 'https://kaminari.systems/v1/pingtest';
try {
$ch = curl_init( $url );
$payload = json_encode([
'kmnrKey' => 'XXXXXXXX',
'kmnrId' => (string)mt_rand(),
'sub1' => 'test',
'sub2' => '1001',
'sub3' => '10',
'sub4' => '40',
'sub5' => '555',
'sub6' => '6',
'sub7' => '77777',
]);

curl_setopt( $ch, CURLOPT_POSTFIELDS, $payload );
curl_setopt( $ch, CURLOPT_HTTPHEADER, [
'Content-Type:application/json',
'Accept-Language:' . $_SERVER['HTTP_ACCEPT_LANGUAGE'],
'User-Agent:' . $_SERVER['HTTP_USER_AGENT'],
'DPR:2',
isset($_SERVER['HTTP_REFERER']) ? 'Referer:' . $_SERVER['HTTP_REFERER'] : 'Referer:""',
]);
curl_setopt( $ch, CURLOPT_HEADER, true);
curl_setopt( $ch, CURLOPT_RETURNTRANSFER, true );

$response = curl_exec($ch);
$header_size = curl_getinfo($ch, CURLINFO_HEADER_SIZE);
$header = substr($response, 0, $header_size);
$body = substr($response, $header_size);
$body = str_replace('", "', '",<br /> "', $body);
$body = str_replace('{ "', '{<br /> "', $body);
echo "<pre>1. Response length: $header_size</pre>";
echo "<pre>2. Response body: $body</pre>";

'curl error: ' . curl_error($ch);
curl_close($ch);
} catch (Exception $e) {
echo "Error register User: {$e->getMessage()}";
}
</pre>

Response :
<pre>
1. Response length: 287
2. Response body: {"errors": {
"X-Forwarded-For":"recommended to add in request headers",
"X-Real-IP":"recommended to add in request headers",
"sec-ch-ua-arch":"recommended to add in request headers",
"sec-ch-ua":"recommended to add in request headers",
"sec-ch-ua-full-version":"recommended to add in request headers",
"device-memory":"recommended to add in request headers",
"sec-ch-ua-mobile":"recommended to add in request headers",
"sec-ch-ua-model":"recommended to add in request headers",
"sec-ch-ua-platform":"recommended to add in request headers",
"sec-ch-ua-platform-version":"recommended to add in request headers",
"viewport-width":"recommended to add in request headers"}}
</pre>

=== Example in Node.js: ===
<pre>
const https = require('https');

const payload = JSON.stringify({
'kmnrKey': 'XXXXXXXX',
'kmnrId': (Math.random() + 1).toString(36).substring(9),
'sub1': 'test',
'sub2': '1001',
'sub3': '10',
'sub4': '40',
'sub5': '555',
'sub6': '6',
'sub7': '77777',
});

const options = {
host: 'kaminari.click',
port: 443,
path: '/v1/pingtest',
method: 'POST',
headers: {
'Content-Type': 'application/json',
'Content-Length': Buffer.byteLength(payload),
'Accept-Language': 'en-US,en;q=0.5',
'User-Agent': 'Mozilla/5.0 (Windows NT 10.0; Win64; x64; rv:109.0) Gecko/20100101 Firefox/113.0',
'DPR': '2',
'Referer': '""',
}
};

const req = https
.request(options, (res) => {
let data = '';

res.on('data', (chunk) => {
data += chunk;
});

res.on('end', () => {
try {
data = JSON.parse(data);
console.log(data);
} catch {
console.log(data);
}
});
});

req.on('error', (err) => {
console.log("Error: " + err.message);
});
req.write(payload);
req.end();
</pre>

Response:
<pre>
{
errors: {
'X-Forwarded-For': 'recommended to add in request headers',
'X-Real-IP': 'recommended to add in request headers',
'sec-ch-ua-arch': 'recommended to add in request headers',
'sec-ch-ua': 'recommended to add in request headers',
'sec-ch-ua-full-version': 'recommended to add in request headers',
'device-memory': 'recommended to add in request headers',
'sec-ch-ua-mobile': 'recommended to add in request headers',
'sec-ch-ua-model': 'recommended to add in request headers',
'sec-ch-ua-platform': 'recommended to add in request headers',
'sec-ch-ua-platform-version': 'recommended to add in request headers',
'viewport-width': 'recommended to add in request headers'
}
}
</pre>
[[Category:Features]]

S2S ping/ru

2025-12-19T14:16:48Z

FuzzyBot: Updating to match new version of source page

<languages/>
= Общий алгоритм работы =
# Пользователь приходит на ваш сайт. Вы генерируете уникальный <code>kmnrId</code> и отстукиваетесь с ним на сервер Kaminari на URL /ping, мы сохраняем данные в кэш.
# Затем вы показываете пользователю страницу с нашим JS-скриптом, добавив в вызов скрипта тот же самый <code>kmnrId</code>.
# Мы собираем данные о пользователе и шлём их на сервер Kaminari.
# На сервере мы проверяем в кэше:
## Если там есть запись с аналогичным <code>kmnrId</code> (пришедшая на /ping), мы склеиваем данные из кеша с результатами проверки и пишем их в статистику.
## Если записи с таким <code>kmnrId</code> нет, мы ждём пять минут. Если вторая запись так и не приходит, мы пишем в статистику то, что есть.
## Так же мы периодически проверяем кэш и ищем просроченные клики, пришедшие на /ping, но так и оставшиеся без пары. Если нам не удалось никак их проверить, мы пишем их в стату со статусом «Технические потери».

<span id="Client-side_configuration"></span>
= Настройка на стороне клиента =

== Отправка данных на https://kaminari.systems/v2/ping ==
Когда пользователь приходит на страницу, необходимо на бэкенде сгенерировать <code>kmnrId</code> — уникальный идентификатор показа.

Затем с помощью PHP, Python, NodeJS — в зависимости от того, на чём у вас написан сайт — послать на URL https://kaminari.systems/v2/ping инициализирующую информацию.

Запрос может не быть принят с первого раз (в таком случае сервер пришлёт статус 204), мы советуем слать запрос в цикле до получения ответа со статусом 200.

Данные должны слаться методом POST в формате JSON.

Список параметров:

<div class="mw-translate-fuzzy">
{| class="wikitable"
|-
! Название !! Описание параметра !! Обязательный?
|-
| kmnrId || Рандомный идентификатор показа. Генерируется на стороне клиента. Это может быть всё, что угодно — UUID, случайное число, случайная текстовая строка. '''Должна слаться в виде строки.''' || да
|-
| kmnrKey || Идентификатор интеграции, в рамках которой анализируется показ. || да
|-
| sub1 || Заполенные суб-метки. Если какие-то метки вы не используете, их слать не обязательно. || нет
|-
| sub2 || ... || нет
|-
| sub3 || ... || нет
|-
| sub4 || ... || нет
|-
| sub5 || ... || нет
|-
| sub6 || ... || нет
|-
| sub7 || ... || нет
|}
</div>

<div class="mw-translate-fuzzy">
Также в этот запрос должны быть добавлены следующие заголовки, полученные от пользователя:
{| class="wikitable"
|-
! Название !! Описание
|-
| user-agent || user agent пользователя
|-
| referer || страница, с которой пришёл пользователь
|-
| accept-language || язык интерфейса браузера
|-
| x-original-ip || реальный IP пользователя
|-
| x-forwarded-for || IP
|-
| x-real-ip || IP
|-
| sec-ch-ua-arch ||
|-
| sec-ch-ua ||
|-
| sec-ch-ua-full-version ||
|-
| device-memory ||
|-
| dpr ||
|-
| sec-ch-ua-mobile ||
|-
| sec-ch-ua-model ||
|-
| sec-ch-ua-platform ||
|-
| sec-ch-ua-platform-version ||
|-
| viewport-width ||
|}
</div>

<div class="mw-translate-fuzzy">
Пример curl-запроса:
<pre>
curl 'https://kaminari.systems/v2/ping' \
-H 'accept: application/json' \
-H 'accept-language: en-US,en;q=0.9' \
-H 'cache-control: no-cache' \
-H 'content-type: text/plain;charset=UTF-8' \
-H 'origin: https://test.com' \
-H 'pragma: no-cache' \
-H 'referer: https://test.com/' \
-H 'user-agent: Mozilla/5.0 (Windows NT 6.3; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/105.0.0.0 Safari/537.36'
--data-raw '{"kmnrKey":"XXXXXXXX","kmnrId":"1125570260","sub1":"test","sub2":"1001","sub3":"10","sub4":"1385282124113622","sub5":"222","sub6":"555666","sub7":"8833705265931305"}'
--compressed
</pre>
</div>

Пример на PHP:
<pre>
$url = 'https://kaminari.systems/v2/ping';
$ch = curl_init( $url );
$payload = json_encode([
'kmnrKey' => 'XXXXXXXX',
'kmnrId' => '1125570260',
'sub1' => 'test',
'sub2' => '1001',
'sub3' => '10',
'sub4' => '1385282124113622',
'sub5' => '222',
'sub6' => '555666',
'sub7' => '8833705265931305',
]);

<div class="mw-translate-fuzzy">
curl_setopt( $ch, CURLOPT_POSTFIELDS, $payload );
curl_setopt( $ch, CURLOPT_HTTPHEADER, [
'Content-Type:application/json',
'Accept-Language:' . $_SERVER['HTTP_ACCEPT_LANGUAGE'],
'User-Agent:' . $_SERVER['HTTP_USER_AGENT'],
isset($_SERVER['HTTP_REFERER']) ? 'Referer:' . $_SERVER['HTTP_REFERER'] : '',
]);
curl_exec($ch);
curl_close($ch);
</pre>
</div>

== Добавление kmnrId в скрипт ==
Сгенерированный <code>kmnrId</code>, а так же <code>kmnrKey</code> и субки затем нужно прокинуть в вызов JS-скрипта на странице.

<pre>
<script>
window.kmnr = {
kmnrKey: 'XXXXXXXX',
kmnrId: '1125570260',
sub1: 'test',
sub2: '1001',
sub3: '10',
sub4: '1385282124113622',
sub5: '222',
sub6: '555666',
sub7: '8833705265931305',
};

var kmnrSc = document.createElement('script');
var kmnrPrnt = document.getElementsByTagName('head')[0] || document.body;
kmnrSc.setAttribute('async', true);
kmnrSc.setAttribute('charset', 'utf-8');
kmnrSc.src = '//kaminari.systems/v1/script.js?kmnrKey=' + window.kmnr.kmnrKey;
kmnrPrnt && kmnrPrnt.appendChild(kmnrSc);
</script>
</pre>

<span id="Testing"></span>
= Тестирование =

Для тестирования отправления данных и соответствия их API можно воспользоваться URL https://kaminari.systems/v1/pingtest

=== Пример на PHP: ===
<pre>
$url = 'https://kaminari.systems/v1/pingtest';
try {
$ch = curl_init( $url );
$payload = json_encode([
'kmnrKey' => 'XXXXXXXX',
'kmnrId' => (string)mt_rand(),
'sub1' => 'test',
'sub2' => '1001',
'sub3' => '10',
'sub4' => '40',
'sub5' => '555',
'sub6' => '6',
'sub7' => '77777',
]);

curl_setopt( $ch, CURLOPT_POSTFIELDS, $payload );
curl_setopt( $ch, CURLOPT_HTTPHEADER, [
'Content-Type:application/json',
'Accept-Language:' . $_SERVER['HTTP_ACCEPT_LANGUAGE'],
'User-Agent:' . $_SERVER['HTTP_USER_AGENT'],
'DPR:2',
isset($_SERVER['HTTP_REFERER']) ? 'Referer:' . $_SERVER['HTTP_REFERER'] : 'Referer:""',
]);
curl_setopt( $ch, CURLOPT_HEADER, true);
curl_setopt( $ch, CURLOPT_RETURNTRANSFER, true );

$response = curl_exec($ch);
$header_size = curl_getinfo($ch, CURLINFO_HEADER_SIZE);
$header = substr($response, 0, $header_size);
$body = substr($response, $header_size);
$body = str_replace('", "', '",<br /> "', $body);
$body = str_replace('{ "', '{<br /> "', $body);
echo "<pre>1. Response length: $header_size</pre>";
echo "<pre>2. Response body: $body</pre>";

'curl error: ' . curl_error($ch);
curl_close($ch);
} catch (Exception $e) {
echo "Error register User: {$e->getMessage()}";
}
</pre>

Response :
<pre>
1. Response length: 287
2. Response body: {"errors": {
"X-Forwarded-For":"recommended to add in request headers",
"X-Real-IP":"recommended to add in request headers",
"sec-ch-ua-arch":"recommended to add in request headers",
"sec-ch-ua":"recommended to add in request headers",
"sec-ch-ua-full-version":"recommended to add in request headers",
"device-memory":"recommended to add in request headers",
"sec-ch-ua-mobile":"recommended to add in request headers",
"sec-ch-ua-model":"recommended to add in request headers",
"sec-ch-ua-platform":"recommended to add in request headers",
"sec-ch-ua-platform-version":"recommended to add in request headers",
"viewport-width":"recommended to add in request headers"}}
</pre>

=== Пример на Node.js: ===
<pre>
const https = require('https');

const payload = JSON.stringify({
'kmnrKey': 'XXXXXXXX',
'kmnrId': (Math.random() + 1).toString(36).substring(9),
'sub1': 'test',
'sub2': '1001',
'sub3': '10',
'sub4': '40',
'sub5': '555',
'sub6': '6',
'sub7': '77777',
});

const options = {
host: 'kaminari.click',
port: 443,
path: '/v1/pingtest',
method: 'POST',
headers: {
'Content-Type': 'application/json',
'Content-Length': Buffer.byteLength(payload),
'Accept-Language': 'en-US,en;q=0.5',
'User-Agent': 'Mozilla/5.0 (Windows NT 10.0; Win64; x64; rv:109.0) Gecko/20100101 Firefox/113.0',
'DPR': '2',
'Referer': '""',
}
};

const req = https
.request(options, (res) => {
let data = '';

res.on('data', (chunk) => {
data += chunk;
});

res.on('end', () => {
try {
data = JSON.parse(data);
console.log(data);
} catch {
console.log(data);
}
});
});

req.on('error', (err) => {
console.log("Error: " + err.message);
});
req.write(payload);
req.end();
</pre>

Ответ:
<pre>
{
errors: {
'X-Forwarded-For': 'recommended to add in request headers',
'X-Real-IP': 'recommended to add in request headers',
'sec-ch-ua-arch': 'recommended to add in request headers',
'sec-ch-ua': 'recommended to add in request headers',
'sec-ch-ua-full-version': 'recommended to add in request headers',
'device-memory': 'recommended to add in request headers',
'sec-ch-ua-mobile': 'recommended to add in request headers',
'sec-ch-ua-model': 'recommended to add in request headers',
'sec-ch-ua-platform': 'recommended to add in request headers',
'sec-ch-ua-platform-version': 'recommended to add in request headers',
'viewport-width': 'recommended to add in request headers'
}
}
</pre>
[[Category:Features]]

Translations:S2S ping/12/en

2025-12-19T14:16:11Z

FuzzyBot: Importing a new version from external source

curl_setopt( $ch, CURLOPT_POSTFIELDS, $payload );
curl_setopt( $ch, CURLOPT_HTTPHEADER, [
'Content-Type:application/json;charset=UTF-8',
'Accept-Language:' . $_SERVER['HTTP_ACCEPT_LANGUAGE'],
'User-Agent:' . $_SERVER['HTTP_USER_AGENT'],
isset($_SERVER['HTTP_REFERER']) ? 'Referer:' . $_SERVER['HTTP_REFERER'] : '',
'X-Original-Ip:' . $_SERVER['REMOTE_ADDR'],
isset($_SERVER['X_FORWARDED_FOR']) ? 'X-Forwarded-For:' . $_SERVER['X_FORWARDED_FOR'] : '',
isset($_SERVER['X_REQUESTED_WITH']) ? 'X-Requested-With:' . $_SERVER['X_REQUESTED_WITH'] : '',
isset($_SERVER['HTTP_SEC_CH_UA_ARCH']) ? 'Sec-CH-UA-Arch:' . $_SERVER['HTTP_SEC_CH_UA_ARCH'] : '',
isset($_SERVER['HTTP_SEC_CH_UA']) ? 'Sec-CH-UA:' . $_SERVER['HTTP_SEC_CH_UA'] : '',
isset($_SERVER['HTTP_SEC_CH_UA_FULL_VERSION']) ? 'Sec-CH-UA-Full-Version:' . $_SERVER['HTTP_SEC_CH_UA_FULL_VERSION'] : '',
isset($_SERVER['HTTP_DEVICE_MEMORY']) ? 'Device-Memory:' . $_SERVER['HTTP_DEVICE_MEMORY'] : '',
isset($_SERVER['HTTP_DPR']) ? 'DPR:' . $_SERVER['HTTP_DPR'] : '',
isset($_SERVER['HTTP_SEC_CH_UA_MOBILE']) ? 'Sec-CH-UA-Mobile:' . $_SERVER['HTTP_SEC_CH_UA_MOBILE'] : '',
isset($_SERVER['HTTP_SEC_CH_UA_MODEL']) ? 'Sec-CH-UA-Model:' . $_SERVER['HTTP_SEC_CH_UA_MODEL'] : '',
isset($_SERVER['HTTP_SEC_CH_UA_PLATFORM']) ? 'Sec-CH-UA-Platform:' . $_SERVER['HTTP_SEC_CH_UA_PLATFORM'] : '',
isset($_SERVER['HTTP_SEC_CH_UA_PLATFORM_VERSION']) ? 'Sec-CH-UA-Platform-Version:' . $_SERVER['HTTP_SEC_CH_UA_PLATFORM_VERSION'] : '',
isset($_SERVER['HTTP_VIEWPORT_WIDTH']) ? 'Viewport-Width:' . $_SERVER['HTTP_VIEWPORT_WIDTH'] : '',
]);
curl_exec($ch);
curl_close($ch);
</pre>

Translations:S2S ping/10/en

2025-12-19T14:16:11Z

FuzzyBot: Importing a new version from external source

Example in CURL:
<pre>
curl 'https://kaminari.systems/v2/ping' \
-H 'accept: application/json' \
-H 'accept-language: en-US,en;q=0.9,uk;q=0.8' \
-H 'cache-control: no-cache' \
-H 'content-type: application/json;charset=UTF-8' \
-H 'origin: https://test.com' \
-H 'pragma: no-cache' \
-H 'referer: https://test.com/' \
-H 'user-agent: Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/129.0.0.0 Safari/537.36' \
-H 'x-original-ip: 127.0.0.1' \
-H 'x-forwarded-for: 192.168.0.1' \
-H 'sec-ch-ua-arch: "x86"' \
-H 'sec-ch-ua: "Google Chrome";v="129", "Not=A?Brand";v="8", "Chromium";v="129"' \
-H 'sec-ch-ua-full-version: "129.0.6668.100"' \
-H 'device-memory: 8' \
-H 'dpr: 2' \
-H 'sec-ch-ua-mobile: ?0' \
-H 'sec-ch-ua-model: ""' \
-H 'sec-ch-ua-platform: "macOS"' \
-H 'sec-ch-ua-platform-version: "14.5.0"' \
-H 'viewport-width: 981' \
--data-raw '{"kmnrKey":"XXXXXXXX","kmnrId":"1125570260","sub1":"test","sub2":"1001","sub3":"10","sub4":"1385282124113622","sub5":"222","sub6":"555666","sub7":"8833705265931305"}'
--compressed
</pre>

Translations:S2S ping/9/en

2025-12-19T14:16:11Z

FuzzyBot: Importing a new version from external source

In addition, the following headers obtained from the user should be added to this request:
{| class="wikitable"
|-
! Parameter Name !! Parameter Description !! Mandatory?
|-
| user-agent || User agent || yes
|-
| referer || Page the user came from || no
|-
| accept-language || Browser interface language || yes
|-
| x-original-ip || Real user IP || yes
|-
| x-forwarded-for || IP || yes
|-
| x-real-ip || IP || no
|-
| x-requested-with || IP || no
|-
| sec-ch-ua-arch || || no
|-
| sec-ch-ua || || no
|-
| sec-ch-ua-full-version || || no
|-
| device-memory || || no
|-
| dpr || || no
|-
| sec-ch-ua-mobile || || no
|-
| sec-ch-ua-model || || no
|-
| sec-ch-ua-platform || || no
|-
| sec-ch-ua-platform-version || || no
|-
| viewport-width || || no
|}

Translations:S2S ping/8/en

2025-12-19T14:16:11Z

FuzzyBot: Importing a new version from external source

{| class="wikitable"
|-
! Parameter Name !! Parameter Description !! Mandatory?
|-
| kmnrId || Random impression identifier. Generated on the client side. It can be anything - UUID, random number, random string of text. '''Must be sent as a string.''' || yes
|-
| kmnrKey || Integration identifier within which the impression is analyzed. || yes
|-
| sub1 || Filled sub-tags. If you do not use certain tags, there is no need to send them. || no
|-
| sub2 || ... || no
|-
| sub3 || ... || no
|-
| sub4 || ... || no
|-
| sub5 || ... || no
|-
| sub6 || ... || no
|-
| sub7 || ... || no
|}

Ping back URL/en

2025-11-21T08:58:36Z

FuzzyBot: Updating to match new version of source page

<languages/>
If you want to receive the verification results for each click on your own URL, you can do so using the '''Ping-back URL''' option.

= Option activation =
Ask your manager to activate the '''Ping-back URL''' option on your integration.

Once enabled, specify your URL in the settings.

[[File:Ping back url.png]]

== kmnrId ==
To understand which impression we've checked, you need to mark it.

If you have an '''JS check'''-type integration, add the <code>kmnrId</code> key to <code>window.kmnr</code> with any unique identifier convenient for you. By this identifier you can later recognize the impression.

[[File:Ping back url2.png]]

If you have an '''Redirect'''-type integration, add kmnrId to URL:

<pre>https://kaminari.systems/v1/click?kmnrKey=111111111&kmnrId=IMPRESSION_UNIQ_ID&u=https%3A%2F%2Fsome.url</pre>

Acceptable characters: [A-Za-z0-9_] Latin letters, Arabic numerals, underscore. Maximum length is 200 characters.

= Response format =
After receiving, processing the data, and making a decision about the bot status of the click, we send the decision to you in JSON POST format.
<pre>{
"kmnrId": "50d9ecc6-402b-4a74-9397-fc20f2980567",
"kmnrKey": 111111111,
"fraud": 1,
"block": 1,
"sub1": "sub1 value",
"sub2": "sub2 value",
"sub3": "sub3 value",
"sub4": 444,
"sub5": 555,
"sub6": "",
"sub7": ""
}</pre>

By kmnrId and sub-tags you can find the impression in your stat.

{| class="wikitable"
|-
! Name !! Value
|-
| kmnrId || Unique identifier convenient for you
|-
| kmnrKey || Integration identifier
|-
| fraud || 1 if the hit is fraudulent, 0 if the hit is non-fraudulent, -1 if the hit could not be verified
|-
| block || 1 if the hit was blocked according to the integration settings, 0 if the hit wasn't blocked
|-
| sub1 || Sub-tags that were sent with the hit
|-
| sub2 || ...
|-
| sub3 || ...
|-
| sub4 || ...
|-
| sub5 || ...
|-
| sub6 || ...
|-
| sub7 || ...
|}

If the ping-back still cannot be delivered, you can always retrieve the status for any click via our API, which serves as the reliable source of truth regardless of delivery success.

[[Category:Features]]

Ping back URL/ru

2025-11-21T08:58:33Z

FuzzyBot: Updating to match new version of source page

<languages/>
Если вы хотите получать на свой URL результат проверки по каждому клику, это можно сделать с помощью опции '''Ping-back URL'''.

= Подключение опции =
Закажите у менеджера включение опции '''Ping-back URL''' на своей интеграции.

После того как её включат, укажите в настройках свой URL.

[[File:Ping back url.png]]

== kmnrId ==
Чтобы понимать какой показ мы проверили вам надо пометить его.

Если у вас интеграция типа '''JS check''', то добавьте в <code>window.kmnr</code> ключ <code>kmnrId</code> с любым удобным для вас уникальным идентификатором, по которому сможете потом узнать показ.

[[File:Ping back url2.png]]

В интеграции типа '''Redirect''' добавьте kmnrId в URL:

<pre>https://kaminari.systems/v1/click?kmnrKey=111111111&kmnrId=IMPRESSION_UNIQ_ID&u=https%3A%2F%2Fsome.url</pre>

Допустимые символы: <code>[A-Za-z0-9_]</code> латинские буквы, арабские цифры, знак подчёркивания. Максимальная длина — 200 символов.

= Формат ответа =
После того, как мы получили, обработали данные и вынесли решение о ботовости клика, мы отсылаем решение вам в формате JSON POST.
<pre>{
"kmnrId": "50d9ecc6-402b-4a74-9397-fc20f2980567",
"kmnrKey": 111111111,
"fraud": 1,
"block": 1,
"sub1": "sub1 value",
"sub2": "sub2 value",
"sub3": "sub3 value",
"sub4": 444,
"sub5": 555,
"sub6": "",
"sub7": ""
}</pre>

По kmnrId и меткам вы сможете найти показ на своей стороне.

{| class="wikitable"
|-
! Название !! Значение
|-
| kmnrId || kmnrId, уникальный идентификатор
|-
| kmnrKey || Идентификатор интеграции
|-
| fraud || 1 если переход фродовый, 0 если переход нефродовый, -1 если переход не удалось проверить
|-
| block || 1 если переход был заблокирован в соответствии с настройками интеграции, 0 если переход не был заблокирован
|-
| sub1 || метки, отправленные нам вместе с запросом
|-
| sub2 || ...
|-
| sub3 || ...
|-
| sub4 || ...
|-
| sub5 || ...
|-
| sub6 || ...
|-
| sub7 || ...
|}

<div class="mw-translate-fuzzy">
После успешного получения ping-back ваш сервер должен ответить статусом 200. Иначе мы попробуем ещё три раза отправить запрос.

Если отправить ping-back так и не удалось, мы сохраняем его во внутренний лог и готовы предоставить по вашему запросу.
</div>

[[Category:Features]]

Translations:Ping back URL/15/en

2025-11-21T08:58:33Z

FuzzyBot: Importing a new version from external source

If the ping-back still cannot be delivered, you can always retrieve the status for any click via our API, which serves as the reliable source of truth regardless of delivery success.

Allowed Domains/ru

2025-10-16T08:45:41Z

FuzzyBot: Updating to match new version of source page

<languages/>
Если вы хотите, чтобы на вашей интеграции обрабатывались только отстуки с доверенных доменов, включите опцию '''Allowed Domains''' на своей интеграции.

= Домены =
После того как её включат, укажите в настройках свои домены.

Домены надо добавлять без протокола (<code>https://</code>, <code>http://</code>), порта, пути и параметров.

Неправильно:
* https://example.com
* https://example.com/path/to/directory
* https://example.com:8080
* https://en.example.com/?test=123

Правильно:
* example.com
* en.example.com

Разделять домены надо запятой и пробелом: <code>example.com, test.org</code>.

= Wildcard =
Для замены любого элемента — субдомена, доменного имени, доменной зоны можно указывать <code>*</code> (wildcard):

* <code>*.example.com</code> будет означать, что в число разрешённых доменов попадут все поддомены example.com: en.example.com, fr.example.com, es.example.com, cn.example.com
* <code>*.travel</code> будет означать, что в число разрешённых попадут все домены из доменной зоны travel: example.travel, test.travel и т. д.
* <code>example.*</code> будет означать, что в число разрешённых доменов попадут все доменные зоны: example.com, example.net, example.org и т. д.

Allowed Domains/en

2025-10-16T08:42:41Z

FuzzyBot: Updating to match new version of source page

<languages/>
If you want to check impressions only from trusted domains, activate the '''Allowed Domains''' option on your integration.

= Domains =
Once enabled, specify your domains in the settings.

Domains must be added without a protocol (<code>https://</code>, <code>http://</code>), port, path and query.

Wrong:
* https://example.com
* https://example.com/path/to/directory
* https://example.com:8080
* https://en.example.com/?test=123

Right:
* example.com
* en.example.com

Domains must be separated by a comma and a space: <code>example.com, test.org</code>.

= Wildcard =
To replace any element: subdomain, domain name, domain zone, you can specify <code>*</code> (wildcard):

* <code>*.example.com</code> will mean that all example.com subdomains will be included in the number of allowed domains: en.example.com, fr.example.com, es.example.com, cn.example.com
* <code>*.travel</code> will mean that all domains from the travel domain zone will be among the allowed ones: example.travel, test.travel etc.
* <code>example.*</code> will mean that all domain zones will be included in the number of allowed domains: example.com, example.net, example.org etc.

Translations:Allowed Domains/1/en

2025-10-16T08:42:08Z

FuzzyBot: Importing a new version from external source

If you want to check impressions only from trusted domains, activate the '''Allowed Domains''' option on your integration.

Proxy check URL/en

2025-06-18T10:38:05Z

FuzzyBot: Updating to match new version of source page

<languages/>
After our script collects all user data, it sends it to the server at https://kaminari.systems/v2/check.

If you want to reduce the percentage of technical losses by creating for the browser the appearance that the submission is within one domain, you can proxy the data submission through your own domain.

= Option activation =
To achieve this, request the activation of the '''Proxy check URL''' option from your manager for your integration. Once enabled, specify your URL in the settings

[[File:Proxy url.png]]

'''Please note that immediately after filling in this field, data will start to be sent to the specified URL. Leave it empty until you set up the proxy on your server.'''

= Client-side configuration =
To ensure that proper data is proxying and we receive all necessary parameters, server configuration is required.

===== Configuration for Nginx =====
Add the following to the http block:
<pre>
upstream antifraud {
server kaminari.systems;
keepalive 10;
}
</pre>

To the configuration, you need to add (the example demonstrates proxying to the <code>/antifraud</code> endpoint):
<pre>
location /antifraud {
rewrite /antifraud /v2/check break;
proxy_set_header Host kaminari.systems;
proxy_http_version 1.1;
proxy_set_header Connection "";
proxy_set_header X-Forwarded-For $http_x_forwarded_for;
proxy_set_header X-Original-IP $http_x_real_ip;
proxy_pass http://kaminari.systems;
}
</pre>
[[Category:Features]]

Proxy check URL/ru

2025-06-18T10:38:04Z

FuzzyBot: Updating to match new version of source page

<languages/>
После того, как наш скрипт соберёт все данные о пользователе, он отправляет их на сервер по адресу https://kaminari.systems/v2/check.

Если вы хотите уменьшить процент технических потерь, создав для браузера видимость, что отправка происходит в рамках одного домена, можно проксировать отправку данных через свой домен.

= Подключение опции =
Для этого закажите у менеджера включение опции '''Proxy check URL''' на своей интеграции. После того как её включат, укажите в настройках свой URL.

[[File:Proxy url.png]]

'''Обратите внимание, что сразу после заполнения этого поля данные начнут отправляться на указанный URL. Оставьте его пустым до тех пор, пока не настроите проксирование на сервере.'''

= Настройка на стороне клиента =
Для того, чтобы проксирование данных происходило корректно и мы получали все необходимые параметры нужно настроить сервер.

===== Настройка для Nginx =====
В блок http надо добавить:
<pre>
upstream antifraud {
server kaminari.systems;
keepalive 10;
}
</pre>

<div class="mw-translate-fuzzy">
В конфиг надо добавить (в примере показан вариант с проксированием на эндпойнт <code>/antifraud</code>):
<pre>
location /antifraud {
rewrite /antifraud /v2/check break;
proxy_set_header Host kaminari.systems;
proxy_http_version 1.1;
proxy_set_header Connection "";
proxy_set_header X-Forwarded-For $http_x_forwarded_for;
proxy_set_header X-Real-IP $remote_addr;
proxy_set_header X-KUser-IP $http_x_real_ip;
proxy_pass http://kaminari.systems;
}
</pre>
[[Category:Features]]
</div>

Translations:Proxy check URL/8/en

2025-06-18T10:38:01Z

FuzzyBot: Importing a new version from external source

To the configuration, you need to add (the example demonstrates proxying to the <code>/antifraud</code> endpoint):
<pre>
location /antifraud {
rewrite /antifraud /v2/check break;
proxy_set_header Host kaminari.systems;
proxy_http_version 1.1;
proxy_set_header Connection "";
proxy_set_header X-Forwarded-For $http_x_forwarded_for;
proxy_set_header X-Original-IP $http_x_real_ip;
proxy_pass http://kaminari.systems;
}
</pre>
[[Category:Features]]

Conversions/ru

2025-01-28T03:09:27Z

FuzzyBot: Updating to match new version of source page

<languages/>
Если вы хотите проверять с нашей помощью конверсии, включите опцию '''Conversions''' на своей интеграции

= Общий алгоритм работы =
На показе вы запускаете наш скрипт и передаёте в него уникальный индентификатор показа в параметре <code>cnvId</code>. Мы проверяем показ и пишем результаты проверки в базу данных.

После того, как случилась конверсия вы шлёте нам постбек с тем же самым уникальным идентификатором. С его помощью мы склеиваем конверсию и проверку показа и выводим результат в статистике.

= Реализация в интеграции типа JS Check =
Добавьте в <code>window.kmnr</code> ключ <code>cnvId</code> с любым удобным для вас уникальным идентификатором.

[[File:Conversion 1.png]]

= Реализация в интеграции типа Meta Redirect =
Добавьте в URL GET-параметр <code>cnvId</code>.

<pre>https://kaminari.systems/v1/click?kmnrKey=111111111&cnvId=CONVERSION_ID&u=https%3A%2F%2Fsome.url</pre>

= Постбек =
На любом типе интеграции после конверсии пришлите нам на URL <code>https://kaminari.systems/v1/conversion</code> постбек со следующими параметрами:

<pre>https://kaminari.systems/v1/conversion?kmnrKey=111111111&cnvId=CONVERSION_ID&sub1=111&sub2=222&sub3=333&sub4=444&sub5=555&sub6=666&sub7=777&status=l1&currency=RUB&payout=12</pre>

{| class="wikitable"
|-
! Name !! Value !! -
|-
| cnvId || Уникальный идентификатор конверсии || '''обязательный'''
|-
| kmnrKey || Идентификатор интеграции || '''обязательный'''
|-
| sub1 || Метки, отправленные нам на показе || необязательный
|-
| sub2 || ... || необязательный
|-
| sub3 || ... || необязательный
|-
| sub4 || ... || необязательный
|-
| sub5 || ... || необязательный
|-
| sub6 || ... || необязательный
|-
| sub7 || ... || необязательный
|-
| status || Cтатус конверсии, возможные значения: <code>l1</code>, <code>l2</code>, <code>l3</code>, <code>l4</code> || '''обязательный'''
|-
| currency || Валюта конверсии (<code>RUB</code>, <code>USD</code>, <code>EUR</code>). Полный список возможных значений: [https://www.xe.com/iso4217.php ISO 4217] || необязательный
|-
| payout || Стоимость конверсии || необязательный
|}

= Показ конверсий в статистике =
После того, как опция включена и механизм передачи <code>cnvId</code> реализован, в статистике у вас появится метрика '''Conversions / Конверсии'''. С её помощью можно смотреть какие срезы конвертили больше, а какие меньше. Например, мы смотрим срез по '''Sub 5'''.

[[File:Conversion 2.png]]

Если нажать на значение конверсии, вы попадёте в таблицу, в которой будут только те показы, которые сконвертили. Например, на срезе <code>Sub 5 = 807</code> было четыре конверсии, и мы можем подробно рассмотреть их.

[[File:Conversion 3.png]]

Чтобы выйти из этого среза и вернуться на предыдущую таблицу, нажмите на стрелку под заголовком колонки '''Conversions'''.

Conversions/en

2025-01-28T03:09:26Z

FuzzyBot: Updating to match new version of source page

<languages/>
If you want to check conversions with our help, activate the '''Conversions''' option on your integration.

= General workflow =
At the hit, you run our script and pass it the unique identifier of the hit in the <code>cnvId</code> parameter. We check the visitor and write the verification results to the database.

After the conversion has occurred, you send us a postback with the same unique identifier. With its help, we combine conversion and hit's verification and display the result in statistics.

= Implementation JS Check-type integration =
Add the <code>cnvId</code> key to <code>window.kmnr</code> with any unique identifier convenient for you.

[[File:Conversion 1.png]]

= Implementation Meta Redirect-type integration =
Add the <code>cnvId</code> parameter into URL.

<pre>https://kaminari.systems/v1/click?kmnrKey=111111111&cnvId=CONVERSION_ID&u=https%3A%2F%2Fsome.url</pre>

= Postback =
For any type of integration after conversion, send us a postback to the URL <code>https://kaminari.systems/v1/conversion</code> with the following parameters:

<pre>https://kaminari.systems/v1/conversion?kmnrKey=111111111&cnvId=CONVERSION_ID&sub1=111&sub2=222&sub3=333&sub4=444&sub5=555&sub6=666&sub7=777&status=l1&currency=RUB&payout=12</pre>

{| class="wikitable"
|-
! Name !! Value !! -
|-
| cnvId || Unique conversion identifier convenient for you || '''required'''
|-
| kmnrKey || Integration identifier || '''required'''
|-
| sub1 || Sub-tags that were sent with the hit || optional
|-
| sub2 || ... || optional
|-
| sub3 || ... || optional
|-
| sub4 || ... || optional
|-
| sub5 || ... || optional
|-
| sub6 || ... || optional
|-
| sub7 || ... || optional
|-
| status || Conversion status, possible values are: <code>l1</code>, <code>l2</code>, <code>l3</code>, <code>l4</code> || '''required'''
|-
| currency || Conversion currency (<code>RUB</code>, <code>USD</code>, <code>EUR</code>). Complete list of possible values: [https://www.xe.com/iso4217.php ISO 4217] || optional
|-
| payout || Conversion payout || optional
|}

= How to view conversions in statistics =
After the option is enabled and the parameter <code>cnvId</code> passing mechanism is implemented, you will see the '''Conversion''' metric in your statistics. With its help, you can see which slices converted more and which converted less. For example, we are looking at a '''Sub 5''' slice.

[[File:Conversion 2.png]]

If you click on the conversion value, you will be taken to a table that will only show impressions that converted. For example, there were four conversions on the <code>Sub 5 = 807</code>, and here we can look at them in detail.

[[File:Conversion 3.png]]

To exit this slice and return to the previous table, click on the arrow under the column heading '''Conversions'''.

Translations:Conversions/9/en

2025-01-27T19:36:01Z

FuzzyBot: Importing a new version from external source

<pre>https://kaminari.systems/v1/conversion?kmnrKey=111111111&cnvId=CONVERSION_ID&sub1=111&sub2=222&sub3=333&sub4=444&sub5=555&sub6=666&sub7=777&status=l1&currency=RUB&payout=12</pre>

Translations:Conversions/8/en

2025-01-27T19:36:01Z

FuzzyBot: Importing a new version from external source

= Postback =
For any type of integration after conversion, send us a postback to the URL <code>https://kaminari.systems/v1/conversion</code> with the following parameters:

Translations:Conversions/10/en

2025-01-27T19:34:08Z

FuzzyBot: Importing a new version from external source

{| class="wikitable"
|-
! Name !! Value !! -
|-
| cnvId || Unique conversion identifier convenient for you || '''required'''
|-
| kmnrKey || Integration identifier || '''required'''
|-
| sub1 || Sub-tags that were sent with the hit || optional
|-
| sub2 || ... || optional
|-
| sub3 || ... || optional
|-
| sub4 || ... || optional
|-
| sub5 || ... || optional
|-
| sub6 || ... || optional
|-
| sub7 || ... || optional
|-
| status || Conversion status, possible values are: <code>l1</code>, <code>l2</code>, <code>l3</code>, <code>l4</code> || '''required'''
|-
| currency || Conversion currency (<code>RUB</code>, <code>USD</code>, <code>EUR</code>). Complete list of possible values: [https://www.xe.com/iso4217.php ISO 4217] || optional
|-
| payout || Conversion payout || optional
|}

Translations:Conversions/9/en

2025-01-27T19:34:08Z

FuzzyBot: Importing a new version from external source

<pre>https://kaminari.space/v1/conversion?kmnrKey=111111111&cnvId=CONVERSION_ID&sub1=111&sub2=222&sub3=333&sub4=444&sub5=555&sub6=666&sub7=777&status=l1&currency=RUB&payout=12</pre>

Metrics and groups/en

2024-11-07T13:54:03Z

FuzzyBot: Updating to match new version of source page

<languages></languages>

== User agent ==
User agent is a header that a browser, program, or application sends to a server when accessing a website. The user agent typically contains the browser name, its version, the engine on which the browser is based, the operating system and its version. The user agent can also contain the name and model of the mobile device on which it is running and some other information. In other words, it is a browser's business card.

The problem is that this business card is very easy to fake - using extensions or even just in DevTools. Almost any programming language has the ability to pass any information to the user agent when accessing a server. Therefore, user agents should be treated with caution.

Normally, the browser does not lie about itself. There are, of course, exceptions, such as extensions that help change the user agent, or mobile browsers or applications in which an unchanged user agent is embedded because developers are too lazy to change it. But such cases can be ignored - they are either isolated or can be added to the exceptions.

It's another matter when the transmitted information does not match what we learned about the browser as a result of checking, and this pattern prevails on a slice - through the user agent, we see a variety of browsers, but the analysis shows that these are all accesses from the same browser.

Therefore, the user agent is an "unreliable storyteller" and the information we obtain from it should be treated with a healthy dose of skepticism.

== Metrics ==
Metrics are parameters that allow you to answer the question 'how much?' How many visits did the website have? How many of them were made by bots, and how many by real users?

=== General metrics ===
{| class="wikitable"
|-
! Name !! Description
|-
| Hits || Total number of checks.
|-
| Unique users || Number of unique users counted based on IP, user agent and client hints.
|-
| Good || Number of checks resulting in non-bot, non-suspicious, and non-technical loss traffic.
|-
| Tech. losses || Number of clicks that we couldn't verify. Reasons include browsers with disabled JS, outdated browsers, etc.
|}

=== Invalid traffic (IVT) ===
Invalid traffic consists of bot traffic and scammers traffic.

A bot is a program or automated script that requests web content (including digital advertising) without user involvement. It could be, for example, a browser on an infected computer that is part of a botnet, or a script written by a programmer that scrapes websites for some purpose.

Scammers traffic is traffic generated by real people who are tricked into requesting web content (including digital advertising) without knowing about it.

{| class="wikitable"
|-
! Name !! Description
|-
| IVT total || Number of hits made by bots or caused by scammers.
|-
| Crawler || Legitimate bots that honestly declare their botness through the user agent. These could be search engine bots indexing the web, social media bots, etc. Despite not having malicious intent, they cannot convert and are not the target audience, so they should be ignored.
|-
| Spoofing || Bots whose user agent does not match the actual browser version and/or operating system.
|-
| Automated || Bots using headless browsers or automation tools like Selenium. The original purpose of such solutions is to automate software, website, application testing, etc. Then bot operators realized they could also use them for click fraud, view fraud, etc., and added them to their inventory.
|-
| Incorrect requests || During the analysis, we found that the impression came from an invisible element. For example, a user clicked on a link, but this click ended up in an invisible iframe that was located on top of the link. So the impression will be counted, but the real user did not see the advertisement and did not know where he was clicking.

Or we found that the impression was not initiated by the user, but by a script without the user’s knowledge..
|-
| Bad reputation IP || IPs from which only technical losses come. For example, someone set up a server in a data center, and using CURL, or another tool for http requests (and they are found in all programming languages), parses pages, and then clicks on advertising links using the same tool.
|-
| Blocked hits || Hits that were blocked according to integration settings.
|}

=== Suspicious visits (SV) ===
We see something suspicious in the analysis results, but it is not enough to confidently state that it is a bot. Possible reasons include the user having a harmless extension that somehow affects our checks, or the user accessing through a VPN.

Suspicious clicks require an individual approach, for example, to determine where to attribute suspicious traffic based on conversions - to fraudulent or good traffic.

{| class="wikitable"
|-
! Name !! Description
|-
| SV total || Number of suspicious clicks.
|-
| Proxy || Users accessing through VPN, proxy, or Tor. These are live clicks, but they come from non-targeted geo. If you are buying traffic from a specific geo, and there are a lot of proxies on it, then the traffic is bad.
|-
| Suspicion of spoofing || We suspect that user agent spoofing techniques are being used in the browser. If this metric is low, there is nothing to worry about. But if its percentage is high and you are not buying any specific mobile traffic, then there is a reason to think about it.
|-
| Suspicion of automated || We suspect that automation tools are being used in the browser.
|-
| Suspicion of fraud || Other types of suspicious activity, such as a too-wide screen, can be the result of poor layout or an attempt to hide ads outside the screen.
|}

=== Feature ===
Some browser features that we detect.

{| class="wikitable"
|-
! Name !! Description
|-
| AdBlock || Whether AdBlock is installed in the user's browser or not. Note that we only check for the presence of AdBlock; whether it is turned on or off is not checked.
|-
| Is mobile || Checking by characteristic features (not by user agent) whether the device is mobile (smartphones, tablets) or not (desktops, TVs).
|-
| WebView || Number of visits with Chrome WebView. Chrome WebView is a greatly reduced functionality version of mobile Chrome that is used in apps to view web pages, as well as many mobile browsers for Android, which are customized WebView. Most WebViews cannot display pushes. Therefore, if there is a high percentage of WebView on push traffic, the traffic may be bad.
|-
| IFrame || Number of visits made via iframe. <iframe> tag HTML element represents a nested browsing context, embedding another HTML page into the current one.
|-
| Push notifications || Number of visits from browsers that support push notifications.
|}

=== Behavioral analysis ===
Metrics based on the analysis of how the user behaved on the page.

{| class="wikitable"
|-
! Name !! Description
|-
| Visible page || The number of visits when the page received focus, meaning it was open in the foreground rather than in the background tab of the browser.
|-
| Active page || The number of visits when there was at least minimal activity on the page. Activity is defined as clicks, touches, scrolls, mouse movements.
|-
| Accepted page || The number of visits when the time from page opening to its closure exceeded 15 seconds.
|}

== Groups ==
Groups are parameters that allow you to answer the question "which?". From which countries were the clicks? Which browsers did users use?

=== Time ===
{| class="wikitable"
|-
! Name !! Description
|-
| Hour || Groups statistics by hours.
|-
| Day || Groups statistics by days.
|-
| Week || Groups statistics by weeks.
|-
| Month || Groups statistics by months. The maximum period that can be selected is two months.
|}

=== Tags ===
{| class="wikitable"
|-
! Name !! Description
|-
| Integration || Kaminari integration ID.
|-
| Bot type || Grouping by bot types.
|-
| Referer || URL of the page from which the user landed on the page.
|-
| Sub1..Sub7 || Tags set by the client.
|}

=== Geo ===
{| class="wikitable"
|-
! Name !! Description
|-
| Language || User's preferred language, i.e. UI language set in the browser settings.
|-
| Timezone || User's timezone data obtained from IP address.
|-
| Country || Country data obtained from IP address.
|-
| City || City data obtained from IP address.
|-
| Provider || Internet service provider data obtained from IP address.
|-
| IP || IP without the last octet, i.e. there will always be zeros at the end, for example: 192.168.1.00.
|}

=== Device ===
{| class="wikitable"
|-
! Name !! Description
|-
| Real browser engine || All modern browsers are based on three open-source engines:
# Blink (Chrome, Chromium, Yandex Browser, Samsung Browser, modern Opera and MS Edge, most Android browsers);
# WebKit ((Safari; versions of Chrome, Yandex Browser, Firefox, etc. for iOS; browsers in PlayStation);
# Gecko (Firefox).
There are also three old unsupported engines that are still present on the internet in the form of Internet Explorer, in MS Edge up to version 18 and in Opera up to version 12.
We can determine all 6 engines by their characteristic features, as well as determine the specific version of the engine. It is the browser engine that we write this data to.
|-
| Real OS || The current OS without version.
|-
| Browser from UA || Browser name and version taken from user agent.
|-
| OS from UA || Operating system and its version taken from user agent.
|-
| Device from UA || Mobile device manufacturer obtained from user agent.
|-
| Device type from UA || Device type (desktop, smartphone, smart TV, etc.) obtained from user agent.
|-
| Connection type || The type of connection that the device uses to connect to the network (Bluetooth, Wi-Fi, mobile internet).
|}

=== Screen ===
{| class="wikitable"
|-
! Name !! Description
|-
| Screen width || Screen width in pixels.
|-
| Screen height || Screen height in pixels.
|-
| Screen orientation || Screen orientation is relevant for mobile devices - portrait, upside-down, turned left, turned right.
|-
| Pixel density || How many screen pixels will be used to render one CSS pixel, i.e. this is actually the screen resolution.
|}

Translations:Metrics and groups/19/en

2024-11-07T08:46:12Z

FuzzyBot: Importing a new version from external source

=== Device ===
{| class="wikitable"
|-
! Name !! Description
|-
| Real browser engine || All modern browsers are based on three open-source engines:
# Blink (Chrome, Chromium, Yandex Browser, Samsung Browser, modern Opera and MS Edge, most Android browsers);
# WebKit ((Safari; versions of Chrome, Yandex Browser, Firefox, etc. for iOS; browsers in PlayStation);
# Gecko (Firefox).
There are also three old unsupported engines that are still present on the internet in the form of Internet Explorer, in MS Edge up to version 18 and in Opera up to version 12.
We can determine all 6 engines by their characteristic features, as well as determine the specific version of the engine. It is the browser engine that we write this data to.
|-
| Real OS || The current OS without version.
|-
| Browser from UA || Browser name and version taken from user agent.
|-
| OS from UA || Operating system and its version taken from user agent.
|-
| Device from UA || Mobile device manufacturer obtained from user agent.
|-
| Device type from UA || Device type (desktop, smartphone, smart TV, etc.) obtained from user agent.
|-
| Connection type || The type of connection that the device uses to connect to the network (Bluetooth, Wi-Fi, mobile internet).
|}

Translations:Metrics and groups/18/en

2024-11-07T08:46:12Z

FuzzyBot: Importing a new version from external source

=== Geo ===
{| class="wikitable"
|-
! Name !! Description
|-
| Language || User's preferred language, i.e. UI language set in the browser settings.
|-
| Timezone || User's timezone data obtained from IP address.
|-
| Country || Country data obtained from IP address.
|-
| City || City data obtained from IP address.
|-
| Provider || Internet service provider data obtained from IP address.
|-
| IP || IP without the last octet, i.e. there will always be zeros at the end, for example: 192.168.1.00.
|}

Conversions/ru

2024-10-24T02:27:19Z

FuzzyBot: Updating to match new version of source page

<languages/>
Если вы хотите проверять с нашей помощью конверсии, включите опцию '''Conversions''' на своей интеграции

= Общий алгоритм работы =
На показе вы запускаете наш скрипт и передаёте в него уникальный индентификатор показа в параметре <code>cnvId</code>. Мы проверяем показ и пишем результаты проверки в базу данных.

После того, как случилась конверсия вы шлёте нам постбек с тем же самым уникальным идентификатором. С его помощью мы склеиваем конверсию и проверку показа и выводим результат в статистике.

= Реализация в интеграции типа JS Check =
Добавьте в <code>window.kmnr</code> ключ <code>cnvId</code> с любым удобным для вас уникальным идентификатором.

[[File:Conversion 1.png]]

= Реализация в интеграции типа Meta Redirect =
Добавьте в URL GET-параметр <code>cnvId</code>.

<pre>https://kaminari.systems/v1/click?kmnrKey=111111111&cnvId=CONVERSION_ID&u=https%3A%2F%2Fsome.url</pre>

= Постбек =
На любом типе интеграции после конверсии пришлите нам на URL <code>https://kaminari.click/v1/conversion</code> постбек со следующими параметрами:

<pre>https://kaminari.space/v1/conversion?kmnrKey=111111111&cnvId=CONVERSION_ID&sub1=111&sub2=222&sub3=333&sub4=444&sub5=555&sub6=666&sub7=777&status=approved&currency=RUB&payout=12</pre>

{| class="wikitable"
|-
! Name !! Value !! -
|-
| cnvId || Уникальный идентификатор конверсии || '''обязательный'''
|-
| kmnrKey || Идентификатор интеграции || '''обязательный'''
|-
| sub1 || Метки, отправленные нам на показе || необязательный
|-
| sub2 || ... || необязательный
|-
| sub3 || ... || необязательный
|-
| sub4 || ... || необязательный
|-
| sub5 || ... || необязательный
|-
| sub6 || ... || необязательный
|-
| sub7 || ... || необязательный
|-
| status || Cтатус конверсии, возможные значения: <code>approved</code>, <code>reject</code>, <code>hold</code>, <code>test</code> || '''обязательный'''
|-
| currency || Валюта конверсии (<code>RUB</code>, <code>USD</code>, <code>EUR</code>). Полный список возможных значений: [https://www.xe.com/iso4217.php ISO 4217] || необязательный
|-
| payout || Стоимость конверсии || необязательный
|}

= Показ конверсий в статистике =
После того, как опция включена и механизм передачи <code>cnvId</code> реализован, в статистике у вас появится метрика '''Conversions / Конверсии'''. С её помощью можно смотреть какие срезы конвертили больше, а какие меньше. Например, мы смотрим срез по '''Sub 5'''.

[[File:Conversion 2.png]]

Если нажать на значение конверсии, вы попадёте в таблицу, в которой будут только те показы, которые сконвертили. Например, на срезе <code>Sub 5 = 807</code> было четыре конверсии, и мы можем подробно рассмотреть их.

[[File:Conversion 3.png]]

Чтобы выйти из этого среза и вернуться на предыдущую таблицу, нажмите на стрелку под заголовком колонки '''Conversions'''.

Conversions/en

2024-10-23T21:10:15Z

FuzzyBot: Updating to match new version of source page

<languages/>
If you want to check conversions with our help, activate the '''Conversions''' option on your integration.

= General workflow =
At the hit, you run our script and pass it the unique identifier of the hit in the <code>cnvId</code> parameter. We check the visitor and write the verification results to the database.

After the conversion has occurred, you send us a postback with the same unique identifier. With its help, we combine conversion and hit's verification and display the result in statistics.

= Implementation JS Check-type integration =
Add the <code>cnvId</code> key to <code>window.kmnr</code> with any unique identifier convenient for you.

[[File:Conversion 1.png]]

= Implementation Meta Redirect-type integration =
Add the <code>cnvId</code> parameter into URL.

<pre>https://kaminari.systems/v1/click?kmnrKey=111111111&cnvId=CONVERSION_ID&u=https%3A%2F%2Fsome.url</pre>

= Postback =
For any type of integration after conversion, send us a postback to the URL <code>https://kaminari.click/v1/conversion</code> with the following parameters:

<pre>https://kaminari.space/v1/conversion?kmnrKey=111111111&cnvId=CONVERSION_ID&sub1=111&sub2=222&sub3=333&sub4=444&sub5=555&sub6=666&sub7=777&status=approved&currency=RUB&payout=12</pre>

{| class="wikitable"
|-
! Name !! Value !! -
|-
| cnvId || Unique conversion identifier convenient for you || '''required'''
|-
| kmnrKey || Integration identifier || '''required'''
|-
| sub1 || Sub-tags that were sent with the hit || optional
|-
| sub2 || ... || optional
|-
| sub3 || ... || optional
|-
| sub4 || ... || optional
|-
| sub5 || ... || optional
|-
| sub6 || ... || optional
|-
| sub7 || ... || optional
|-
| status || Conversion status, possible values are: <code>approved</code>, <code>reject</code>, <code>hold</code>, <code>test</code> || '''required'''
|-
| currency || Conversion currency (<code>RUB</code>, <code>USD</code>, <code>EUR</code>). Complete list of possible values: [https://www.xe.com/iso4217.php ISO 4217] || optional
|-
| payout || Conversion payout || optional
|}

= How to view conversions in statistics =
After the option is enabled and the parameter <code>cnvId</code> passing mechanism is implemented, you will see the '''Conversion''' metric in your statistics. With its help, you can see which slices converted more and which converted less. For example, we are looking at a '''Sub 5''' slice.

[[File:Conversion 2.png]]

If you click on the conversion value, you will be taken to a table that will only show impressions that converted. For example, there were four conversions on the <code>Sub 5 = 807</code>, and here we can look at them in detail.

[[File:Conversion 3.png]]

To exit this slice and return to the previous table, click on the arrow under the column heading '''Conversions'''.

Translations:Conversions/9/en

2024-10-23T21:10:12Z

FuzzyBot: Importing a new version from external source

<pre>https://kaminari.space/v1/conversion?kmnrKey=111111111&cnvId=CONVERSION_ID&sub1=111&sub2=222&sub3=333&sub4=444&sub5=555&sub6=666&sub7=777&status=approved&currency=RUB&payout=12</pre>

Translations:Conversions/1/en

2024-10-23T21:10:12Z

FuzzyBot: Importing a new version from external source

If you want to check conversions with our help, activate the '''Conversions''' option on your integration.

Metrics and groups/ru

2024-08-23T14:46:42Z

FuzzyBot: Updating to match new version of source page

<languages></languages>

== User agent ==
User agent — это заголовок, который браузер, программа или приложение передают серверу при любом заходе на сайт. В user agent содержится как правило название браузера, его версия, движок на основе которого сделан браузер, операционная система и её версия. Так же user agent может содержать название и модель мобильного устройства, на котором он запущен и некоторую другую информацию. То есть это визитная карточка браузера.

Проблема в том, что эту визитную карточку очень легко подделать — с помощью расширений или даже просто в DevTools. Практически в любом языке программирования есть возможность при обращении к серверу передать в user agent любую информацию. Поэтому к user agent надо относиться с осторожностью.

В норме браузер не врёт о себе. Есть разумеется исключения, вроде тех же расширений, которые помогают изменить user agent, или мобильных браузеров или приложений, в которых зашит неизменный user agent, потому что разработчики ленятся его менять. Но такие случаи можно игнорировать — они либо единичны, либо их можно добавить в исключения.

Другое дело, когда переданная информация не соответствует тому, что мы узнали о браузере в результате проверки, и этот паттерн превалирует на срезе — по user agent мы видим разнообразие браузеров, а анализ показывает, что это всё заходы с одного и того же браузера.

Поэтому user agent является «ненадёжным расказчиком» и к информации, которую мы добываем из него надо относиться со здоровой долей скептицизма.

== Метрики ==
Метрики — это параметры, которые позволяют ответить на вопрос «сколько?». Сколько было заходов на сайт? Сколько из них было совершено ботами, а сколько живыми пользователями?

=== Общие метрики ===
{| class="wikitable"
|-
! Название !! Название !! Описание
|-
| Hits || Переходы || Общее количество проверок
|-
| Unique users || Уники || Количество уникальных пользователей, подсчитанное на основе IP, user agent и client hints.
|-
| Good || Хорошие переходы || Количество проверок, по результату которых переход оказался не ботовым, не подозрительным и не тех. потерей.
|-
| Tech. losses || Тех. потери || Количество переходов, которые мы не смогли проверить. Причины — браузеры с отключённым JS, устаревшие браузеры и пр.
|}

=== Недействительные переходы (IVT) ===
Недействительный трафик состоит из ботового и мошеннического трафика.

Бот — это программа или автоматизированный скрипт, который запрашивает веб-контент (включая цифровую рекламу) без участия пользователя. Это может быть например браузер на заражённом компьютере, являющимся частью ботнета. Или написанный программистом скрипт, который обходит сайты с какой-то целью.

Мошеннический трафик — трафик, который генерят живые люди, которые путём обмана запрашивают веб-контент (включая цифровую рекламу) сами того не зная.

{| class="wikitable"
|-
! Название !! Название !! Описание
|-
| BV total || Всего IVT || Количество переходов, совершённых ботами или спровоцированных мошенниками.
|-
| Crawler || Crawler || Легитимные боты, которые честно заявляют о своей ботовости через user agent. Это могут быть боты поисковых систем, индексирующие веб; боты соц. сетей и пр. Не смотря на то, что они не имеют злых намерений, они не могут совершить конверсию и не являются целевой аудиторий, поэтому должны быть проигнорированы.
|-
| Spoofing || Подмена UA || Боты, чей user agent не соответствует реальной версии браузера и / или операционной системы.
|-
| Automated || Автоматизация || Боты, использующие headless-браузеры или инструменты автоматизации вроде Selenium. Изначальная цель таких решений — автоматизированное тестирование программного обеспечения, сайтов, приложений и пр. Потом ботоводы поняли, что их так же можно использовать для скликивания ссылок, накручивания просмотров и т. д. и взяли в свой инвентарь.
|-
| Incorrect requests || Плохие запросы || При анализе мы увидели, что показ пришёл из невидимого элемента. Например, пользователь кликнул на какой-то ссылке, но этот клик попал в невидимый iframe, который был расположен поверх ссылки. То есть показ засчитается, но реальный пользователь не видел рекламы и не знал куда он кликает.

Или мы увидели показ был инициирован не пользователем, а скриптом помимо воли пользователя.

|-
| Bad reputation IP || Ботовые IP || IP, с которых приходят только тех. потери. Например, кто-то поднял в датацентре сервер, и с помощью CURL, или другой тулзы для http-запросов (а они есть во всех языках программирования) парсит страницы, а потом прокликивает рекламные ссылки с помощью того же CURL.
|-
| Blocked hits || Заблокированные переходы || Переходы, которые были заблокированы с соответствии с настройками интеграции.
|}

=== Подозрительные переходы (SV, suspicious visits) ===
Мы видим в результатах анализа что-то подозрительное, но этого не хватает чтобы со всей уверенностью утверждать, что перед нами бот. Возможные причины — у пользователя установлено безобидное расширение, которые однако как-то аффектит наши проверки. Или пользователь заходит через VPN.

Подозрительные переходы требуют индивидуального подхода, чтобы например по конверсиям решить куда отнести подозрительный трафик — в фродовый или хороший.

{| class="wikitable"
|-
! Название !! Название !! Описание
|-
| SV total || SV total || Количество подозрительных переходов.
|-
| Proxy || Прокси || Пользователи, заходящие с VPN, proxy или Tor. Это живые клики, но они идут с нецелевых гео. Если вы закупаете трафик с конкретного гео, а на нём много прокси, значит трафик плохой.
|-
| Suspicion of spoofing || Подозрение на подмену user agent || Мы подозреваем, что в браузере используются техники подмены user agent. Если эта метрика мала, значит не о чем возноваться. Если же её процент высок и вы не закупаете какой-то специфичный мобильный трафик, то есть повод призадуматься.
|-
| Suspicion of automated || Подозрение на автоматизацию || Мы подозреваем, что в браузере используются инструменты автоматизации.
|-
| Suspicion of fraud || Подозрение на мошенничество || Другие виды подозрительной активности, например слишком широкий экран — это может быть как результатом плохой вёрстки, так и попыткой скрыть рекламу за пределами экрана.
|}

=== Особенности (Feature) ===
Некоторые особенности браузеров, детектируемые нами.

{| class="wikitable"
|-
! Название !! Название !! Описание
|-
| AdBlock || AdBlock || Установлен в браузере пользователя AdBlock или нет. Обратите внимание — мы проверяем только наличие AdBlock, включён он или выключен не проверяется.
|-
| Is mobile || Мобильное устройство || Проверка по характерным признакам (не по user agent) является устройство мобильным (смартфоны, планшеты) или нет (десктоп, телевизоры).
|-
| WebView || WebView || Количество визитов с Chrome WebView. Chrome WebView — это сильно урезанная по функционалу разновидность мобильного Chrome, которая используется в прилах для просмотра веб-страниц, а так же многие мобильные браузеры для Андроида — это кастомизированные WebView. Большая часть WebView не умеют показывать пуши. Поэтому если на push-трафике большой процент WebView значит, возможно, трафик плохой.
|-
| IFrame || IFrame || Количество визитов осуществлённых через iframe. Тег <iframe> — это HTML-элемент, позволяющий встраивать в страницу отдельный, законченный HTML-документ, то есть другую веб-страницу.
|-
| Push notifications || Пуши || Количество визитов с браузеров, поддерживающих пуши.
|}

=== Поведенческий анализ ===
Метрики, основанные на анализе того, как пользователь вёл себя на странице.

{| class="wikitable"
|-
! Название !! Описание
|-
| Видимость страницы || Количество визитов, во время которых страница получала фокус, то есть была открыта не в фоне, а в активной вкладке браузера.
|-
| Активность на странице || Количество визитов, во время которых была хотя бы минимальная активность на странице. Под активностью понимаются клики, тачи, скроллы, движения мышкой.
|-
| Принятие страницы || Количество визитов, во время которых время от открытия страницы до её закрытия превышало 15 секунд.
|}

== Группировки ==
Группировки — это параметры, которые позволяют ответить на вопрос «какие?». Из каких стран были переходы? Какие браузеры использовали пользователи?

=== Время ===
{| class="wikitable"
|-
! Название !! Название !! Описание
|-
| Hour || Час || Группирует статистику по часам.
|-
| Day || День || Группирует статистику по дням.
|-
| Week || Неделя || Группирует статистику по неделям.
|-
| Month || Месяц || Группирует статистику по месяцам. Максимальный период, который можно выбрать — два месяца.
|}

=== Метки ===
{| class="wikitable"
|-
! Название !! Название !! Описание
|-
| Integration || Интеграция || Интеграция в Kaminari.
|-
| Bot type || Тип бота || Группировка по типам ботов.
|-
| Referer || Реферер || URL страницы, с которой пользователь попал на страницу.
|-
| Sub1..Sub7 || Sub1..Sub7 || Метки, установленные клиентом.
|}

=== Гео ===
{| class="wikitable"
|-
! Название !! Название !! Описание
|-
| Language || Язык || Предпочитаемый язык пользователя, то есть язык UI, установленный в настройках браузера.
|-
| Timezone || Часовой пояс || Часовой пояс браузера, фактически часовой пояс операционной системы пользователя.
|-
| Country || Страна || Данные о стране, полученные из IP.
|-
| City || Город || Данные о городе, полученные из IP.
|-
| Provider || Интернет-провайдер || Данные об интернет-провайдере, полученные из IP.
|}

=== Девайс ===
{| class="wikitable"
|-
! Название !! Название !! Описание
|-
| Browser || Браузер || Название браузера и его версия, взятые из user agent.
|-
| Browser engine || Движок браузера || Все современные браузеры делаются на базе трёх опенсорсных движков:
# Blink (Хром, Хромиум, Яндекс-браузер, Самсунг-браузер, современные Опера и MS Edge, большинство браузеров для Андроида);
# WebKit (Safari; версии Хрома, Яндекс-браузера, Firefox и пр. для iOS; браузеры в PlayStation);
# Gecko (Firefox).
Так же есть 3 старых неподдерживаемых движка, которые до сих пор встречаются в сети в виде Internet Explorer, в MS Edge до 18 версии и в Опере до 12 версии.
Мы умеем определять по характерным признакам все 6 движков, а так же умеем определять конкретную версию движка. В Движок браузера мы и пишем эти данные.
|-
| OS || ОС || Операционная система и её версия, взятые из user agent.
|-
| Real OS || Настоящая ОС || Настоящая ОС, без версии.
|-
| Device || Устройство || Производитель мобильного устройства, полученный из user-agent.
|-
| Device type || Тип устройства || Тип устройства (десктоп, смартфон, умный телевизор и пр.), полученный из user-agent.
|-
| Connection type || Тип соединения || Тип соединения, которое устройство использует для связи с сетью (блютус, вай-фай, мобильный интернет).
|}

=== Экран ===
{| class="wikitable"
|-
! Название !! Название !! Описание
|-
| Screen width || Ширина экрана || Ширина экрана в пикселях.
|-
| Screen height || Высота экрана || Высота экрана в пикселях.
|-
| Screen orientation || Ориентация экрана || Ориентация экрана актуальна для мобильных устройств — портретная, вверх ногами, повёрнуто влево, повёрнуто вправо.
|-
| Pixel density || Плотность пикселей || Сколько экранных пикселей будет использовано для отрисовки одного CSS-пикселя, то есть фактически это разрешение экрана.
|}

Metrics and groups/en

2024-08-23T11:43:42Z

FuzzyBot: Updating to match new version of source page

<languages></languages>

== User agent ==
User agent is a header that a browser, program, or application sends to a server when accessing a website. The user agent typically contains the browser name, its version, the engine on which the browser is based, the operating system and its version. The user agent can also contain the name and model of the mobile device on which it is running and some other information. In other words, it is a browser's business card.

The problem is that this business card is very easy to fake - using extensions or even just in DevTools. Almost any programming language has the ability to pass any information to the user agent when accessing a server. Therefore, user agents should be treated with caution.

Normally, the browser does not lie about itself. There are, of course, exceptions, such as extensions that help change the user agent, or mobile browsers or applications in which an unchanged user agent is embedded because developers are too lazy to change it. But such cases can be ignored - they are either isolated or can be added to the exceptions.

It's another matter when the transmitted information does not match what we learned about the browser as a result of checking, and this pattern prevails on a slice - through the user agent, we see a variety of browsers, but the analysis shows that these are all accesses from the same browser.

Therefore, the user agent is an "unreliable storyteller" and the information we obtain from it should be treated with a healthy dose of skepticism.

== Metrics ==
Metrics are parameters that allow you to answer the question 'how much?' How many visits did the website have? How many of them were made by bots, and how many by real users?

=== General metrics ===
{| class="wikitable"
|-
! Name !! Description
|-
| Hits || Total number of checks.
|-
| Unique users || Number of unique users counted based on IP, user agent and client hints.
|-
| Good || Number of checks resulting in non-bot, non-suspicious, and non-technical loss traffic.
|-
| Tech. losses || Number of clicks that we couldn't verify. Reasons include browsers with disabled JS, outdated browsers, etc.
|}

=== Invalid traffic (IVT) ===
Invalid traffic consists of bot traffic and scammers traffic.

A bot is a program or automated script that requests web content (including digital advertising) without user involvement. It could be, for example, a browser on an infected computer that is part of a botnet, or a script written by a programmer that scrapes websites for some purpose.

Scammers traffic is traffic generated by real people who are tricked into requesting web content (including digital advertising) without knowing about it.

{| class="wikitable"
|-
! Name !! Description
|-
| IVT total || Number of hits made by bots or caused by scammers.
|-
| Crawler || Legitimate bots that honestly declare their botness through the user agent. These could be search engine bots indexing the web, social media bots, etc. Despite not having malicious intent, they cannot convert and are not the target audience, so they should be ignored.
|-
| Spoofing || Bots whose user agent does not match the actual browser version and/or operating system.
|-
| Automated || Bots using headless browsers or automation tools like Selenium. The original purpose of such solutions is to automate software, website, application testing, etc. Then bot operators realized they could also use them for click fraud, view fraud, etc., and added them to their inventory.
|-
| Incorrect requests || During the analysis, we found that the impression came from an invisible element. For example, a user clicked on a link, but this click ended up in an invisible iframe that was located on top of the link. So the impression will be counted, but the real user did not see the advertisement and did not know where he was clicking.

Or we found that the impression was not initiated by the user, but by a script without the user’s knowledge..
|-
| Bad reputation IP || IPs from which only technical losses come. For example, someone set up a server in a data center, and using CURL, or another tool for http requests (and they are found in all programming languages), parses pages, and then clicks on advertising links using the same tool.
|-
| Blocked hits || Hits that were blocked according to integration settings.
|}

=== Suspicious visits (SV) ===
We see something suspicious in the analysis results, but it is not enough to confidently state that it is a bot. Possible reasons include the user having a harmless extension that somehow affects our checks, or the user accessing through a VPN.

Suspicious clicks require an individual approach, for example, to determine where to attribute suspicious traffic based on conversions - to fraudulent or good traffic.

{| class="wikitable"
|-
! Name !! Description
|-
| SV total || Number of suspicious clicks.
|-
| Proxy || Users accessing through VPN, proxy, or Tor. These are live clicks, but they come from non-targeted geo. If you are buying traffic from a specific geo, and there are a lot of proxies on it, then the traffic is bad.
|-
| Suspicion of spoofing || We suspect that user agent spoofing techniques are being used in the browser. If this metric is low, there is nothing to worry about. But if its percentage is high and you are not buying any specific mobile traffic, then there is a reason to think about it.
|-
| Suspicion of automated || We suspect that automation tools are being used in the browser.
|-
| Suspicion of fraud || Other types of suspicious activity, such as a too-wide screen, can be the result of poor layout or an attempt to hide ads outside the screen.
|}

=== Feature ===
Some browser features that we detect.

{| class="wikitable"
|-
! Name !! Description
|-
| AdBlock || Whether AdBlock is installed in the user's browser or not. Note that we only check for the presence of AdBlock; whether it is turned on or off is not checked.
|-
| Is mobile || Checking by characteristic features (not by user agent) whether the device is mobile (smartphones, tablets) or not (desktops, TVs).
|-
| WebView || Number of visits with Chrome WebView. Chrome WebView is a greatly reduced functionality version of mobile Chrome that is used in apps to view web pages, as well as many mobile browsers for Android, which are customized WebView. Most WebViews cannot display pushes. Therefore, if there is a high percentage of WebView on push traffic, the traffic may be bad.
|-
| IFrame || Number of visits made via iframe. <iframe> tag HTML element represents a nested browsing context, embedding another HTML page into the current one.
|-
| Push notifications || Number of visits from browsers that support push notifications.
|}

=== Behavioral analysis ===
Metrics based on the analysis of how the user behaved on the page.

{| class="wikitable"
|-
! Name !! Description
|-
| Visible page || The number of visits when the page received focus, meaning it was open in the foreground rather than in the background tab of the browser.
|-
| Active page || The number of visits when there was at least minimal activity on the page. Activity is defined as clicks, touches, scrolls, mouse movements.
|-
| Accepted page || The number of visits when the time from page opening to its closure exceeded 15 seconds.
|}

== Groups ==
Groups are parameters that allow you to answer the question "which?". From which countries were the clicks? Which browsers did users use?

=== Time ===
{| class="wikitable"
|-
! Name !! Description
|-
| Hour || Groups statistics by hours.
|-
| Day || Groups statistics by days.
|-
| Week || Groups statistics by weeks.
|-
| Month || Groups statistics by months. The maximum period that can be selected is two months.
|}

=== Tags ===
{| class="wikitable"
|-
! Name !! Description
|-
| Integration || Kaminari integration ID.
|-
| Bot type || Grouping by bot types.
|-
| Referer || URL of the page from which the user landed on the page.
|-
| Sub1..Sub7 || Tags set by the client.
|}

=== Geo ===
{| class="wikitable"
|-
! Name !! Description
|-
| Language || User's preferred language, i.e. UI language set in the browser settings.
|-
| Timezone || Browser time zone, actually the user's operating system time zone.
|-
| Country || Country data obtained from IP address.
|-
| City || City data obtained from IP address.
|-
| Provider || Internet service provider data obtained from IP address.
|}

=== Device ===
{| class="wikitable"
|-
! Name !! Description
|-
| Browser || Browser name and version taken from user agent.
|-
| Browser engine || All modern browsers are based on three open-source engines:
# Blink (Chrome, Chromium, Yandex Browser, Samsung Browser, modern Opera and MS Edge, most Android browsers);
# WebKit ((Safari; versions of Chrome, Yandex Browser, Firefox, etc. for iOS; browsers in PlayStation);
# Gecko (Firefox).
There are also three old unsupported engines that are still present on the internet in the form of Internet Explorer, in MS Edge up to version 18 and in Opera up to version 12.
We can determine all 6 engines by their characteristic features, as well as determine the specific version of the engine. It is the browser engine that we write this data to.
|-
| OS || Operating system and its version taken from user agent.
|-
| Real OS || The current OS without version.
|-
| Device || Mobile device manufacturer obtained from user agent.
|-
| Device type || Device type (desktop, smartphone, smart TV, etc.) obtained from user agent.
|-
| Connection type || The type of connection that the device uses to connect to the network (Bluetooth, Wi-Fi, mobile internet).
|}

=== Screen ===
{| class="wikitable"
|-
! Name !! Description
|-
| Screen width || Screen width in pixels.
|-
| Screen height || Screen height in pixels.
|-
| Screen orientation || Screen orientation is relevant for mobile devices - portrait, upside-down, turned left, turned right.
|-
| Pixel density || How many screen pixels will be used to render one CSS pixel, i.e. this is actually the screen resolution.
|}

Translations:Metrics and groups/7/en

2024-08-23T09:20:47Z

FuzzyBot: Importing a new version from external source

=== General metrics ===
{| class="wikitable"
|-
! Name !! Description
|-
| Hits || Total number of checks.
|-
| Unique users || Number of unique users counted based on IP, user agent and client hints.
|-
| Good || Number of checks resulting in non-bot, non-suspicious, and non-technical loss traffic.
|-
| Tech. losses || Number of clicks that we couldn't verify. Reasons include browsers with disabled JS, outdated browsers, etc.
|}

Stat API/en

2024-06-01T18:10:13Z

FuzzyBot: Updating to match new version of source page

<languages/>
'''[https://kaminari.click/user How to obtain the token]'''

'''[https://kaminari.click/api/doc Detailed description of the requests and responses for each endpoint].'''

=== '''Endpoint list:''' ===
{| class="wikitable"
! Method !! Path !! Description
|-
| OPTIONS || /api/stat/get || Returns all possible groupings and metrics grouped by categories
|-
| POST || /api/stat/filter || Obtaining data for filter
|-
| POST || /api/stat/data || Obtaining data for the table
|}

== How to get all possible groupings and metrics ==
To obtain all possible groupings and metrics grouped by categories use this URL:
{| class="wikitable"
! Method !! Path
|-
| OPTIONS || /api/stat/get
|}

'''If you want to better understand what our metrics mean, visit page [[Metrics_and_groups|Metrics and groups]].'''

=== Request ===
''No parameters''

=== Response ===
<div class="mw-collapsible mw-collapsed" style="width:80%; overflow:auto;">
Response example
<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>

==== API ====
{| class="wikitable"
! Key !! Type !! Description
|-
| success || Boolean || Was the request successful or it failed
|-
| code || Number || Response status code
|-
|msg || [String] || Error message
|-
| colspan="3" |data
|-
|data.groups
|{ groupTitle: ['''<item>''', …] }
|See bellow description '''<item>'''
|-
|data.metrics
|{ metricTitle: ['''<item>''', …] }
|See bellow description '''<item>'''
|}

{| class="wikitable mw-collapsible"
|+Description '''<item>'''
!Key
!Type
!Description
|-
|id
|String
|<groupTitle or metricTitle>
+ underscore

+ <metric or group's name> (groupTitle_id, for example: lowQuality_total, feature_adBlock)

|-
|icon
|<code>date</code><nowiki> | </nowiki><code>text</code><nowiki> | </nowiki><code>number</code>
|Type of content served
|-
|filterType
|<code>range</code><nowiki> | </nowiki><code>list</code><nowiki> | </nowiki><code>binary</code>
|See bellow description '''<filters>'''
|-
|filterSync
|Boolean *
|<code>list</code> with server-side search
|}

== How to get all possible values for filter ==
To obtain values use this URL:
{| class="wikitable"
! Method !! Path
|-
| POST || /api/stat/filter
|}

=== Request ===
<div class="mw-collapsible" style="width:80%; overflow:auto;">
Request example
<pre class="mw-collapsible-content">
{
"id":"geo_language",
"searchQuery":"en",
"dateFrom":"2024-04-10",
"dateTo":"2024-04-10"
}
</pre>
</div>

==== API ====
{| class="wikitable"
!Key
!Type
!Description
|-
|id
|String
|Filter name
|-
|searchQuery
|String
|Search query
|-
|dateFrom
|String
|What date should we start searching? Date in the format Y-m-d.
|-
|dateTo
|String
|Until what date should we continue searching?? Date in the format Y-m-d.
|}

=== Response ===
<div class="mw-collapsible mw-collapsed" style="width:80%; overflow:auto;">
Response example
<pre class="mw-collapsible-content">
{
"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"
!Key
!Type
!Description
|-
| success || Boolean || Was the request successful or it failed
|-
| code || Number || Response status code
|-
|msg || [String] || Error message
|-
| colspan="3" |data
|-
|data.items
|[{ id: Number, label: String }]
|{ id: 1, label: "Param A" }
|}

== How to get full statistic data ==
To obtain such data use this URL:
{| class="wikitable"
! Method !! Path
|-
| POST || /api/stat/data
|}

=== Request ===
<div class="mw-collapsible mw-collapsed" style="width:80%; overflow:auto;">
Request example
<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"
!Key
!Type
!Description
|-
|id
|String
|Optional parameter
|-
|name
|String
|Optional parameter
|-
|perPage
|Number
|Number of lines shown simultaneously. Default value is 50.
|-
|page
|Number
|Current page number. Default value is 1.
|-
|groups
|[String]
|Groups you would like to see in statistics.

'''Allowed values:''' time_hour, time_day, time_week, time_month, time_dateTime, sub_integration, sub_botType, sub_referer, sub_1, sub_2, sib_3, sub_4, sub_5, sub_6, sub_7, geo_language, geo_timezone, geo_country, geo_city, geo_provider, device_browser, device_browserEngine, device_os, device_realOs, device_device, device_type, device_connectionType, device_useragent, screen_width, screen_height, screen_orientation, screen_pixelDensity

'''Full list of metrics you can get with this [[#How_to_get_all_possible_groupings_and_metrics|URL]].'''
|-
|metrics
|[String]
|Metrics you would like to see in statistics.

'''Allowed values:''' summary_totalVisits, summary_uniqUsers, summary_uniqUsersPc, summary_validVisits, summary_validVisitsPc, summary_techLosses, summary_techLossesPc, bots_total, bots_totalPc, bots_crawler, bots_crawlerPc, bots_spoofing, bots_spoofingPc, bots_automated, bots_automatedPc, bots_iFrame, bots_iFramePc, bots_badReputationIp, bots_badReputationIpPc, bots_blocked, bots_blockedPc, lowQuality_total, lowQuality_totalPc, lowQuality_proxy, lowQuality_proxyPc, lowQuality_spoofing, lowQuality_spoofingPc, lowQuality_automated, lowQuality_automatedPc, lowQuality_trafficCheats, lowQuality_trafficCheatsPc, feature_adBlock, feature_adBlockPc, feature_isMobile, feature_isMobilePc, feature_webView, feature_webViewPc, feature_iFrame, feature_iFramePc, feature_pushNotifications, feature_pushNotificationsPc. ''Those values are allowed only if option [[Behavioral analysis|Behavioral analysis]] is turned on for you integration'': beAn_pageVisibility, beAn_pageVisibilityPc, beAn_pageActivity, beAn_pageActivityPc, beAn_pageAcceptance, beAn_pageAcceptancePc

Metrics whose ID ends with ''Pc'' (for example, lowQuality_totalPc) return percentage values.

'''Full list of metrics you can get with this [[#How_to_get_all_possible_groupings_and_metrics|URL]].'''
|-
| colspan="3" |filters
|-
|filters.dateFrom
|String
|Date in the format Y-m-d. If you specify a period, dateFrom will not work. The period has high priority.
|-
|filters.dateTo
|String
|Date in the format Y-m-d. If you specify a period, dateTo will not work. The period has high priority.
|-
|filters.period
|<nowiki>today | yesterday | currentWeek | 7days| month | null</nowiki>
|If you specify a period, dateFrom and dateTo will not work. The period has high priority
|-
|filters.timezone
|Number
|From -12 to +12. Default value is 0, which means that the data will be output in UTC.
|-
|filters.filters
|['''<filters>''']
|See bellow description '''<filters>'''
|-
|compare
|'''<compare>'''
|See bellow description '''<compare>'''
|}
{| class="wikitable mw-collapsible"
|+Description <filters>
!Key
!Type
!Description
|-
|id
|String
|Column by which you would like to filter.

'''Allowed values:''' time_hour, time_day, time_week, time_month, sub_integration, sub_botType, sub_referer, sub_1, sub_2, sib_3, sub_4, sub_5, sub_6, sub_7, geo_language, geo_timezone, geo_country, geo_city, geo_provider, device_browser, device_browserEngine, device_os, device_realOs, device_device, device_type, device_connectionType, device_useragent, screen_width, screen_height, screen_orientation, screen_pixelDensity, summary_totalVisits, summary_uniqUsers, summary_uniqUsersPc, summary_validVisits, summary_validVisitsPc, summary_techLosses, summary_techLossesPc, bots_total, bots_totalPc, bots_crawler, bots_crawlerPc, bots_spoofing, bots_spoofingPc, bots_automated, bots_automatedPc, bots_iFrame, bots_iFramePc, bots_badReputationIp, bots_badReputationIpPc, bots_blocked, bots_blockedPc, lowQuality_total, lowQuality_totalPc, lowQuality_proxy, lowQuality_proxyPc, lowQuality_spoofing, lowQuality_spoofingPc, lowQuality_automated, lowQuality_automatedPc, lowQuality_trafficCheats, lowQuality_trafficCheatsPc, feature_adBlock, feature_adBlockPc, feature_isMobile, feature_isMobilePc, feature_webView, feature_webViewPc, feature_iFrame, feature_iFramePc, feature_pushNotifications, feature_pushNotificationsPc. ''Those values are allowed only if option [[Behavioral analysis|Behavioral analysis]] is turned on for you integration'': beAn_pageVisibility, beAn_pageVisibilityPc, beAn_pageActivity, beAn_pageActivityPc, beAn_pageAcceptance, beAn_pageAcceptancePc

Filters whose ID ends with ''Pc'' (for example, lowQuality_totalPc) return percentage values.

'''Full list of metrics you can get with this [[#How_to_get_all_possible_groupings_and_metrics|URL]].'''
|-
|type
|<code>range</code><nowiki> | </nowiki><code>list</code><nowiki> | </nowiki><code>binary</code>
|
|-
|range
|{from: Number, to: Number}
|For filters with type <code>range</code>
|-
|include
|[Any]
|For filters with type <code>list</code> and <code>binary</code>. Show only records with included values.
|-
|exclude
|[Any]
|For filters with type <code>list</code> and <code>binary</code>. Show only records without included values.
|}

===== Filters examples =====
'''Type <code>list</code>, include in on.''' Search the visits only from Cambodia ("KH") or China ("CN").
<pre>
{
...
"filters":{
"filters":[
{
"id":"geo_country",
"type":"list",
"include":["KH","CN"],
"exclude":[]
}
],
"period":"today",
"timezone":-3
}
}
</pre>

'''Type <code>list</code>, exclude in on.''' Search the visits from any country except Cambodia ("KH") andr China ("CN").
<pre>
{
...
"filters":{
"filters":[
{
"id":"geo_country",
"type":"list",
"include":[],
"exclude":["KH","CN"]
}
],
"period":"today",
"timezone":-3
}
}
</pre>

'''Type <code>binary</code>, include is on.''' Search for visits made only by crawlers (i.e. search engine and social network bots).
<pre>
{
...
"filters":{
"filters":[
{
"id":"bots_crawler",
"type":"binary",
"include":[1],
"exclude":[]
}
],
"period":"today",
"timezone":-3
}
}
</pre>

'''Type <code>binary</code>, exclude is on.''' Do not show visits made by crawlers.
<pre>
{
...
"filters":{
"filters":[
{
"id":"bots_crawler",
"type":"binary",
"include":[],
"exclude":[1]
}
],
"period":"today",
"timezone":-3
}
}
</pre>

'''Type <code>range</code>.''' Search for slices, where total amount of bot visits is between 1 000 and 10 000 hits.
<pre>
{
...
"filters":{
"filters":[
{
"id":"bots_total",
"type":"range",
"range":{
"from":1000,
"to":10000
}
}
],
"period":"today",
"timezone":-3
}
}
</pre>

Type <code>range</code>. Search for slices, where more than 50% of visits made from mobile devices.
<pre>
{
...
"filters":{
"filters":[
{
"id":"feature_isMobilePc",
"type":"range",
"range":{
"from":50,
"to":null
}
}
],
"period":"today",
"timezone":-3
}
}
</pre>

Type <code>range</code>. Search for visits made before 10 a.m. UTC-3.
<pre>
{
...
"filters":{
"filters":[
{
"id":"time_hour",
"type":"range",
"range":{
"from":null,
"to":10
}
}
],
"period":"today",
"timezone":-3
}
}
</pre>

{| class="wikitable mw-collapsible"
|+Description <compare>
!Key
!Type
!Description
|-
|dateFrom
|String
|Date in the format Y-m-d
|-
|dateTo
|String
|Date in the format Y-m-d
|-
|mode
|<nowiki>compare_value | diff | percent</nowiki>
|
|-
|sort
|Boolean
|
|}

=== Response ===
<div class="mw-collapsible mw-collapsed" style="width:80%; overflow:auto;">
Response example
<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"
!Key
!Type
!Description
|-
| success || Boolean || Was the request successful or it failed
|-
| code || Number || Response status code
|-
|msg || [String] || Error message
|-
| colspan="3" |data
|-
|data.rows
|['''<row>''']
|Description of table rows
|-
|data.totalRows
|Number
|Total number of items in the table
|-
|data.total
|'''<row>'''
|Sum for each column considering invisible rows
|-
|data.page
|Number
|Current page
|-
|data.perPage
|Number
|Number of items per page
|-
|data.columns
|['''<column>''']
|Description of columns
|}
{| class="wikitable mw-collapsible"
|+
Description <row>
!Key
!Type
!Description
|-
|value
|String
|Human readable value
|-
|rawValue
|String
|Raw value
|-
|diff
|<nowiki>String | null</nowiki>
|
|-
|percent
|<nowiki>Number | null</nowiki>
|Is the value a percentage or not?
|-
|compare_value
|<nowiki>String | null</nowiki>
|Comparison value if compare is on in request
|}
{| class="wikitable mw-collapsible"
|+
Description <column>
!Key
!Type
!Description
|-
|field
|String
|ID of the metric or group
|-
|type
|<nowiki>String | Number | Float</nowiki>
|
|-
|sortable
|Boolean
|Sortable or not
|-
|unit
|<nowiki>String | null</nowiki>
|Unit of measurement
For example, % for percentage columns
|}

== Request examples ==

=== CURL ===
<pre>
curl -X 'OPTIONS' \ '<nowiki>https://kaminari.click/api/stat/get'</nowiki> \ -H 'accept: */*' 'Authorization: Bearer <YOUR API_TOKEN>'
</pre>

<pre>
curl -X POST '<nowiki>https://kaminari.click/api/stat/filter'</nowiki> -d '{"id":"device_type","searchQuery":"","dateFrom":"2023-01-05","dateTo":"2023-01-05"}' -H 'content-type: application/json' -H 'Authorization: Bearer <YOUR API_TOKEN>'
</pre>

<pre>
curl -X POST '<nowiki>https://kaminari.click/api/stat/data'</nowiki> -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>'
</pre>

=== NodeJS ===
const https = require('https');

const options = {
<nowiki> </nowiki> host: 'kaminari.click',
<nowiki> </nowiki> port: 443,
<nowiki> </nowiki> path: '/api/stat/get',
<nowiki> </nowiki> method: 'POST',
<nowiki> </nowiki> headers: { 'Authorization': 'Bearer <YOUR API_TOKEN>' }
};

https
<nowiki> </nowiki> .get(options, (resp) => {
<nowiki> </nowiki> let data = <nowiki>''</nowiki>;

<nowiki> </nowiki> resp.on('data', (chunk) => {
<nowiki> </nowiki> data += chunk;
<nowiki> </nowiki> });

<nowiki> </nowiki> resp.on('end', () => {
<nowiki> </nowiki> try {
<nowiki> </nowiki> data = JSON.parse(data);
<nowiki> </nowiki> } catch {
<nowiki> </nowiki> console.log(data);
<nowiki> </nowiki> }
<nowiki> </nowiki> });
<nowiki> </nowiki> })
<nowiki> </nowiki> .on("error", (err) => {
<nowiki> </nowiki> console.log("Error: " + err.message);
<nowiki> </nowiki> });

=== PHP ===
<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, '<nowiki>https://kaminari.click/api/stat/get'</nowiki>);
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('<nowiki>https://kaminari.click/api/stat/get'</nowiki>, headers=headers)
response = requests.options('<nowiki>http://Authorization</nowiki>: Bearer <YOUR API_TOKEN>', headers=headers)

Stat API/ru

2024-06-01T14:00:29Z

FuzzyBot: Updating to match new version of source page

<languages/>
'''[https://kaminari.click/user Где получить ключ]'''

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

=== '''Список эндпойнтов:''' ===
{| class="wikitable"
! Method !! Path !! Description
|-
| OPTIONS || /api/stat/get || Возвращает все возможные группировки и метрики, сгруппированные по категориям.
|-
| POST || /api/stat/filter || получение данных для фильтра
|-
| POST || /api/stat/data || получение данных для таблицы
|}

== Как получить список всех доступных метрик и группировок ==
Чтобы получить все метрики и группировки, сгруппированные по категориям, воспользуйтесь этим 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>

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

{| class="wikitable mw-collapsible"
|+Описание '''<item>'''
!Ключ
!Тип
!Описание
|-
|id
|String
|<groupTitle или metricTitle>
+ подчёркивание

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

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

== Как получить все возможные значения фильтра ==
Чтобы получить значения какого-то фильтра, используйте URL:
{| class="wikitable"
! Method !! Path
|-
| POST || /api/stat/filter
|}

<div class="mw-translate-fuzzy">
=== Запрос ===
<div class="mw-collapsible" style="width:80%; overflow:auto;">
Пример запроса в JSON
<pre class="mw-collapsible-content">
{
"id":"geo_language",
"searchQuery":"en",
"cancellable":true,
"dateFrom":"2024-04-10",
"dateTo":"2024-04-10"
}
</pre>
</div>
</div>

<div class="mw-translate-fuzzy">
==== API ====
{| class="wikitable"
!Ключ
!Тип
!Описание
|-
|id
|String
|Название фильтра
|-
|searchQuery
|String
|Поисковый запрос
|-
|dateFrom
|String
|Начиная с какой даты мы должны искать? Дата в формате Y-m-d.
|-
|dateTo
|String
|По какую дату мы должны искать? Дата в формате Y-m-d.
|-
|cancellable
|Boolean
|''deprecated''
|}
</div>

=== Ответ ===
<div class="mw-collapsible mw-collapsed" style="width:80%; overflow:auto;">
Пример ответа в JSON
<pre class="mw-collapsible-content">
{
"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 || Boolean || Был запрос успешным или нет
|-
| code || Number || Статус ответа
|-
|msg || [String] || Сообщение об ошибке
|-
| colspan="3" |data
|-
|data.items
|[{ id: Number, label: String }]
|{ id: 1, label: "Param A" }
|}

== Как запросить статистику ==
Чтобы получить данные по статистике, воспользуйтесь URL:
{| class="wikitable"
! Method !! Path
|-
| 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
|String
|Необязательный параметр
|-
|name
|String
|Необязательный параметр
|-
|perPage
|Number
|Количество строк, возвращаемых в запросе. Значение по умолчанию 50.
|-
|page
|Number
|Номер текущей страницы. Значение по умолчанию 1.
|-
|groups
|[String]
|Группы, которые вы хотите видеть в таблице в виде колонок

'''Возможные значения:''' time_hour, time_day, time_week, time_month, time_dateTime, sub_integration, sub_botType, sub_referer, sub_1, sub_2, sib_3, sub_4, sub_5, sub_6, sub_7, geo_language, geo_timezone, geo_country, geo_city, geo_provider, device_browser, device_browserEngine, device_os, device_realOs, device_device, device_type, device_connectionType, device_useragent, screen_width, screen_height, screen_orientation, screen_pixelDensity

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

'''Возможные значения:''' summary_totalVisits, summary_uniqUsers, summary_uniqUsersPc, summary_validVisits, summary_validVisitsPc, summary_techLosses, summary_techLossesPc, bots_total, bots_totalPc, bots_crawler, bots_crawlerPc, bots_spoofing, bots_spoofingPc, bots_automated, bots_automatedPc, bots_iFrame, bots_iFramePc, bots_badReputationIp, bots_badReputationIpPc, bots_blocked, bots_blockedPc, lowQuality_total, lowQuality_totalPc, lowQuality_proxy, lowQuality_proxyPc, lowQuality_spoofing, lowQuality_spoofingPc, lowQuality_automated, lowQuality_automatedPc, lowQuality_trafficCheats, lowQuality_trafficCheatsPc, feature_adBlock, feature_adBlockPc, feature_isMobile, feature_isMobilePc, feature_webView, feature_webViewPc, feature_iFrame, feature_iFramePc, feature_pushNotifications, feature_pushNotificationsPc. ''Those values are allowed only if option [[Behavioral analysis|Behavioral analysis]] is turned on for you integration'': beAn_pageVisibility, beAn_pageVisibilityPc, beAn_pageActivity, beAn_pageActivityPc, beAn_pageAcceptance, beAn_pageAcceptancePc

Метрики, чьи ID наканчиваются на ''Pc'' (например: lowQuality_totalPc) возвращают проценты.

'''Полный список метрик вы можете получить с помощью этого [[#How_to_get_all_possible_groupings_and_metrics|URL]].'''
|-
| colspan="3" |filters
|-
|filters.dateFrom
|String
|Дата в формате Y-m-d. Если вы указываете period, dateFrom не будет учитываться, потому что period имеет больший приоритет.
|-
|filters.dateTo
|String
|Дата в формате 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>'''
|-
|compare
|'''<compare>'''
|См. ниже описание '''<compare>'''
|}
{| class="wikitable mw-collapsible"
|+Описание <filters>
!Ключ
!Тип
!Описание
|-
|id
|String
|Колонка, по которой вы бы хотели фильтровать.

'''Возможные значения:''' time_hour, time_day, time_week, time_month, sub_integration, sub_botType, sub_referer, sub_1, sub_2, sib_3, sub_4, sub_5, sub_6, sub_7, geo_language, geo_timezone, geo_country, geo_city, geo_provider, device_browser, device_browserEngine, device_os, device_realOs, device_device, device_type, device_connectionType, device_useragent, screen_width, screen_height, screen_orientation, screen_pixelDensity, summary_totalVisits, summary_uniqUsers, summary_uniqUsersPc, summary_validVisits, summary_validVisitsPc, summary_techLosses, summary_techLossesPc, bots_total, bots_totalPc, bots_crawler, bots_crawlerPc, bots_spoofing, bots_spoofingPc, bots_automated, bots_automatedPc, bots_iFrame, bots_iFramePc, bots_badReputationIp, bots_badReputationIpPc, bots_blocked, bots_blockedPc, lowQuality_total, lowQuality_totalPc, lowQuality_proxy, lowQuality_proxyPc, lowQuality_spoofing, lowQuality_spoofingPc, lowQuality_automated, lowQuality_automatedPc, lowQuality_trafficCheats, lowQuality_trafficCheatsPc, feature_adBlock, feature_adBlockPc, feature_isMobile, feature_isMobilePc, feature_webView, feature_webViewPc, feature_iFrame, feature_iFramePc, feature_pushNotifications, feature_pushNotificationsPc. ''Those values are allowed only if option [[Behavioral analysis|Behavioral analysis]] is turned on for you integration'': beAn_pageVisibility, beAn_pageVisibilityPc, beAn_pageActivity, beAn_pageActivityPc, beAn_pageAcceptance, beAn_pageAcceptancePc

Фильтры, чьи ID наканчиваются на ''Pc'' (например: lowQuality_totalPc) возвращают проценты.

'''Полный список метрик вы можете получить с помощью этого [[#How_to_get_all_possible_groupings_and_metrics|URL]].'''
|-
|type
|<code>range</code><nowiki> | </nowiki><code>list</code><nowiki> | </nowiki><code>binary</code>
|
|-
|range
|{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"
|+Описание <compare>
!Ключ
!Тип
!Описание
|-
|dateFrom
|String
|Дата в формате Y-m-d
|-
|dateTo
|String
|Дата в формате Y-m-d
|-
|mode
|<nowiki>compare_value | diff | percent</nowiki>
|
|-
|sort
|Boolean
|
|}

=== Ответ ===
<div class="mw-collapsible mw-collapsed" style="width:80%; overflow:auto;">
Примера ответа в JSON
<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 || Boolean || Был запрос успешным или нет
|-
| code || Number || Статус ответа
|-
|msg || [String] || Сообщение об ошибке
|-
| colspan="3" |data
|-
|data.rows
|['''<row>''']
|Описание строк таблицы
|-
|data.totalRows
|Number
|Общее количество строк в таблице
|-
|data.total
|'''<row>'''
|Сумма по каждой колонке с учётом невидимых строк
|-
|data.page
|Number
|Текущая страница
|-
|data.perPage
|Number
|Количество элементов на странице
|-
|data.columns
|['''<column>''']
|Описание столбцов таблицы
|}
{| class="wikitable mw-collapsible"
|+
Description <row>
!Ключ
!Тип
!Описание
|-
|value
|String
|Значение в человеко-читаемом виде
|-
|rawValue
|String
|Сырое значение
|-
|diff
|<nowiki>String | null</nowiki>
|
|-
|percent
|<nowiki>Number | null</nowiki>
|Является значение процентом или нет
|-
|compare_value
|<nowiki>String | null</nowiki>
|Сравниваемое значение (в случае, если запрос отправлен в режиме compare)
|}
{| class="wikitable mw-collapsible"
|+
Описание <column>
!Ключ
!Тип
!Описание
|-
|field
|String
|ID метрики или группировки
|-
|type
|<nowiki>String | Number | Float</nowiki>
|
|-
|sortable
|Boolean
|Можно сортировать или нет
|-
|unit
|<nowiki>String | null</nowiki>
|Единица измерения.
Например, % у процентных столбцов
|}

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

==== CURL ====
<pre>
curl -X 'OPTIONS' \ '<nowiki>https://kaminari.click/api/stat/get'</nowiki> \ -H 'accept: */*' 'Authorization: Bearer <YOUR API_TOKEN>'
</pre>

<pre>
curl -X POST '<nowiki>https://kaminari.click/api/stat/filter'</nowiki> -d '{"id":"device_type","searchQuery":"","dateFrom":"2023-01-05","dateTo":"2023-01-05"}' -H 'content-type: application/json' -H 'Authorization: Bearer <YOUR API_TOKEN>'
</pre>

<pre>
curl -X POST '<nowiki>https://kaminari.click/api/stat/data'</nowiki> -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>'
</pre>

=== NodeJS ===
const https = require('https');

const options = {
<nowiki> </nowiki> host: 'kaminari.click',
<nowiki> </nowiki> port: 443,
<nowiki> </nowiki> path: '/api/stat/get',
<nowiki> </nowiki> method: 'POST',
<nowiki> </nowiki> headers: { 'Authorization': 'Bearer <YOUR API_TOKEN>' }
};

https
<nowiki> </nowiki> .get(options, (resp) => {
<nowiki> </nowiki> let data = <nowiki>''</nowiki>;

<nowiki> </nowiki> resp.on('data', (chunk) => {
<nowiki> </nowiki> data += chunk;
<nowiki> </nowiki> });

<nowiki> </nowiki> resp.on('end', () => {
<nowiki> </nowiki> try {
<nowiki> </nowiki> data = JSON.parse(data);
<nowiki> </nowiki> } catch {
<nowiki> </nowiki> console.log(data);
<nowiki> </nowiki> }
<nowiki> </nowiki> });
<nowiki> </nowiki> })
<nowiki> </nowiki> .on("error", (err) => {
<nowiki> </nowiki> console.log("Error: " + err.message);
<nowiki> </nowiki> });

=== PHP ===
<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, '<nowiki>https://kaminari.click/api/stat/get'</nowiki>);
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('<nowiki>https://kaminari.click/api/stat/get'</nowiki>, headers=headers)
response = requests.options('<nowiki>http://Authorization</nowiki>: Bearer <YOUR API_TOKEN>', headers=headers)

Translations:Stat API/23/en

2024-06-01T14:00:26Z

FuzzyBot: Importing a new version from external source

==== API ====
{| class="wikitable"
!Key
!Type
!Description
|-
|id
|String
|Filter name
|-
|searchQuery
|String
|Search query
|-
|dateFrom
|String
|What date should we start searching? Date in the format Y-m-d.
|-
|dateTo
|String
|Until what date should we continue searching?? Date in the format Y-m-d.
|}