Stat API: Difference between revisions

From Wiki Kaminari Click
No edit summary
No edit summary
 
(11 intermediate revisions by the same user not shown)
Line 5: Line 5:


<!--T:2-->
<!--T:2-->
'''[https://kaminari.click/api/doc Detailed description of the requests and responses for each endpoint].'''
'''[https://kaminari.click/api Detailed description of the requests and responses for each endpoint].'''


<!--T:3-->
<!--T:3-->
Line 28: Line 28:
|}
|}


<!--T:18-->
'''If you want to better understand what our metrics mean, visit page [[Metrics_and_groups|Metrics and groups]].'''
<!--T:19-->
=== Request ===
=== Request ===
No parameters
''No parameters''


<!--T:5-->
<!--T:5-->
Line 600: Line 604:
</div>
</div>


<!--T:20-->
==== API ====
==== API ====
{| class="wikitable"
{| class="wikitable"
! Key !! Type !! Description
! Key !! Type !! Description
|-
|-
| success || Boolean
| success || Boolean || Was the request successful or it failed
|-
|-
|code
| code || Number || Response status code
|
|
|-
|-
|msg
|msg || [String] || Error message
|
|
|-
|-
| colspan="3" |data
| colspan="3" |data
Line 623: Line 624:
|{ metricTitle: ['''<item>''', …] }
|{ metricTitle: ['''<item>''', …] }
|See bellow description '''<item>'''
|See bellow description '''<item>'''
|-
|data.periods
|[ 'today', 'yesterday', '7days', 'currentWeek', 'month' ]
|
|}
|}


<!--T:21-->
{| class="wikitable mw-collapsible"
{| class="wikitable mw-collapsible"
|+Description '''<item>'''
|+Description '''<item>'''
Line 637: Line 635:
|id
|id
|String
|String
|<groupTitle или metricTitle>
|<groupTitle or metricTitle>
+ underscore
+ underscore


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


<!--T:7-->
<!--T:7-->
Line 647: Line 645:
|icon
|icon
|<code>date</code><nowiki> | </nowiki><code>text</code><nowiki> | </nowiki><code>number</code>
|<code>date</code><nowiki> | </nowiki><code>text</code><nowiki> | </nowiki><code>number</code>
|Icon of the type
|Type of content served
|-
|sources
|[Number]
|
|-
|-
|filterType
|filterType
|<code>range</code><nowiki> | </nowiki><code>list</code><nowiki> | </nowiki><code>value</code><nowiki> | </nowiki><code>value_like</code><nowiki> | </nowiki><code>value_combined</code>
|<code>range</code><nowiki> | </nowiki><code>list</code><nowiki> | </nowiki><code>binary</code>
|See description filterType
|See bellow description '''<filters>'''
|-
|-
|filterSync
|filterSync
Line 671: Line 665:
|}
|}


<!--T:22-->
=== Request ===
=== Request ===
<div class="mw-collapsible" style="width:80%; overflow:auto;">
<div class="mw-collapsible" style="width:80%; overflow:auto;">
Line 678: Line 673:
   "id":"geo_language",
   "id":"geo_language",
   "searchQuery":"en",
   "searchQuery":"en",
  "cancellable":true,
   "dateFrom":"2024-04-10",
   "dateFrom":"2024-04-10",
   "dateTo":"2024-04-10"
   "dateTo":"2024-04-10"
Line 685: Line 679:
</div>
</div>


<!--T:23-->
==== API ====
==== API ====
{| class="wikitable"
{| class="wikitable"
Line 698: Line 693:
|String
|String
|Search query
|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.
|}
|}


Line 805: Line 808:
</div>
</div>


<!--T:24-->
==== API ====
==== API ====
{| class="wikitable"
{| class="wikitable"
Line 811: Line 815:
!Description
!Description
|-
|-
|success
| success || Boolean || Was the request successful or it failed
|Boolean
|
|-
|-
|code
| code || Number || Response status code
|
|
|-
|-
|msg
|msg || [String] || Error message
|
|
|-
|-
| colspan="3" |data
| colspan="3" |data
Line 839: Line 837:
|}
|}


