Web

Insights Overview

№	Name	API Code
1	Browser	`browser`
2	Velocity	`velocity`
3	IP Info	`ipInfo`
4	Anomaly	`anomaly`
5	Mouse/Finger gestures	`mouse`
6	Typing	`typing`
7	UI interactions	`uiInteractions`

📘
Accessing API Fields
Discover how to retrieve the API fields listed below through the Dataset Insights API.

📌
Note
Our API typically returns non-null values as string. For type spec on each field, see the Data Type column in the tables below.
For detailed type specifications, check out the Type Specification

Browser

Field	Data Type	Description
`browserId`	`string`	Hashed browser Id (all info is displayed for the browser from where the biggest traffic is comming). Max length: 100
`browserName`	`string`	Name of the web browser being used. Max length: 100
`deviceBrand`	`string`	Brand or manufacturer of the device being used. Max length: 100
`browserLanguage`	`string`	Language set in the web browser. Max length: 100
`browserTimezoneName`	`string`	Timezone set in the web browser. Max length: 100
`deviceOperatingSystem`	`string`	Operating system of the device being used. Max length: 100
`browserIsAdblockEnabled`	`boolean`	A flag indicating whether adblock is enabled in the browser
`deviceScreenOrientation`	`float`	Orientation of the device screen. 0 = normal view, 90/270 = if user on on phone and rotate screen
`browserUniqueDeviceIdCount`	`integer`	Qty of the unique devices (Only if continuous upload is used)
`browserIsIncognitoModeDetected`	`boolean`	A flag indicating whether incognito mode is detected in the browser

Response body example (application/json)

{
      "code": "browser",
      "value": {
        "browserId": "7a633960-a4f5-378e-23a0-cc2392ae5a6c",
        "browserName": "Chrome",
        "deviceBrand": "Apple",
        "browserLanguage": "en-GB",
        "browserTimezoneName": "Asia/Singapore",
        "deviceOperatingSystem": "Mac OS X",
        "browserIsAdblockEnabled": null,
        "deviceScreenOrientation": "0",
        "browserUniqueDeviceIdCount": "3",
        "browserIsIncognitoModeDetected": null
      },
      "calculatedDate": "2023-08-14T19:39:52.571311Z"
    }

Velocity

Field	Data Type	Description
`datasetsCountAllFromDeviceId`	`integer`	Total number of datasets uploaded from the same device
`datasetsCountAllFromIp`	`integer`	Total number of datasets uploaded from the same IP
`datasetsCountAllFromDeviceIdAndIp`	`integer`	Total number of datasets uploaded from the same device and IP
`datasetsUniqueIpFromDeviceId`	`integer`	Unique IP adresses for given device
`datasetsUniqueDeviceIdFromIp`	`integer`	Unique devices for given IP address

Response body example (application/json)

{
      "code": "velocity",
      "value": {
        "datasetsCountAllFromDeviceId": "3",
        "datasetsCountAllFromIp": "0",
        "datasetsCountAllFromDeviceIdAndIp": "0",
        "datasetsUniqueIpFromDeviceId": "0",
        "datasetsUniqueDeviceIdFromIp": "0"
      },
      "calculatedDate": "2023-08-14T19:40:32.7147789Z"
    }

IP Info

Field	Data Type	Description
`ip`	`string`	Unique identifier assigned to a device on a network. Max length: 100
`hostname`	`string`	Host name of an IP address. Max length: 100
`city`	`string`	Urban area where an IP address is located. Max length: 100
`region`	`string`	Geographical subdivision of a country where an IP address is situated. Max length: 100
`country`	`string`	Country where an IP address is registered. Max length: 100
`loc`	`string`	GPS location of area where an IP address is registered. Max length: 100
`postal`	`string`	Postal code associated with an IP address's location. Max length: 100
`timezone`	`string`	Standard timezone of an IP address's geographical area. Max length: 100
`privacyVpn`	`boolean`	Secure network connection that masks and encrypts the IP address
`privacyProxy`	`boolean`	Intermediate server that acts as a mediator between a device and the internet
`privacyTor`	`boolean`	Anonymizing network that conceals the IP address by routing internet traffic through multiple relays
`privacyRelay`	`boolean`	Intermediate node in the Tor network that helps anonymize and forward internet traffic
`privacyHosting`	`boolean`	Connection via hosting provider (IP address masking)

Response body example (application/json)

{
      "code": "ipInfo",
      "value": {
        "ip": "178.72.203.93",
        "hostname": "host-178-72-203-93.ip.nej.cz",
        "city": "Prague",
        "region": "Prague",
        "country": "CZ",
        "loc": "50.0880,14.4208",
        "postal": "110 00",
        "timezone": "Europe/Prague",
        "privacyVpn": "false",
        "privacyProxy": "false",
        "privacyTor": "false",
        "privacyRelay": "false",
        "privacyHosting": "false"
      },
      "calculatedDate": "2023-08-14T07:29:46.3156018Z"
    }