<!--T:25-->
=== Request ===
=== Request ===
<div class="mw-collapsible mw-collapsed" style="width:80%; overflow:auto;">
<div class="mw-collapsible mw-collapsed" style="width:80%; overflow:auto;">
Line 844: Line 843:
<pre class="mw-collapsible-content">
<pre class="mw-collapsible-content">
{
{
  "perPage":50,
   "id":null,
   "id":null,
   "name":null,
   "name":null,
  "perPage":50,
   "groups":[
   "groups":[
       "time_day",
       "time_day",
Line 873: Line 872:
</div>
</div>


<!--T:26-->
==== API ====
==== API ====
{| class="wikitable"
{| class="wikitable"
Line 881: Line 881:
|id
|id
|String
|String
|
|Optional parameter
|-
|-
|name
|name
|String
|String
|
|Optional parameter
|-
|-
|perPage
|perPage
|Number
|Number
|Default value 50
|Number of lines shown simultaneously. Default value is 50.
|-
|-
|page
|page
|Number
|Number
|Default value 1
|Current page number. Default value is 1.
|-
|groups
|[String]
|Groups you would like to see in statistics.
 
<!--T:27-->
See bellow allowed values in '''<groups>'''
 
<!--T:28-->
|-
|-
|metrics
|metrics
|[String]
|[String]
|'''Allowed values:'''
|Metrics you would like to see in statistics.
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
 
<!--T:29-->
See bellow allowed values in '''<metrics>'''


'''Full list of metrics you can get with this [[#How_to_get_all_possible_groupings_and_metrics|URL]].'''
<!--T:31-->
|-
|-
| colspan="3" |filters
| colspan="3" |filters
|-
|-
|dateFrom
|filters.dateFrom
|String
|String
|Date in the format Y-m-d. If you specify a period, dateFrom will not work. The period has high priority.
|Date in the format Y-m-d. If you specify a period, dateFrom will not work. The period has high priority.
|-
|-
|dateTo
|filters.dateTo
|String
|String
|Date in the format Y-m-d. If you specify a period, dateTo will not work. The period has high priority.
|Date in the format Y-m-d. If you specify a period, dateTo will not work. The period has high priority.
|-
|-
|filters.filters
|filters.period
|'''<filters>'''
|
|-
|period
|<nowiki>today | yesterday | currentWeek | 7days| month | null</nowiki>
|<nowiki>today | yesterday | currentWeek | 7days| month | null</nowiki>
|If you specify a period, dateFrom and dateTo will not work. The period has high priority
|If you specify a period, dateFrom and dateTo will not work. The period has high priority
|-
|-
|timezone
|filters.timezone
|Number
|Number
|From -12 to +12
|From -12 to +12. Default value is 0, which means that the data will be output in UTC.
|-
|-
|groups
|filters.filters
|[String]
|['''<filters>''']
|'''Allowed values:'''  
|See bellow description '''<filters>'''
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]].'''
|-
|-
|compare
|compare
|'''<compare>'''
|'''<compare>'''
|
|See bellow description '''<compare>'''
|}
|}
{| class="wikitable mw-collapsible"
|+Description <filters>
!Key
!Type
!Description
|-
|id
|String
|'''Allowed values:'''
time_hour, time_day, time_week, time_month, sub_integration, sub_botType, sub_referer, sub_1, sub_2, sib_3, sub_4, sub_5, sub_6, sub_7, geo_language, geo_timezone, geo_country, geo_city, geo_provider, device_browser, device_browserEngine, device_os, device_realOs, device_device, device_type, device_connectionType, device_useragent, screen_width, screen_height, screen_orientation, screen_pixelDensity, summary_totalVisits, summary_uniqUsers, summary_uniqUsersPc, summary_validVisits, summary_validVisitsPc, summary_techLosses, summary_techLossesPc, bots_total, bots_totalPc, bots_crawler, bots_crawlerPc, bots_spoofing, bots_spoofingPc, bots_automated, bots_automatedPc, bots_iFrame, bots_iFramePc, bots_badReputationIp, bots_badReputationIpPc, bots_blocked, bots_blockedPc, lowQuality_total, lowQuality_totalPc, lowQuality_proxy, lowQuality_proxyPc, lowQuality_spoofing, lowQuality_spoofingPc, lowQuality_automated, lowQuality_automatedPc, lowQuality_trafficCheats, lowQuality_trafficCheatsPc, feature_adBlock, feature_adBlockPc, feature_isMobile, feature_isMobilePc, feature_webView, feature_webViewPc, feature_iFrame, feature_iFramePc, feature_pushNotifications, feature_pushNotificationsPc. ''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


'''Full list of metrics you can get with this [[#How_to_get_all_possible_groupings_and_metrics|URL]].'''
<!--T:45-->
{| class="wikitable"
|+Description <groups>
!API name
!Name in UI
!Comment
|-
|-
|type
|time_hour
|String
|Hour
|
|
|-
|-
|range
|time_day
|{from: Number, to: Number}
|Day
|
|
|}
{| class="wikitable mw-collapsible"
|+Description <compare>
!Key
!Type
!Description
|-
|-
|dateFrom
|time_week
|String
|Week
|Date in the format Y-m-d
|
|-
|-
|dateTo
|time_month
|String
|Month
|Date in the format Y-m-d
|
|-
|-
|mode
|time_dateTime
|<nowiki>compare_value | diff | percent</nowiki>
|Date time
|
|
|-
|-
|sort
|sub_integration
|Boolean
|Integration
|
|
|}
|-
 
|sub_botType
=== Response ===
|Bot or fraud type
<div class="mw-collapsible mw-collapsed" style="width:80%; overflow:auto;">
|
Response example
|-
<pre class="mw-collapsible-content">
|sub_referer
{
|Referer
   "success":true,
|
   "code":200,
|-
   "msg":[],
|sub_1
   "data":{
|Sub1
       "rows":[
|
         {
|-
             "id":0,
|sub_2
             "time_day":{
|Sub2
|
|-
|sub_3
|Sub3
|
|-
|sub_4
|Sub4
|
|-
|sub_5
|Sub5
|
|-
|sub_6
|Sub6
|
|-
|sub_7
|Sub7
|
|-
|sub_8
|Sub8
|This group is available only if feature [[Additional_subs|Additional subs]] is on
|-
|sub_9
|Sub9
|This group is available only if feature [[Additional_subs|Additional subs]] is on
|-
|sub_10
|Sub10
|This group is available only if feature [[Additional_subs|Additional subs]] is on
|-
|sub_conversionType
|Conversion status
|This group is available only if feature [[Conversions|Conversions]] is on
|-
|sub_cnvId
|Conversion ID
|This group is available only if feature [[Conversions|Conversions]] is on
|-
|sub_viewType
|Creative type
|This metric is available only if feature [[Viewability|Viewability]] is on
|-
|geo_language
|Browsers language
|
|-
|geo_timezonename
|Browsers time zone
|
|-
|geo_country
|Country from IP
|
|-
|geo_city
|City from IP
|
|-
|geo_timezone
|Time zone from IP
|
|-
|geo_provider
|Provider from IP
|
|-
|geo_ip
|Truncated IP
|We store IP without the last octet
|-
|device_browserEngine
|Real browser engine
|
|-
|device_realOs
|Real OS
|
|-
|device_connectionType
|Connection type
|
|-
|device_browser
|Browser from UA
|
|-
|device_os
|OS from UA
|
|-
|device_device
|Device from UA
|
|-
|device_type
|Device type from UA
|
|-
|device_useragent
|User agent
|
|-
|screen_width
|Screen width
|
|-
|screen_height
|Screen height
|
|-
|screen_orientation
|Ccreen orientation
|
|-
|screen_pixelDensity
|Pixel density
|
|}
 
<!--T:46-->
{| 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
|-
|view_renderedImpression
|Rendered impression
|The creative has been added to the DOM and started rendering, and is not hidden via display:none. This metric is available only if feature [[Viewability|Viewability]] is on.
|-
|view_viewableImpression
|Viewable impression
|At least 50% of the creative area was within the visible viewport continuously for at least 1 second (2 seconds for video). This metric is available only if feature [[Viewability|Viewability]] is on.
|-
|view_viewabilityRate
|Viewable rate
|The ratio of viewable impressions to total rendered impressions, expressed as a percentage. This metric is available only if feature [[Viewability|Viewability]] is on.
|-
|view_inView
|% In view
|The share of the creative area currently within the visible viewport at a given moment. This metric is available only if feature [[Viewability|Viewability]] is on.
|-
|view_viewableTime
|Viewable time
|Median time in seconds during which the creative met the visibility threshold with the browser tab in the foreground. This metric is available only if feature [[Viewability|Viewability]] is on.
|-
|view_dwellTime
|Dwell time
|Median time in seconds from the moment the creative was found on the page until the user left or closed the page. This metric is available only if feature [[Viewability|Viewability]] is on.
|-
|view_inFocusTime
|In focus time
|Median time in seconds during which the browser tab containing the creative was active and visible to the user. This metric is available only if feature [[Viewability|Viewability]] is on.
|-
|view_videoStart
|Video start
|Recorded on the first playback of the video. Subsequent plays after pause are not counted. This metric is available only if feature [[Viewability|Viewability]] is on.
|-
|view_videoQ25
|Video 25%
|The user has watched at least 25% of the video duration. Recorded once per session. This metric is available only if feature [[Viewability|Viewability]] is on.
|-
|view_videoQ50
|Video 50%
|The user has watched at least 50% of the video duration. Recorded once per session. This metric is available only if feature [[Viewability|Viewability]] is on.
|-
|view_videoQ75
|Video 75%
|The user has watched at least 75% of the video duration. Recorded once per session. This metric is available only if feature [[Viewability|Viewability]] is on.
|-
|view_videoQ100
|Video 100%
|The user watched the video to the end. For looped videos, recorded on the first complete playthrough. This metric is available only if feature [[Viewability|Viewability]] is on.
|-
|view_videoCompletionRate
|Video completion rate
|The share of sessions in which the video was watched to completion, out of all sessions where the video was started. This metric is available only if feature [[Viewability|Viewability]] is on.
|-
|view_videoTimeInView
|Time in view
|Total seconds during which the video was simultaneously playing, within the visible viewport, and the browser tab was in focus. This metric is available only if feature [[Viewability|Viewability]] is on.
|-
|view_videoMuted
|Muted
|Audio status of the video: 1 — sound is muted, 0 — sound is on. Updated on every volume change event. This metric is available only if feature [[Viewability|Viewability]] is on.
|-
|view_videoAutoplay
|Autoplay
|Indicates that the video started playing automatically without user interaction. Determined by the autoplay attribute. This metric is available only if feature [[Viewability|Viewability]] is on.
|-
|view_videoAudibleTime
|Video audible time
|Total seconds during which the video was playing with sound unmuted and volume greater than zero. This metric is available only if feature [[Viewability|Viewability]] is on.
|}
 
<!--T:47-->
{| class="wikitable mw-collapsible"
|+Description <filters>
!Key
!Type
!Description
|-
|id
|String
|Column by which you would like to filter.
 
<!--T:48-->
See above allowed values in '''<groups>''' and '''<metrics>'''
 
<!--T:34-->
|-
|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.
|}
 
<!--T:35-->
===== 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>
 
<!--T:36-->
'''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>
 
<!--T:37-->
'''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>
 
<!--T:38-->
'''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>
 
<!--T:39-->
'''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>
 
<!--T:40-->
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>
 
<!--T:41-->
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>
 
<!--T:42-->
{| 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
|
|}
 
<!--T:43-->
=== 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",
               "rawValue":"10.04.2024",
               "value":"10.04.2024",
               "value":"10.04.2024",
Line 2,322: Line 2,959:
</div>
</div>


<!--T:44-->
==== API ====
==== API ====
{| class="wikitable"
{| class="wikitable"
Line 2,328: Line 2,966:
!Description
!Description
|-
|-
|success
| success || Boolean || Was the request successful or it failed
|Boolean
|
|-
|-
|code
| code || Number || Response status code
|
|
|-
|-
|msg
|msg || [String] || Error message
|
|
|-
|-
| colspan="3" |data
| colspan="3" |data
Line 2,375: Line 3,007:
|value
|value
|String
|String
|
|Human readable value
|-
|rawValue
|String
|Raw value
|-
|-
|diff
|diff
Line 2,383: Line 3,019:
|percent
|percent
|<nowiki>Number | null</nowiki>
|<nowiki>Number | null</nowiki>
|
|Is the value a percentage or not?
|-
|-
|compare_value
|compare_value
|<nowiki>String | null</nowiki>
|<nowiki>String | null</nowiki>
|
|Comparison value if compare is on in request
|}
|}
{| class="wikitable mw-collapsible"
{| class="wikitable mw-collapsible"
Line 2,401: Line 3,037:
|-
|-
|type
|type
|<nowiki>string | number | float</nowiki>
|<nowiki>String | Number | Float</nowiki>
|
|
|-
|-

Latest revision as of 14:11, 1 July 2026

Other languages:

How to obtain the token

Detailed description of the requests and responses for each endpoint.

Endpoint list:

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:

Method Path
OPTIONS /api/stat/get

If you want to better understand what our metrics mean, visit page Metrics and groups.

Request

No parameters

Response

Response example 

{
   "success":true,
   "code":200,
   "msg":[],
   "data":{
      "groups":{
         "time":[
            {
               "id":"time_hour",
               "icon":"date",
               "filterType":"range"
            },
            {
               "id":"time_day",
               "icon":"date",
               "filterType":"range"
            },
            {
               "id":"time_week",
               "icon":"date",
               "filterType":"range"
            },
            {
               "id":"time_month",
               "icon":"date",
               "filterType":"range"
            },
            {
               "id":"time_dateTime",
               "icon":"date",
               "filterType":"list",
               "filterSync":true
            }
         ],
         "sub":[
            {
               "id":"sub_integration",
               "icon":"text",
               "filterType":"list",
               "filterSync":false
            },
            {
               "id":"sub_botType",
               "icon":"text",
               "filterType":"list",
               "filterSync":false
            },
            {
               "id":"sub_cnvId",
               "icon":"text",
               "filterType":"list",
               "filterSync":true
            },
            {
               "id":"sub_clickId",
               "icon":"number",
               "filterType":"list",
               "filterSync":true
            },
            {
               "id":"sub_referer",
               "icon":"text",
               "filterType":"list",
               "filterSync":true,
               "tooltip":true
            },
            {
               "id":"sub_1",
               "icon":"text",
               "filterType":"list",
               "filterSync":true
            },
            {
               "id":"sub_2",
               "icon":"text",
               "filterType":"list",
               "filterSync":true
            },
            {
               "id":"sub_3",
               "icon":"text",
               "filterType":"list",
               "filterSync":true
            },
            {
               "id":"sub_4",
               "icon":"text",
               "filterType":"list",
               "filterSync":true
            },
            {
               "id":"sub_5",
               "icon":"text",
               "filterType":"list",
               "filterSync":true
            },
            {
               "id":"sub_6",
               "icon":"text",
               "filterType":"list",
               "filterSync":true
            },
            {
               "id":"sub_7",
               "icon":"text",
               "filterType":"list",
               "filterSync":true
            }
         ],
         "geo":[
            {
               "id":"geo_language",
               "icon":"text",
               "filterType":"list",
               "filterSync":true
            },
            {
               "id":"geo_timezone",
               "icon":"text",
               "filterType":"list",
               "filterSync":false
            },
            {
               "id":"geo_country",
               "icon":"text",
               "filterType":"list",
               "filterSync":false
            },
            {
               "id":"geo_city",
               "icon":"text",
               "filterType":"list",
               "filterSync":true
            },
            {
               "id":"geo_provider",
               "icon":"text",
               "filterType":"list",
               "filterSync":true
            },
            {
               "id":"geo_ip",
               "icon":"text",
               "filterType":"list",
               "filterSync":true
            }
         ],
         "device":[
            {
               "id":"device_browser",
               "icon":"text",
               "filterType":"list",
               "filterSync":true,
               "tooltip":true
            },
            {
               "id":"device_browserEngine",
               "icon":"text",
               "filterType":"list",
               "filterSync":true,
               "tooltip":true
            },
            {
               "id":"device_os",
               "icon":"text",
               "filterType":"list",
               "filterSync":true,
               "tooltip":true
            },
            {
               "id":"device_realOs",
               "icon":"text",
               "filterType":"list",
               "filterSync":false,
               "tooltip":true
            },
            {
               "id":"device_device",
               "icon":"text",
               "filterType":"list",
               "filterSync":true,
               "tooltip":true
            },
            {
               "id":"device_type",
               "icon":"text",
               "filterType":"list",
               "filterSync":false,
               "tooltip":true
            },
            {
               "id":"device_connectionType",
               "icon":"text",
               "filterType":"list",
               "filterSync":false
            },
            {
               "id":"device_useragent",
               "icon":"text",
               "filterType":"list",
               "filterSync":true
            }
         ],
         "screen":[
            {
               "id":"screen_width",
               "icon":"number",
               "filterType":"range",
               "tooltip":true
            },
            {
               "id":"screen_height",
               "icon":"number",
               "filterType":"range",
               "tooltip":true
            },
            {
               "id":"screen_orientation",
               "icon":"text",
               "filterType":"list",
               "filterSync":false
            },
            {
               "id":"screen_pixelDensity",
               "icon":"number",
               "filterType":"list",
               "filterSync":true,
               "tooltip":true
            }
         ]
      },
      "metrics":{
         "summary":[
            {
               "id":"summary_totalVisits",
               "icon":"number",
               "filterType":"range"
            },
            {
               "id":"summary_validVisits",
               "icon":"number",
               "filterType":"range",
               "filterSync":false,
               "tooltip":true
            },
            {
               "id":"summary_validVisitsPc",
               "icon":"number",
               "filterType":"range",
               "filterSync":false
            },
            {
               "id":"summary_techLosses",
               "icon":"number",
               "filterType":"range",
               "filterSync":false,
               "tooltip":true
            },
            {
               "id":"summary_techLossesPc",
               "icon":"number",
               "filterType":"range",
               "filterSync":false
            },
            {
               "id":"summary_uniqUsers",
               "icon":"number",
               "filterType":"range",
               "tooltip":true
            },
            {
               "id":"summary_uniqUsersPc",
               "icon":"number",
               "filterType":"range"
            },
            {
               "id":"summary_conversions",
               "icon":"number",
               "filterType":"binary",
               "filterSync":false,
               "tooltip":true
            },
            {
               "id":"summary_conversionsPc",
               "icon":"number",
               "filterType":"range",
               "filterSync":false
            }
         ],
         "bots":[
            {
               "id":"bots_total",
               "icon":"number",
               "filterType":"range",
               "filterSync":false,
               "tooltip":true
            },
            {
               "id":"bots_totalPc",
               "icon":"number",
               "filterType":"range",
               "filterSync":false
            },
            {
               "id":"bots_crawler",
               "icon":"number",
               "filterType":"binary",
               "filterSync":false,
               "tooltip":true
            },
            {
               "id":"bots_crawlerPc",
               "icon":"number",
               "filterType":"range",
               "filterSync":false
            },
            {
               "id":"bots_spoofing",
               "icon":"number",
               "filterType":"binary",
               "filterSync":false,
               "tooltip":true
            },
            {
               "id":"bots_spoofingPc",
               "icon":"number",
               "filterType":"range",
               "filterSync":false
            },
            {
               "id":"bots_automated",
               "icon":"number",
               "filterType":"binary",
               "filterSync":false,
               "tooltip":true
            },
            {
               "id":"bots_automatedPc",
               "icon":"number",
               "filterType":"range",
               "filterSync":false
            },
            {
               "id":"bots_iFrame",
               "icon":"number",
               "filterType":"binary",
               "filterSync":false,
               "tooltip":true
            },
            {
               "id":"bots_iFramePc",
               "icon":"number",
               "filterType":"range",
               "filterSync":false
            },
            {
               "id":"bots_badReputationIp",
               "icon":"number",
               "filterType":"binary",
               "filterSync":false,
               "tooltip":true
            },
            {
               "id":"bots_badReputationIpPc",
               "icon":"number",
               "filterType":"range",
               "filterSync":false
            },
            {
               "id":"bots_blocked",
               "icon":"number",
               "filterType":"binary",
               "filterSync":false,
               "tooltip":true
            },
            {
               "id":"bots_blockedPc",
               "icon":"number",
               "filterType":"range",
               "filterSync":false
            }
         ],
         "lowQuality":[
            {
               "id":"lowQuality_total",
               "icon":"number",
               "filterType":"binary",
               "filterSync":false,
               "tooltip":true
            },
            {
               "id":"lowQuality_totalPc",
               "icon":"number",
               "filterType":"range",
               "filterSync":false
            },
            {
               "id":"lowQuality_proxy",
               "icon":"number",
               "filterType":"binary",
               "filterSync":false,
               "tooltip":true
            },
            {
               "id":"lowQuality_proxyPc",
               "icon":"number",
               "filterType":"range",
               "filterSync":false
            },
            {
               "id":"lowQuality_spoofing",
               "icon":"number",
               "filterType":"binary",
               "filterSync":false,
               "tooltip":true
            },
            {
               "id":"lowQuality_spoofingPc",
               "icon":"number",
               "filterType":"range",
               "filterSync":false
            },
            {
               "id":"lowQuality_automated",
               "icon":"number",
               "filterType":"binary",
               "filterSync":false,
               "tooltip":true
            },
            {
               "id":"lowQuality_automatedPc",
               "icon":"number",
               "filterType":"range",
               "filterSync":false
            },
            {
               "id":"lowQuality_trafficCheats",
               "icon":"number",
               "filterType":"binary",
               "filterSync":false,
               "tooltip":true
            },
            {
               "id":"lowQuality_trafficCheatsPc",
               "icon":"number",
               "filterType":"range",
               "filterSync":false
            }
         ],
         "feature":[
            {
               "id":"feature_adBlock",
               "icon":"number",
               "filterType":"list",
               "filterSync":false,
               "tooltip":true
            },
            {
               "id":"feature_adBlockPc",
               "icon":"number",
               "filterType":"range"
            },
            {
               "id":"feature_isMobile",
               "icon":"number",
               "filterType":"binary",
               "tooltip":true
            },
            {
               "id":"feature_isMobilePc",
               "icon":"number",
               "filterType":"range"
            },
            {
               "id":"feature_webView",
               "icon":"number",
               "filterType":"binary",
               "tooltip":true
            },
            {
               "id":"feature_webViewPc",
               "icon":"number",
               "filterType":"range"
            },
            {
               "id":"feature_iFrame",
               "icon":"number",
               "filterType":"binary",
               "filterSync":false,
               "tooltip":true
            },
            {
               "id":"feature_iFramePc",
               "icon":"number",
               "filterType":"range",
               "filterSync":false
            },
            {
               "id":"feature_pushNotifications",
               "icon":"number",
               "filterType":"binary",
               "filterSync":false,
               "tooltip":true
            },
            {
               "id":"feature_pushNotificationsPc",
               "icon":"number",
               "filterType":"range",
               "filterSync":false
            }
         ],
         "beAn":[
            {
               "id":"beAn_pageVisibility",
               "icon":"number",
               "filterType":"list",
               "filterSync":false,
               "tooltip":true,
               "disabled":false
            },
            {
               "id":"beAn_pageVisibilityPc",
               "icon":"number",
               "filterType":"range",
               "filterSync":false,
               "disabled":false
            },
            {
               "id":"beAn_pageActivity",
               "icon":"number",
               "filterType":"list",
               "filterSync":false,
               "tooltip":true,
               "disabled":false
            },
            {
               "id":"beAn_pageActivityPc",
               "icon":"number",
               "filterType":"range",
               "filterSync":false,
               "disabled":false
            },
            {
               "id":"beAn_pageAcceptance",
               "icon":"number",
               "filterType":"list",
               "filterSync":false,
               "tooltip":true,
               "disabled":false
            },
            {
               "id":"beAn_pageAcceptancePc",
               "icon":"number",
               "filterType":"range",
               "filterSync":false,
               "disabled":false
            }
         ]
      }
   }
}

API

Key Type Description
success Boolean Was the request successful or it failed
code Number Response status code
msg [String] Error message
data
data.groups { groupTitle: [<item>, …] } See bellow description <item>
data.metrics { metricTitle: [<item>, …] } See bellow description <item>
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 date | text | number Type of content served
filterType range | list | binary See bellow description <filters>
filterSync Boolean * list with server-side search

How to get all possible values for filter

To obtain values use this URL:

Method Path
POST /api/stat/filter

Request

Request example 

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

API

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

Response example 

{
   "success":true,
   "code":200,
   "msg":[],
   "data":{
      "items":[
         {
            "id":"bd",
            "label":"Bengali"
         },
         {
            "id":"bez",
            "label":"Bena (Tanzania)"
         },
         {
            "id":"bn",
            "label":"Bengali"
         },
         {
            "id":"ce",
            "label":"Chechen"
         },
         {
            "id":"ckb",
            "label":"Central Kurdish"
         },
         {
            "id":"en",
            "label":"English"
         },
         {
            "id":"fr",
            "label":"French"
         },
         {
            "id":"hy",
            "label":"Armenian"
         },
         {
            "id":"kam",
            "label":"Kamba (Kenya)"
         },
         {
            "id":"kln",
            "label":"Kalenjin"
         },
         {
            "id":"km",
            "label":"Central Khmer"
         },
         {
            "id":"luo",
            "label":"Luo (Kenya and Tanzania)"
         },
         {
            "id":"mfe",
            "label":"Morisyen"
         },
         {
            "id":"seh",
            "label":"Sena"
         },
         {
            "id":"ses",
            "label":"Koyraboro Senni Songhai"
         },
         {
            "id":"sl",
            "label":"Slovenian"
         },
         {
            "id":"tk",
            "label":"Turkmen"
         },
         {
            "id":"tzm",
            "label":"Central Atlas Tamazight"
         },
         {
            "id":"ve",
            "label":"Venda"
         },
         {
            "id":"vec",
            "label":"Venetian"
         },
         {
            "id":"yav",
            "label":"Yangben"
         },
         {
            "id":"yrl",
            "label":"Nhengatu"
         }
      ]
   }
}

API

Key Type Description
success Boolean Was the request successful or it failed
code Number Response status code
msg [String] Error message
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:

Method Path
POST /api/stat/data

Request

Request example 

{
   "id":null,
   "name":null,
   "perPage":50,
   "groups":[
      "time_day",
      "geo_country"
   ],
   "metrics":[
      "summary_totalVisits",
      "bots_total",
      "bots_totalPc"
   ],
   "filters":{
      "filters":[
         {
            "id":"geo_language",
            "type":"list",
            "include":["sl", "hr", "sh", "bs", "sr"],
            "exclude":[]
         }
      ],
      "period":"today",
      "timezone":-3
   },
   "compare":null
}

API

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>

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 today | yesterday | currentWeek | 7days| month | null 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>
Description <groups>
API name Name in UI Comment
time_hour Hour
time_day Day
time_week Week
time_month Month
time_dateTime Date time
sub_integration Integration
sub_botType Bot or fraud type
sub_referer Referer
sub_1 Sub1
sub_2 Sub2
sub_3 Sub3
sub_4 Sub4
sub_5 Sub5
sub_6 Sub6
sub_7 Sub7
sub_8 Sub8 This group is available only if feature Additional subs is on
sub_9 Sub9 This group is available only if feature Additional subs is on
sub_10 Sub10 This group is available only if feature Additional subs is on
sub_conversionType Conversion status This group is available only if feature Conversions is on
sub_cnvId Conversion ID This group is available only if feature Conversions is on
sub_viewType Creative type This metric is available only if feature Viewability is on
geo_language Browsers language
geo_timezonename Browsers time zone
geo_country Country from IP
geo_city City from IP
geo_timezone Time zone from IP
geo_provider Provider from IP
geo_ip Truncated IP We store IP without the last octet
device_browserEngine Real browser engine
device_realOs Real OS
device_connectionType Connection type
device_browser Browser from UA
device_os OS from UA
device_device Device from UA
device_type Device type from UA
device_useragent User agent
screen_width Screen width
screen_height Screen height
screen_orientation Ccreen orientation
screen_pixelDensity Pixel density
Description <metrics>
API name Name in UI Comment
summary_totalVisits Hits
summary_validVisits Good
summary_techLosses Tech. losses
summary_uniqUsers Unique users
summary_validVisitsPc Good, %
summary_techLossesPc Tech. losses, %
summary_uniqUsersPc Unique users, %
bots_total IVT total Bots and fraud total
bots_crawler Crawler bots
bots_spoofing Spoofing bots
bots_automated Automated bots
bots_iFrame Incorrect requests
bots_badReputationIp Bad reputation IP bots
bots_blocked Blocked hits
bots_totalPc IVT total, %
bots_crawlerPc Crawler bots, %
bots_spoofingPc Spoofing bots, %
bots_automatedPc Automated bots, %
bots_iFramePc Incorrect requests, %
bots_badReputationIpPc Bad reputation IP bots, %
bots_blockedPc Blocked hits, %
lowQuality_total SV total Suspicious visits total
lowQuality_proxy Proxy
lowQuality_spoofing Spoofing SV Suspicious visits, that may be spoofing
lowQuality_automated Automated SV Suspicious visits, that may be automated bots
lowQuality_trafficCheats Fraud SV Other types of suspicious visits
lowQuality_totalPc SV total, %
lowQuality_proxyPc Proxy, %
lowQuality_spoofingPc Spoofing SV, %
lowQuality_automatedPc Automated SV, %
lowQuality_trafficCheatsPc Fraud SV, %
conversions_total Conversions This metric is available only if feature Conversions is on
conversions_l1 L1 This metric is available only if feature Conversions is on
conversions_l2 L2 This metric is available only if feature Conversions is on
conversions_l3 L3 This metric is available only if feature Conversions is on
conversions_l4 L4 This metric is available only if feature Conversions is on
conversions_totalPc Conversions, % This metric is available only if feature Conversions is on
conversions_l1Pc L1, % This metric is available only if feature Conversions is on
conversions_l2Pc L2, % This metric is available only if feature Conversions is on
conversions_l3Pc L3, % This metric is available only if feature Conversions is on
conversions_l4Pc L4, % This metric is available only if feature Conversions is on
feature_adBlock AdBlock
feature_isMobile Is mobile
feature_webView WebView
feature_iFrame IFrame
feature_pushNotifications Push notifications
feature_adBlockPc AdBlock, %
feature_isMobilePc Is mobile, %
feature_webViewPc WebView, %
feature_iFramePc IFrame, %
feature_pushNotificationsPc Push notifications, %
beAn_pageVisibility Visible page This metric is available only if feature Behavioral analysis is on
beAn_pageActivity Active page This metric is available only if feature Behavioral analysis is on
beAn_pageAcceptance Accepted page This metric is available only if feature Behavioral analysis is on
beAn_pageVisibilityPc Visible page, % This metric is available only if feature Behavioral analysis is on
beAn_pageActivityPc Active page, % This metric is available only if feature Behavioral analysis is on
beAn_pageAcceptancePc Accepted page, % This metric is available only if feature Behavioral analysis is on
view_renderedImpression Rendered impression The creative has been added to the DOM and started rendering, and is not hidden via display:none. This metric is available only if feature Viewability is on.
view_viewableImpression Viewable impression At least 50% of the creative area was within the visible viewport continuously for at least 1 second (2 seconds for video). This metric is available only if feature Viewability is on.
view_viewabilityRate Viewable rate The ratio of viewable impressions to total rendered impressions, expressed as a percentage. This metric is available only if feature Viewability is on.
view_inView % In view The share of the creative area currently within the visible viewport at a given moment. This metric is available only if feature Viewability is on.
view_viewableTime Viewable time Median time in seconds during which the creative met the visibility threshold with the browser tab in the foreground. This metric is available only if feature Viewability is on.
view_dwellTime Dwell time Median time in seconds from the moment the creative was found on the page until the user left or closed the page. This metric is available only if feature Viewability is on.
view_inFocusTime In focus time Median time in seconds during which the browser tab containing the creative was active and visible to the user. This metric is available only if feature Viewability is on.
view_videoStart Video start Recorded on the first playback of the video. Subsequent plays after pause are not counted. This metric is available only if feature Viewability is on.
view_videoQ25 Video 25% The user has watched at least 25% of the video duration. Recorded once per session. This metric is available only if feature Viewability is on.
view_videoQ50 Video 50% The user has watched at least 50% of the video duration. Recorded once per session. This metric is available only if feature Viewability is on.
view_videoQ75 Video 75% The user has watched at least 75% of the video duration. Recorded once per session. This metric is available only if feature Viewability is on.
view_videoQ100 Video 100% The user watched the video to the end. For looped videos, recorded on the first complete playthrough. This metric is available only if feature Viewability is on.
view_videoCompletionRate Video completion rate The share of sessions in which the video was watched to completion, out of all sessions where the video was started. This metric is available only if feature Viewability is on.
view_videoTimeInView Time in view Total seconds during which the video was simultaneously playing, within the visible viewport, and the browser tab was in focus. This metric is available only if feature Viewability is on.
view_videoMuted Muted Audio status of the video: 1 — sound is muted, 0 — sound is on. Updated on every volume change event. This metric is available only if feature Viewability is on.
view_videoAutoplay Autoplay Indicates that the video started playing automatically without user interaction. Determined by the autoplay attribute. This metric is available only if feature Viewability is on.
view_videoAudibleTime Video audible time Total seconds during which the video was playing with sound unmuted and volume greater than zero. This metric is available only if feature Viewability is on.
Description <filters>
Key Type Description
id String Column by which you would like to filter.

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

type range | list | binary
range {from: Number, to: Number} For filters with type range
include [Any] For filters with type list and binary. Show only records with included values.
exclude [Any] For filters with type list and binary. Show only records without included values.
Filters examples

Type list, include in on. Search the visits only from Cambodia ("KH") or China ("CN"). 

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

Type list, exclude in on. Search the visits from any country except Cambodia ("KH") andr China ("CN"). 

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

Type binary, include is on. Search for visits made only by crawlers (i.e. search engine and social network bots). 

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

Type binary, exclude is on. Do not show visits made by crawlers. 

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

Type range. Search for slices, where total amount of bot visits is between 1 000 and 10 000 hits. 

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

Type range. Search for slices, where more than 50% of visits made from mobile devices. 

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

Type range. Search for visits made before 10 a.m. UTC-3. 

{
   ...
   "filters":{
      "filters":[
         {
            "id":"time_hour",
            "type":"range",
            "range":{
               "from":null,
               "to":10
            }
         }
      ],
      "period":"today",
      "timezone":-3
   }
}
Description <compare>
Key Type Description
dateFrom String Date in the format Y-m-d
dateTo String Date in the format Y-m-d
mode compare_value | diff | percent
sort Boolean

Response

Response example 

{
   "success":true,
   "code":200,
   "msg":[],
   "data":{
      "rows":[
         {
            "id":0,
            "time_day":{
               "rawValue":"10.04.2024",
               "value":"10.04.2024",
               "diff":null,
               "percent":null,
               "compare_value":null
            },
            "geo_country":{
               "rawValue":"AE",
               "value":"United Arab Emirates ",
               "diff":null,
               "percent":null,
               "compare_value":null
            },
            "summary_totalVisits":{
               "rawValue":"1",
               "value":"1",
               "diff":null,
               "percent":null,
               "compare_value":null
            },
            "bots_total":{
               "rawValue":"0",
               "value":"0",
               "diff":null,
               "percent":null,
               "compare_value":null
            },
            "bots_totalPc":{
               "rawValue":0,
               "value":"0",
               "diff":null,
               "percent":null,
               "compare_value":null
            }
         },
         {
            "id":1,
            "time_day":{
               "rawValue":"10.04.2024",
               "value":"10.04.2024",
               "diff":null,
               "percent":null,
               "compare_value":null
            },
            "geo_country":{
               "rawValue":"AT",
               "value":"Austria",
               "diff":null,
               "percent":null,
               "compare_value":null
            },
            "summary_totalVisits":{
               "rawValue":"27",
               "value":"27",
               "diff":null,
               "percent":null,
               "compare_value":null
            },
            "bots_total":{
               "rawValue":"0",
               "value":"0",
               "diff":null,
               "percent":null,
               "compare_value":null
            },
            "bots_totalPc":{
               "rawValue":0,
               "value":"0",
               "diff":null,
               "percent":null,
               "compare_value":null
            }
         },
         {
            "id":2,
            "time_day":{
               "rawValue":"10.04.2024",
               "value":"10.04.2024",
               "diff":null,
               "percent":null,
               "compare_value":null
            },
            "geo_country":{
               "rawValue":"BA",
               "value":"Bosnia and Herzegovina",
               "diff":null,
               "percent":null,
               "compare_value":null
            },
            "summary_totalVisits":{
               "rawValue":"349",
               "value":"349",
               "diff":null,
               "percent":null,
               "compare_value":null
            },
            "bots_total":{
               "rawValue":"3",
               "value":"3",
               "diff":null,
               "percent":null,
               "compare_value":null
            },
            "bots_totalPc":{
               "rawValue":0.86,
               "value":"0.86",
               "diff":null,
               "percent":null,
               "compare_value":null
            }
         },
         {
            "id":3,
            "time_day":{
               "rawValue":"10.04.2024",
               "value":"10.04.2024",
               "diff":null,
               "percent":null,
               "compare_value":null
            },
            "geo_country":{
               "rawValue":"BD",
               "value":"Bangladesh",
               "diff":null,
               "percent":null,
               "compare_value":null
            },
            "summary_totalVisits":{
               "rawValue":"1",
               "value":"1",
               "diff":null,
               "percent":null,
               "compare_value":null
            },
            "bots_total":{
               "rawValue":"0",
               "value":"0",
               "diff":null,
               "percent":null,
               "compare_value":null
            },
            "bots_totalPc":{
               "rawValue":0,
               "value":"0",
               "diff":null,
               "percent":null,
               "compare_value":null
            }
         },
         {
            "id":4,
            "time_day":{
               "rawValue":"10.04.2024",
               "value":"10.04.2024",
               "diff":null,
               "percent":null,
               "compare_value":null
            },
            "geo_country":{
               "rawValue":"BG",
               "value":"Bulgaria",
               "diff":null,
               "percent":null,
               "compare_value":null
            },
            "summary_totalVisits":{
               "rawValue":"3",
               "value":"3",
               "diff":null,
               "percent":null,
               "compare_value":null
            },
            "bots_total":{
               "rawValue":"0",
               "value":"0",
               "diff":null,
               "percent":null,
               "compare_value":null
            },
            "bots_totalPc":{
               "rawValue":0,
               "value":"0",
               "diff":null,
               "percent":null,
               "compare_value":null
            }
         },
         {
            "id":5,
            "time_day":{
               "rawValue":"10.04.2024",
               "value":"10.04.2024",
               "diff":null,
               "percent":null,
               "compare_value":null
            },
            "geo_country":{
               "rawValue":"BR",
               "value":"Brazil",
               "diff":null,
               "percent":null,
               "compare_value":null
            },
            "summary_totalVisits":{
               "rawValue":"1",
               "value":"1",
               "diff":null,
               "percent":null,
               "compare_value":null
            },
            "bots_total":{
               "rawValue":"0",
               "value":"0",
               "diff":null,
               "percent":null,
               "compare_value":null
            },
            "bots_totalPc":{
               "rawValue":0,
               "value":"0",
               "diff":null,
               "percent":null,
               "compare_value":null
            }
         },
         {
            "id":6,
            "time_day":{
               "rawValue":"10.04.2024",
               "value":"10.04.2024",
               "diff":null,
               "percent":null,
               "compare_value":null
            },
            "geo_country":{
               "rawValue":"CA",
               "value":"Canada",
               "diff":null,
               "percent":null,
               "compare_value":null
            },
            "summary_totalVisits":{
               "rawValue":"1",
               "value":"1",
               "diff":null,
               "percent":null,
               "compare_value":null
            },
            "bots_total":{
               "rawValue":"0",
               "value":"0",
               "diff":null,
               "percent":null,
               "compare_value":null
            },
            "bots_totalPc":{
               "rawValue":0,
               "value":"0",
               "diff":null,
               "percent":null,
               "compare_value":null
            }
         },
         {
            "id":7,
            "time_day":{
               "rawValue":"10.04.2024",
               "value":"10.04.2024",
               "diff":null,
               "percent":null,
               "compare_value":null
            },
            "geo_country":{
               "rawValue":"CH",
               "value":"Switzerland",
               "diff":null,
               "percent":null,
               "compare_value":null
            },
            "summary_totalVisits":{
               "rawValue":"4",
               "value":"4",
               "diff":null,
               "percent":null,
               "compare_value":null
            },
            "bots_total":{
               "rawValue":"0",
               "value":"0",
               "diff":null,
               "percent":null,
               "compare_value":null
            },
            "bots_totalPc":{
               "rawValue":0,
               "value":"0",
               "diff":null,
               "percent":null,
               "compare_value":null
            }
         },
         {
            "id":8,
            "time_day":{
               "rawValue":"10.04.2024",
               "value":"10.04.2024",
               "diff":null,
               "percent":null,
               "compare_value":null
            },
            "geo_country":{
               "rawValue":"DE",
               "value":"Germany",
               "diff":null,
               "percent":null,
               "compare_value":null
            },
            "summary_totalVisits":{
               "rawValue":"110",
               "value":"110",
               "diff":null,
               "percent":null,
               "compare_value":null
            },
            "bots_total":{
               "rawValue":"0",
               "value":"0",
               "diff":null,
               "percent":null,
               "compare_value":null
            },
            "bots_totalPc":{
               "rawValue":0,
               "value":"0",
               "diff":null,
               "percent":null,
               "compare_value":null
            }
         },
         {
            "id":9,
            "time_day":{
               "rawValue":"10.04.2024",
               "value":"10.04.2024",
               "diff":null,
               "percent":null,
               "compare_value":null
            },
            "geo_country":{
               "rawValue":"HR",
               "value":"Croatia",
               "diff":null,
               "percent":null,
               "compare_value":null
            },
            "summary_totalVisits":{
               "rawValue":"274",
               "value":"274",
               "diff":null,
               "percent":null,
               "compare_value":null
            },
            "bots_total":{
               "rawValue":"4",
               "value":"4",
               "diff":null,
               "percent":null,
               "compare_value":null
            },
            "bots_totalPc":{
               "rawValue":1.46,
               "value":"1.46",
               "diff":null,
               "percent":null,
               "compare_value":null
            }
         },
         {
            "id":10,
            "time_day":{
               "rawValue":"10.04.2024",
               "value":"10.04.2024",
               "diff":null,
               "percent":null,
               "compare_value":null
            },
            "geo_country":{
               "rawValue":"HU",
               "value":"Hungary",
               "diff":null,
               "percent":null,
               "compare_value":null
            },
            "summary_totalVisits":{
               "rawValue":"1",
               "value":"1",
               "diff":null,
               "percent":null,
               "compare_value":null
            },
            "bots_total":{
               "rawValue":"0",
               "value":"0",
               "diff":null,
               "percent":null,
               "compare_value":null
            },
            "bots_totalPc":{
               "rawValue":0,
               "value":"0",
               "diff":null,
               "percent":null,
               "compare_value":null
            }
         },
         {
            "id":11,
            "time_day":{
               "rawValue":"10.04.2024",
               "value":"10.04.2024",
               "diff":null,
               "percent":null,
               "compare_value":null
            },
            "geo_country":{
               "rawValue":"IN",
               "value":"India",
               "diff":null,
               "percent":null,
               "compare_value":null
            },
            "summary_totalVisits":{
               "rawValue":"2",
               "value":"2",
               "diff":null,
               "percent":null,
               "compare_value":null
            },
            "bots_total":{
               "rawValue":"0",
               "value":"0",
               "diff":null,
               "percent":null,
               "compare_value":null
            },
            "bots_totalPc":{
               "rawValue":0,
               "value":"0",
               "diff":null,
               "percent":null,
               "compare_value":null
            }
         },
         {
            "id":12,
            "time_day":{
               "rawValue":"10.04.2024",
               "value":"10.04.2024",
               "diff":null,
               "percent":null,
               "compare_value":null
            },
            "geo_country":{
               "rawValue":"IR",
               "value":"Iran",
               "diff":null,
               "percent":null,
               "compare_value":null
            },
            "summary_totalVisits":{
               "rawValue":"1",
               "value":"1",
               "diff":null,
               "percent":null,
               "compare_value":null
            },
            "bots_total":{
               "rawValue":"0",
               "value":"0",
               "diff":null,
               "percent":null,
               "compare_value":null
            },
            "bots_totalPc":{
               "rawValue":0,
               "value":"0",
               "diff":null,
               "percent":null,
               "compare_value":null
            }
         },
         {
            "id":13,
            "time_day":{
               "rawValue":"10.04.2024",
               "value":"10.04.2024",
               "diff":null,
               "percent":null,
               "compare_value":null
            },
            "geo_country":{
               "rawValue":"IT",
               "value":"Italy",
               "diff":null,
               "percent":null,
               "compare_value":null
            },
            "summary_totalVisits":{
               "rawValue":"2",
               "value":"2",
               "diff":null,
               "percent":null,
               "compare_value":null
            },
            "bots_total":{
               "rawValue":"0",
               "value":"0",
               "diff":null,
               "percent":null,
               "compare_value":null
            },
            "bots_totalPc":{
               "rawValue":0,
               "value":"0",
               "diff":null,
               "percent":null,
               "compare_value":null
            }
         },
         {
            "id":14,
            "time_day":{
               "rawValue":"10.04.2024",
               "value":"10.04.2024",
               "diff":null,
               "percent":null,
               "compare_value":null
            },
            "geo_country":{
               "rawValue":"LB",
               "value":"Lebanon",
               "diff":null,
               "percent":null,
               "compare_value":null
            },
            "summary_totalVisits":{
               "rawValue":"2",
               "value":"2",
               "diff":null,
               "percent":null,
               "compare_value":null
            },
            "bots_total":{
               "rawValue":"0",
               "value":"0",
               "diff":null,
               "percent":null,
               "compare_value":null
            },
            "bots_totalPc":{
               "rawValue":0,
               "value":"0",
               "diff":null,
               "percent":null,
               "compare_value":null
            }
         },
         {
            "id":15,
            "time_day":{
               "rawValue":"10.04.2024",
               "value":"10.04.2024",
               "diff":null,
               "percent":null,
               "compare_value":null
            },
            "geo_country":{
               "rawValue":"LU",
               "value":"Luxembourg",
               "diff":null,
               "percent":null,
               "compare_value":null
            },
            "summary_totalVisits":{
               "rawValue":"1",
               "value":"1",
               "diff":null,
               "percent":null,
               "compare_value":null
            },
            "bots_total":{
               "rawValue":"0",
               "value":"0",
               "diff":null,
               "percent":null,
               "compare_value":null
            },
            "bots_totalPc":{
               "rawValue":0,
               "value":"0",
               "diff":null,
               "percent":null,
               "compare_value":null
            }
         },
         {
            "id":16,
            "time_day":{
               "rawValue":"10.04.2024",
               "value":"10.04.2024",
               "diff":null,
               "percent":null,
               "compare_value":null
            },
            "geo_country":{
               "rawValue":"MA",
               "value":"Morocco",
               "diff":null,
               "percent":null,
               "compare_value":null
            },
            "summary_totalVisits":{
               "rawValue":"1",
               "value":"1",
               "diff":null,
               "percent":null,
               "compare_value":null
            },
            "bots_total":{
               "rawValue":"0",
               "value":"0",
               "diff":null,
               "percent":null,
               "compare_value":null
            },
            "bots_totalPc":{
               "rawValue":0,
               "value":"0",
               "diff":null,
               "percent":null,
               "compare_value":null
            }
         },
         {
            "id":17,
            "time_day":{
               "rawValue":"10.04.2024",
               "value":"10.04.2024",
               "diff":null,
               "percent":null,
               "compare_value":null
            },
            "geo_country":{
               "rawValue":"ME",
               "value":"Montenegro",
               "diff":null,
               "percent":null,
               "compare_value":null
            },
            "summary_totalVisits":{
               "rawValue":"42",
               "value":"42",
               "diff":null,
               "percent":null,
               "compare_value":null
            },
            "bots_total":{
               "rawValue":"0",
               "value":"0",
               "diff":null,
               "percent":null,
               "compare_value":null
            },
            "bots_totalPc":{
               "rawValue":0,
               "value":"0",
               "diff":null,
               "percent":null,
               "compare_value":null
            }
         },
         {
            "id":18,
            "time_day":{
               "rawValue":"10.04.2024",
               "value":"10.04.2024",
               "diff":null,
               "percent":null,
               "compare_value":null
            },
            "geo_country":{
               "rawValue":"MK",
               "value":"Republic of North Macedonia",
               "diff":null,
               "percent":null,
               "compare_value":null
            },
            "summary_totalVisits":{
               "rawValue":"21",
               "value":"21",
               "diff":null,
               "percent":null,
               "compare_value":null
            },
            "bots_total":{
               "rawValue":"0",
               "value":"0",
               "diff":null,
               "percent":null,
               "compare_value":null
            },
            "bots_totalPc":{
               "rawValue":0,
               "value":"0",
               "diff":null,
               "percent":null,
               "compare_value":null
            }
         },
         {
            "id":19,
            "time_day":{
               "rawValue":"10.04.2024",
               "value":"10.04.2024",
               "diff":null,
               "percent":null,
               "compare_value":null
            },
            "geo_country":{
               "rawValue":"MT",
               "value":"Malta",
               "diff":null,
               "percent":null,
               "compare_value":null
            },
            "summary_totalVisits":{
               "rawValue":"1",
               "value":"1",
               "diff":null,
               "percent":null,
               "compare_value":null
            },
            "bots_total":{
               "rawValue":"0",
               "value":"0",
               "diff":null,
               "percent":null,
               "compare_value":null
            },
            "bots_totalPc":{
               "rawValue":0,
               "value":"0",
               "diff":null,
               "percent":null,
               "compare_value":null
            }
         },
         {
            "id":20,
            "time_day":{
               "rawValue":"10.04.2024",
               "value":"10.04.2024",
               "diff":null,
               "percent":null,
               "compare_value":null
            },
            "geo_country":{
               "rawValue":"NO",
               "value":"Norway",
               "diff":null,
               "percent":null,
               "compare_value":null
            },
            "summary_totalVisits":{
               "rawValue":"1",
               "value":"1",
               "diff":null,
               "percent":null,
               "compare_value":null
            },
            "bots_total":{
               "rawValue":"0",
               "value":"0",
               "diff":null,
               "percent":null,
               "compare_value":null
            },
            "bots_totalPc":{
               "rawValue":0,
               "value":"0",
               "diff":null,
               "percent":null,
               "compare_value":null
            }
         },
         {
            "id":21,
            "time_day":{
               "rawValue":"10.04.2024",
               "value":"10.04.2024",
               "diff":null,
               "percent":null,
               "compare_value":null
            },
            "geo_country":{
               "rawValue":"PL",
               "value":"Poland",
               "diff":null,
               "percent":null,
               "compare_value":null
            },
            "summary_totalVisits":{
               "rawValue":"8",
               "value":"8",
               "diff":null,
               "percent":null,
               "compare_value":null
            },
            "bots_total":{
               "rawValue":"0",
               "value":"0",
               "diff":null,
               "percent":null,
               "compare_value":null
            },
            "bots_totalPc":{
               "rawValue":0,
               "value":"0",
               "diff":null,
               "percent":null,
               "compare_value":null
            }
         },
         {
            "id":22,
            "time_day":{
               "rawValue":"10.04.2024",
               "value":"10.04.2024",
               "diff":null,
               "percent":null,
               "compare_value":null
            },
            "geo_country":{
               "rawValue":"QA",
               "value":"Qatar",
               "diff":null,
               "percent":null,
               "compare_value":null
            },
            "summary_totalVisits":{
               "rawValue":"2",
               "value":"2",
               "diff":null,
               "percent":null,
               "compare_value":null
            },
            "bots_total":{
               "rawValue":"0",
               "value":"0",
               "diff":null,
               "percent":null,
               "compare_value":null
            },
            "bots_totalPc":{
               "rawValue":0,
               "value":"0",
               "diff":null,
               "percent":null,
               "compare_value":null
            }
         },
         {
            "id":23,
            "time_day":{
               "rawValue":"10.04.2024",
               "value":"10.04.2024",
               "diff":null,
               "percent":null,
               "compare_value":null
            },
            "geo_country":{
               "rawValue":"RO",
               "value":"Romania",
               "diff":null,
               "percent":null,
               "compare_value":null
            },
            "summary_totalVisits":{
               "rawValue":"2",
               "value":"2",
               "diff":null,
               "percent":null,
               "compare_value":null
            },
            "bots_total":{
               "rawValue":"0",
               "value":"0",
               "diff":null,
               "percent":null,
               "compare_value":null
            },
            "bots_totalPc":{
               "rawValue":0,
               "value":"0",
               "diff":null,
               "percent":null,
               "compare_value":null
            }
         },
         {
            "id":24,
            "time_day":{
               "rawValue":"10.04.2024",
               "value":"10.04.2024",
               "diff":null,
               "percent":null,
               "compare_value":null
            },
            "geo_country":{
               "rawValue":"RS",
               "value":"Serbia",
               "diff":null,
               "percent":null,
               "compare_value":null
            },
            "summary_totalVisits":{
               "rawValue":"676",
               "value":"676",
               "diff":null,
               "percent":null,
               "compare_value":null
            },
            "bots_total":{
               "rawValue":"3",
               "value":"3",
               "diff":null,
               "percent":null,
               "compare_value":null
            },
            "bots_totalPc":{
               "rawValue":0.44,
               "value":"0.44",
               "diff":null,
               "percent":null,
               "compare_value":null
            }
         },
         {
            "id":25,
            "time_day":{
               "rawValue":"10.04.2024",
               "value":"10.04.2024",
               "diff":null,
               "percent":null,
               "compare_value":null
            },
            "geo_country":{
               "rawValue":"RU",
               "value":"Russian Federation ",
               "diff":null,
               "percent":null,
               "compare_value":null
            },
            "summary_totalVisits":{
               "rawValue":"3",
               "value":"3",
               "diff":null,
               "percent":null,
               "compare_value":null
            },
            "bots_total":{
               "rawValue":"0",
               "value":"0",
               "diff":null,
               "percent":null,
               "compare_value":null
            },
            "bots_totalPc":{
               "rawValue":0,
               "value":"0",
               "diff":null,
               "percent":null,
               "compare_value":null
            }
         },
         {
            "id":26,
            "time_day":{
               "rawValue":"10.04.2024",
               "value":"10.04.2024",
               "diff":null,
               "percent":null,
               "compare_value":null
            },
            "geo_country":{
               "rawValue":"SE",
               "value":"Sweden",
               "diff":null,
               "percent":null,
               "compare_value":null
            },
            "summary_totalVisits":{
               "rawValue":"1",
               "value":"1",
               "diff":null,
               "percent":null,
               "compare_value":null
            },
            "bots_total":{
               "rawValue":"0",
               "value":"0",
               "diff":null,
               "percent":null,
               "compare_value":null
            },
            "bots_totalPc":{
               "rawValue":0,
               "value":"0",
               "diff":null,
               "percent":null,
               "compare_value":null
            }
         },
         {
            "id":27,
            "time_day":{
               "rawValue":"10.04.2024",
               "value":"10.04.2024",
               "diff":null,
               "percent":null,
               "compare_value":null
            },
            "geo_country":{
               "rawValue":"SI",
               "value":"Slovenia",
               "diff":null,
               "percent":null,
               "compare_value":null
            },
            "summary_totalVisits":{
               "rawValue":"199",
               "value":"199",
               "diff":null,
               "percent":null,
               "compare_value":null
            },
            "bots_total":{
               "rawValue":"10",
               "value":"10",
               "diff":null,
               "percent":null,
               "compare_value":null
            },
            "bots_totalPc":{
               "rawValue":5.03,
               "value":"5.03",
               "diff":null,
               "percent":null,
               "compare_value":null
            }
         },
         {
            "id":28,
            "time_day":{
               "rawValue":"10.04.2024",
               "value":"10.04.2024",
               "diff":null,
               "percent":null,
               "compare_value":null
            },
            "geo_country":{
               "rawValue":"SK",
               "value":"Slovakia",
               "diff":null,
               "percent":null,
               "compare_value":null
            },
            "summary_totalVisits":{
               "rawValue":"1",
               "value":"1",
               "diff":null,
               "percent":null,
               "compare_value":null
            },
            "bots_total":{
               "rawValue":"0",
               "value":"0",
               "diff":null,
               "percent":null,
               "compare_value":null
            },
            "bots_totalPc":{
               "rawValue":0,
               "value":"0",
               "diff":null,
               "percent":null,
               "compare_value":null
            }
         },
         {
            "id":29,
            "time_day":{
               "rawValue":"10.04.2024",
               "value":"10.04.2024",
               "diff":null,
               "percent":null,
               "compare_value":null
            },
            "geo_country":{
               "rawValue":"SO",
               "value":"Somalia",
               "diff":null,
               "percent":null,
               "compare_value":null
            },
            "summary_totalVisits":{
               "rawValue":"1",
               "value":"1",
               "diff":null,
               "percent":null,
               "compare_value":null
            },
            "bots_total":{
               "rawValue":"0",
               "value":"0",
               "diff":null,
               "percent":null,
               "compare_value":null
            },
            "bots_totalPc":{
               "rawValue":0,
               "value":"0",
               "diff":null,
               "percent":null,
               "compare_value":null
            }
         },
         {
            "id":30,
            "time_day":{
               "rawValue":"10.04.2024",
               "value":"10.04.2024",
               "diff":null,
               "percent":null,
               "compare_value":null
            },
            "geo_country":{
               "rawValue":"TR",
               "value":"Turkey",
               "diff":null,
               "percent":null,
               "compare_value":null
            },
            "summary_totalVisits":{
               "rawValue":"1",
               "value":"1",
               "diff":null,
               "percent":null,
               "compare_value":null
            },
            "bots_total":{
               "rawValue":"0",
               "value":"0",
               "diff":null,
               "percent":null,
               "compare_value":null
            },
            "bots_totalPc":{
               "rawValue":0,
               "value":"0",
               "diff":null,
               "percent":null,
               "compare_value":null
            }
         },
         {
            "id":31,
            "time_day":{
               "rawValue":"10.04.2024",
               "value":"10.04.2024",
               "diff":null,
               "percent":null,
               "compare_value":null
            },
            "geo_country":{
               "rawValue":"US",
               "value":"United States of America ",
               "diff":null,
               "percent":null,
               "compare_value":null
            },
            "summary_totalVisits":{
               "rawValue":"20",
               "value":"20",
               "diff":null,
               "percent":null,
               "compare_value":null
            },
            "bots_total":{
               "rawValue":"18",
               "value":"18",
               "diff":null,
               "percent":null,
               "compare_value":null
            },
            "bots_totalPc":{
               "rawValue":90,
               "value":"90",
               "diff":null,
               "percent":null,
               "compare_value":null
            }
         },
         {
            "id":32,
            "time_day":{
               "rawValue":"10.04.2024",
               "value":"10.04.2024",
               "diff":null,
               "percent":null,
               "compare_value":null
            },
            "geo_country":{
               "rawValue":"XK",
               "value":"Kosovo",
               "diff":null,
               "percent":null,
               "compare_value":null
            },
            "summary_totalVisits":{
               "rawValue":"3",
               "value":"3",
               "diff":null,
               "percent":null,
               "compare_value":null
            },
            "bots_total":{
               "rawValue":"0",
               "value":"0",
               "diff":null,
               "percent":null,
               "compare_value":null
            },
            "bots_totalPc":{
               "rawValue":0,
               "value":"0",
               "diff":null,
               "percent":null,
               "compare_value":null
            }
         }
      ],
      "totalRows":33,
      "page":1,
      "perPage":50,
      "columns":[
         {
            "field":"time_day",
            "type":"string",
            "sortable":true,
            "unit":null,
            "tooltip":false
         },
         {
            "field":"geo_country",
            "type":"string",
            "sortable":true,
            "unit":null,
            "tooltip":false
         },
         {
            "field":"summary_totalVisits",
            "type":"number",
            "sortable":true,
            "unit":null,
            "tooltip":false
         },
         {
            "field":"bots_total",
            "type":"number",
            "sortable":true,
            "unit":null,
            "tooltip":true
         },
         {
            "field":"bots_totalPc",
            "type":"float",
            "sortable":true,
            "unit":"%",
            "tooltip":false
         }
      ],
      "total":{
         "id":33,
         "time_day":"fullResult",
         "geo_country":{
            "rawValue":null,
            "value":"",
            "diff":null,
            "percent":null,
            "compare_value":null
         },
         "summary_totalVisits":{
            "rawValue":null,
            "value":"1763",
            "diff":null,
            "percent":null,
            "compare_value":null
         },
         "bots_total":{
            "rawValue":null,
            "value":"38",
            "diff":null,
            "percent":null,
            "compare_value":null
         },
         "bots_totalPc":{
            "rawValue":null,
            "value":"2.16",
            "diff":null,
            "percent":null,
            "compare_value":null
         }
      }
   }
}

API

Key Type Description
success Boolean Was the request successful or it failed
code Number Response status code
msg [String] Error message
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
Description <row>
Key Type Description
value String Human readable value
rawValue String Raw value
diff String | null
percent Number | null Is the value a percentage or not?
compare_value String | null Comparison value if compare is on in request
Description <column>
Key Type Description
field String ID of the metric or group
type String | Number | Float
sortable Boolean Sortable or not
unit String | null Unit of measurement

For example, % for percentage columns

Request examples

CURL

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

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

curl -X POST 'https://kaminari.click/api/stat/data' -d '{"id":null,"name":null,"groups":["time_day"],"metrics":["summary_totalVisits"],"filters":{"filters":[],"period":null,"timezone":0,"dateTo":"2022-08-15","dateFrom":"2022-08-15"},"compare":null}' -H 'content-type: application/json' -H 'Authorization: Bearer <YOUR API_TOKEN>'

NodeJS

const https = require('https');

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

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

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

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

PHP

<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://kaminari.click/api/stat/get');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'OPTIONS');
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    'accept: */*',
]);

$response = curl_exec($ch);

curl_close($ch);

Python

import requests

headers = {
    'accept': '*/*',
}

response = requests.options('https://kaminari.click/api/stat/get', headers=headers)
response = requests.options('http://Authorization: Bearer <YOUR API_TOKEN>', headers=headers)
Retrieved from "https://wiki.kaminari.click/index.php?title=Stat_API&oldid=1492"