Anomaly

Field	Data Type	Description
`clickRageActionsCount`	`integer`	Count of times when user clicked more than 5 times per second
`mouseRageActionsCount`	`integer`	Count of times when user moved mouse faster than 200 pixels per second
`touchRageActionsCount`	`integer`	Count of times when user made touch more than 4 times per second
`keyboardRageActionsCount`	`integer`	Count of times when user pressed more than 4 keys per second

Response body example (application/json)

{
      "code": "anomaly",
      "value": {
        "clickRageActionsCount": "0",
        "mouseRageActionsCount": "0",
        "touchRageActionsCount": null,
        "keyboardRageActionsCount": null
      },
      "calculatedDate": "2023-08-14T19:39:52.571311Z"
    }

Mouse/Finger gestures

Field	Data Type	Description
`mouseMovingSpeed`	`float`	Mouse pointer speed; distance in pixels over total time (= pixels per second)
`clickTotalEventsCount`	`integer`	Total count of click events
`mouseMovingPathLength`	`float`	Mouse pointer distance; measured in pixels
`touchTotalEventsCount`	`integer`	Total count of touch events
`scrollTotalEventsCount`	`integer`	Total count of scroll events

Response body example (application/json)

{
      "code": "mouse",
      "value": {
        "mouseMovingSpeed": "413.311562094911",
        "clickTotalEventsCount": "39",
        "mouseMovingPathLength": "3065.94516052509",
        "touchTotalEventsCount": null,
        "scrollTotalEventsCount": "0"
      },
      "calculatedDate": "2023-08-14T19:39:52.571312Z"
    }

Typing

Field	Data Type	Description
`inputFromBeginningCount`	`integer`	Count of times when user start input from the first position of the field for the first interaction
`inputFromInsideCount`	`integer`	Count of times when user input some value inside of the field (on the position > 1 and < string length) for the first interaction
`inputFromEndCount`	`integer`	Count of times when user input some values at the end of the string for the first interaction
`touchPropForceAvg`	`float`	Average force, Force is scaled to [0: 1], 0 - in case if not supported by the device
`touchPropForceMin`	`float`	Min force
`touchPropForceMax`	`float`	Max force
`keyboardTotalKeysPressedCount`	`integer`	Total count of keys pressed on the keyboard
`keyboardIsTrustedKeyCount`	`integer`	Count of trusted inputs during the application process. Trusted input = generated by end users.
`keyboardLetterKeysPressedCount`	`integer`	Count of letter keys pressed on the keyboard
`keyboardNumberKeysPressedCount`	`integer`	Count of number keys pressed on the keyboard
`keyboardSymbolKeyPressedCount`	`integer`	Count of times the symbol key was pressed on the keyboard
`keyboardSpecialKeyPressedCount`	`integer`	Count of times the special key was pressed on the keyboard
`keyboardTabKeyPressedCount`	`integer`	Count of times the tab key was pressed on the keyboard
`keyboardMetaKeyPressedCount`	`integer`	Count of times the meta key was pressed on the keyboard
`keyboardSpaceKeyPressedCount`	`integer`	Count of times the space key was pressed on the keyboard
`keyboardCutKeysPressedCount`	`integer`	Count of times the "Ctrl + X" keys were pressed, i.e. cut actions via keyboard
`keyboardCopyKeysPressedCount`	`integer`	Count of times the "Ctrl + C" keys were pressed, i.e. copy actions via keyboard
`keyboardPasteKeysPressedCount`	`integer`	Count of times the "Ctrl + V" keys were pressed, i.e. paste actions via keyboard
`keyboardAltKeyPressedCount`	`integer`	Count of times the Alt key was pressed on the keyboard
`keyboardCtrtKeyPressedCount`	`integer`	Count of times the Ctrl key was pressed on the keyboard
`keyboardShiftKeyPressedCount`	`integer`	Count of times the Shift key was pressed on the keyboard
`keyboardTextShiftKeyPressedCount`	`integer`	Count of times the "Shift" key was pressed with text input (capital letters or special symbols typing)
`keyboardDeleteKeyPressedCount`	`integer`	Count of times the Delete key was pressed on the keyboard
`keyboardBackspaceKeyPressedCount`	`integer`	Count of times the Backspace key was pressed on the keyboard
`keyboardShiftDeleteActionsCount`	`integer`	Count of times the "Shift + Delete" keys were pressed, i.e. permanent delete actions via keyboard
`keyboardCtrlAltDeleteActionsCount`	`integer`	Count of times the "Ctrl + Alt + Delete" keys were pressed ("Security Keys")
`keyboardTypingSpeed`	`float`	Only keyboard events are taken into the account, symbols per second
`inputIsNotNumberCount`	`integer`	Qty of values in the input with type different from number (letters, symbols, etc.)
`inputIsNotLettersCount`	`integer`	Qty of values in the input with type different from letters (numbers, symbols, etc.)
`inputStartWithSpecCharCount`	`integer`	Count of times when user started typing field with a special character during the first interaction
`inputStartWithNumberCount`	`integer`	Count of times when user started typing field with a number during the first interaction
`inputStartWithLowerCount`	`integer`	Count of times when user started typing field with a lower letters during the first interaction
`inputStartWithUpperCount`	`integer`	Count of times when user started typing field with a upper letters during the first interaction
`inputStartWithNotUpperCount`	`integer`	Count of times when user started typing field without upper letter during the first interaction

Response body example (application/json)

{
      "code": "typing",
      "value": {
        "inputFromBeginningCount": "0",
        "inputFromInsideCount": "0",
        "inputFromEndCount": "0",
        "touchPropForceAvg": null,
        "touchPropForceMin": null,
        "touchPropForceMax": null,
        "keyboardTotalKeysPressedCount": "13",
        "keyboardIsTrustedKeyCount": "13",
        "keyboardLetterKeysPressedCount": "10",
        "keyboardNumberKeysPressedCount": "3",
        "keyboardSymbolKeyPressedCount": "13",
        "keyboardSpecialKeyPressedCount": "0",
        "keyboardTabKeyPressedCount": "0",
        "keyboardMetaKeyPressedCount": "0",
        "keyboardSpaceKeyPressedCount": "0",
        "keyboardCutKeysPressedCount": "0",
        "keyboardCopyKeysPressedCount": "0",
        "keyboardPasteKeysPressedCount": "0",
        "keyboardAltKeyPressedCount": "0",
        "keyboardCtrtKeyPressedCount": "0",
        "keyboardShiftKeyPressedCount": "0",
        "keyboardTextShiftKeyPressedCount": "0",
        "keyboardDeleteKeyPressedCount": "0",
        "keyboardBackspaceKeyPressedCount": "0",
        "keyboardShiftDeleteActionsCount": "0",
        "keyboardCtrlAltDeleteActionsCount": "0",
        "keyboardTypingSpeed": "7.29108247651517",
        "inputIsNotNumberCount": "0",
        "inputIsNotLettersCount": "3",
        "inputStartWithSpecCharCount": "0",
        "inputStartWithNumberCount": "0",
        "inputStartWithLowerCount": "1",
        "inputStartWithUpperCount": "0",
        "inputStartWithNotUpperCount": "1"
      },
      "calculatedDate": "2023-08-16T12:32:28.0777427Z"
    }

UI interactions

Field	Data Type	Description
`inputCutActionsCount`	`integer`	Qty of all cut actions. Both keyboard and mouse actions counted
`inputCopyActionsCount`	`integer`	Qty of all copy actions. Both keyboard and mouse actions counted
`inputPasteActionsCount`	`integer`	Qty of all paste actions. Both keyboard and mouse actions counted
`inputInsertActionsCount`	`integer`	Qty of all insert actions. Both keyboard and mouse actions counted
`inputInsertFromPasteActionsCount`	`integer`	Qty of all insert from paste actions. Both keyboard and mouse actions counted
`inputDeleteActionsCount`	`integer`	Qty of all delete actions. Both keyboard and mouse actions counted
`inputInsertTextActionsCount`	`integer`	Qty of insert text actions. Both keyboard and mouse actions counted
`inputInsertFromPasteTextActionsCount`	`integer`	Qty of insert from paste text actions. Both keyboard and mouse actions counted
`inputDeleteTextActionsCount`	`integer`	Qty of delete text actions. Both keyboard and mouse actions counted

Response body example (application/json)

{
      "code": "uiInteractions",
      "value": {
        "appFormFillingTimeSpentEffective": "7.70700001716614",
        "appFormFillingTimeSpentTotal": "7.70700001716614",
        "appFormFillingTrackedEventsCount": "15",
        "appFormFillingTrackedEventsPerSec": "10.5453166555046",
        "inputCutActionsCount": "0",
        "inputCopyActionsCount": "0",
        "inputPasteActionsCount": "0",
        "inputInsertActionsCount": null,
        "inputInsertFromPasteActionsCount": null,
        "inputDeleteActionsCount": null,
        "inputInsertTextActionsCount": null,
        "inputInsertFromPasteTextActionsCount": null,
        "inputDeleteTextActionsCount": null
      },
      "calculatedDate": "2023-08-16T12:25:25.9577002Z"
    }

Type Specification

Type	Description	Example
`string`	A string is a sequence of characters. It can include letters, numbers, symbols, and spaces.	`"Europe/Kyiv"`
`boolean`	Boolean represents values `true` or `false`	`true`
`float`	Float represents decimal numbers with fractional parts	`3.142`
`integer`	Integer represents whole numbers without decimals	`42`
`datetime`	Date and time values expressed in UTC and have the following format `yyyy-mm-ddThh:mm:ss.ffffffZ`	`2023-08-16T12:25:25.9577002Z`

Updated 2 months ago