Insights Overview

№	Name	API Code	Required Module
1	Device	`deviceInfo`	Core Module
2	Velocity	`velocity`	Core Module
3	IP Info	`ipInfo`	Core Module
4	Permissions	`permissions`	Core Module
5	Calendar Events	`calendar`	Calendar Events Module
6	Calendar Reminders	`reminders`	Calendar Reminders Module
7	Contacts	`contacts`	Contact Module
8	Images	`images`	Media Module
9	Video	`video`	Media Module

📘
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

Device

Requires integration of Core Module

Field	Data Type	Description	Min SDK
`deviceId`	`string`	Unique device identifier. Max length: 100	`Any`
`deviceBrand`	`string`	Brand or manufacturer of the device. Max length: 100	`Any`
`deviceModel`	`string`	Model of the device. Max length: 100	`Any`
`deviceOsVersion`	`string`	Operating System version of the device. Max length: 100	`Any`
`deviceScreenSize`	`string`	Screen size. Max length: 100	`Any`
`deviceMainStorageTotal`	`float`	Total main storage in Megabytes	`Any`
`deviceMainStorageFree`	`float`	Free main storage in Megabytes	`Any`
`deviceRamTotalSize`	`float`	Total RAM size	`Any`
`deviceLocationEnabled`	`boolean`	Indicates if location is enabled	`Any`
`deviceAllowsVOIP`	`boolean`	Indicates is VOIP is allowed	`Any`
`deviceCurrencyCode`	`string`	Currency code. Max length: 100	`Any`
`deviceNetworkOperatorName`	`string`	Name of the mobile network operator (only active SiM card is detected). Max length: 100	`Any`
`deviceNetworkConnectionType`	`string`	Active network connection type. Max length: 100	`3.1.0+`
`deviceSimCountryIso`	`string`	ISO country code of the SIM card. Max length: 100	`Any`
`deviceLanguageCode`	`string`	Code for the primary language. Max length: 100	`Any`
`deviceRegionCode`	`string`	Code for the region or country based on locale settings of the device. Max length: 100	`Any`
`deviceTimeZoneId`	`string`	Time zone setting of the device. Max length: 100	`Any`
`deviceLocaleDisplayLanguage`	`string`	Language for displaying text and UI. Max length: 100	`Any`
`deviceBatteryIsCharging`	`boolean`	Indicates whether the battery is charging or not	`3.1.0+`
`deviceBatteryStatus`	`float`	Indicates the current battery level in percentage (for ios only in case the battery monitoring is enabled)	`3.1.0+`
`deviceCPUType`	`string`	The name of CPU type. Max length: 100	`3.1.0+`
`deviceIsLying`	`boolean`	The approximate device position: is lying flat or not	`3.1.0+`
`deviceIsAngled`	`boolean`	The approximate device position: is angled or not	`3.1.0+`
`deviceIsStanding`	`boolean`	The approximate device position: is standing or not	`3.1.0+`
`deviceIsSimulator`	`boolean`	Indicates whether the device is simulator or not	`2.2.0+`
`deviceIsJailBroken`	`boolean`	Indicates whether the device is JailBroken or not	`2.2.0+`

Response body example (application/json)

{
      "code": "deviceInfo",
      "value": {
        "deviceId": "B01634BF-C7E6-4BA1-9384-3D862E8DF050",
        "deviceIsSimulator": "false",
        "deviceIsJailBroken": "false",
        "deviceBrand": "iPhone",
        "deviceModel": "iPhone12,5",
        "deviceOsVersion": "16.5",
        "deviceScreenSize": "2688x1242",
        "deviceMainStorageTotal": "60907.11328125",
        "deviceMainStorageFree": "38180.22265625",
        "deviceRamTotalSize": "3750.15625",
        "deviceLocationEnabled": "true",
        "deviceAllowsVOIP": "true",
        "deviceCurrencyCode": "UAH",
        "deviceNetworkOperatorName": "--",
        "deviceSimCountryIso": "--",
        "deviceLanguageCode": "en",
        "deviceRegionCode": "UA",
        "deviceTimeZoneId": "Europe/Kiev",
        "deviceLocaleDisplayLanguage": "en_UA",
        "deviceBatteryIsCharging": "true",
        "deviceBatteryStatus": null,
        "deviceCPUType": "ARM_64",
        "deviceIsLying": "true",
        "deviceIsAngled": "false",
        "deviceIsStanding": "false"
      },
      "calculatedDate": "2023-08-14T08:29:27.853634Z"
    }

Velocity

Requires integration of Core Module

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

Response body example (application/json)

{
      "code": "velocity",
      "value": {
        "datasetsCountAllFromDeviceId": "1",
        "datasetsCountAllFromIp": "37",
        "datasetsCountAllFromDeviceIdAndIp": "1",
        "datasetsUniqueIpFromDeviceId": "1",
        "datasetsUniqueDeviceIdFromIp": "14"
      },
      "calculatedDate": "2023-08-14T08:29:27.8536355Z"
    }

IP Info

Requires integration of Core Module

📘
Note
If you're using a Proxy or Reverse Proxy configuration with the IP Info, ensure you submit the actual device IP address in your request

Field	Data Type	Description	Min SDK
`ip`	`string`	Unique identifier assigned to a device on a network. Max length: 100	`Any`
`hostname`	`string`	Host name of an IP address. Max length: 100	`Any`
`city`	`string`	Urban area where an IP address is located. Max length: 100	`Any`
`region`	`string`	Geographical subdivision of a country where an IP address is situated. Max length: 100	`Any`
`country`	`string`	Country where an IP address is registered. Max length: 100	`Any`
`loc`	`string`	GPS location of area where an IP address is registered. Max length: 100	`Any`
`postal`	`string`	Postal code associated with an IP address's location. Max length: 100	`Any`
`timezone`	`string`	Standard time of an IP address's geographical area. Max length: 100	`Any`
`privacyVpn`	`boolean`	Connection via VPN (IP address masking)	`Any`
`privacyProxy`	`boolean`	Connection via proxy (IP address masking)	`Any`
`privacyTor`	`boolean`	Connection via tor (IP address masking)	`Any`
`privacyRelay`	`boolean`	Connection via privat relay (IP address masking)	`Any`
`privacyHosting`	`boolean`	Connection via hosting provider (IP address masking)	`Any`

Response body example (application/json)

{
      "code": "ipInfo",
      "value": {
        "ip": "62.216.42.130",
        "hostname": null,
        "city": "Kyiv",
        "region": "Kyiv City",
        "country": "UA",
        "loc": "50.4547,30.5238",
        "postal": "03027",
        "timezone": "Europe/Kyiv",
        "privacyVpn": "true",
        "privacyProxy": "false",
        "privacyTor": "false",
        "privacyRelay": "false",
        "privacyHosting": "false"
      },
      "calculatedDate": "2023-08-14T08:29:27.8536353Z"
    }

Permissions

Requires integration of Core Module

Field	Data Type	Description	Min SDK
`NSAppleMusicUsageDescription`	`integer`	Permission that allows reading metadata related to music and music albums	`Any`
`NSContactsUsageDescription`	`integer`	Permission that allows reading metadata related to Contacts and Contacts Group	`Any`
`NSRemindersUsageDescription`	`integer`	Permission that allows reading metadata related to Calendar reminders	`Any`
`NSCalendarsUsageDescription`	`integer`	Permission that allows reading metadata related to Calendar events	`Any`
`NSPhotoLibraryUsageDescription`	`integer`	Permission that allows reading metadata related to images and videos	`Any`

Response body example (application/json)

{
      "code": "permissions",
      "value": {
        "NSAppleMusicUsageDescription": "1",
        "NSContactsUsageDescription": "1",
        "NSRemindersUsageDescription": "1",
        "NSCalendarsUsageDescription": "1",
        "NSPhotoLibraryUsageDescription": "1"
      },
      "calculatedDate": "2023-08-14T08:29:27.8536343Z"
    }

📘
Permission Value Description

Value	Description
`null`	The corresponding SDK module is not integrated
`0`	Permission is not granted
`1`	Permission is granted

Calendar Events

Requires integration of Calendar Events Module

Field	Data Type	Description	Min SDK
`CalendarEventsPastCount`	`integer`	Total number of past events	`Any`
`calendarEventsTotalCount`	`integer`	Total number of calendar events	`Any`
`calendarEventsAsOrganizerCount`	`integer`	Total number of organized calendar events	`Any`
`calendarEventsStatusConfirmedCount`	`integer`	Total number of calendar events with confirmed status	`Any`
`calendarEventsDuringWeekdayCount`	`integer`	Total number of calendar events during the weekday	`Any`
`calendarEventsMoreThan1AttendeeCount`	`integer`	Total number of calendar events with more than 1 attendee	`Any`
`calendarEventsDifferentTimeZonesCount`	`integer`	Total number of calendar events in different time zone	`Any`
`calendarEventsLast30DaysCount`	`integer`	Total number of calendar events in the last 30 days	`Any`
`calendarEventsNext30DaysCount`	`integer`	Total number of events in the next 30 days	`Any`
`calendarEventsLast30DaysRepetitiveCount`	`integer`	Total number of repetitive calendar events in the last 30 days	`Any`
`calendarEventsDuringWeekdayLast30DaysCount`	`integer`	Total number of calendar events during the weekday in the last 30 days	`Any`

❗️
The values in the API response will be null if the permission is not granted or there is no data available

Response body example (application/json)

{
      "code": "calendar",
      "value": {
        "calendarEventsPastCount": " 5993",
        "calendarEventsTotalCount": "6461",
        "calendarEventsAsOrganizerCount": "1",
        "calendarEventsStatusConfirmedCount": "3985",
        "calendarEventsDuringWeekdayCount": "6455",
        "calendarEventsMoreThan1AttendeeCount": "1",
        "calendarEventsDifferentTimeZonesCount": "1",
        "calendarEventsLast30DaysCount": "0",
        "calendarEventsNext30DaysCount": "418",
        "calendarEventsLast30DaysRepetitiveCount": "0",
        "calendarEventsDuringWeekdayLast30DaysCount": "0"
      },
      "calculatedDate": "2023-08-14T08:29:27.8536346Z"
    }

Calendar Reminders

Requires integration of Calendar Reminders Module

Field	Data Type	Description	Min SDK
`remindersTotalCount`	`integer`	Total number of reminders	`Any`
`remindersDuringWeekdayCount`	`integer`	Total number of reminders during the weekdays	`Any`
`remindersMoreThan1AttendeeCount`	`integer`	Total number of reminders with more than one attendee	`Any`
`remindersDifferentTimeZonesCount`	`integer`	Total number of reminders with different time zones	`Any`
`remindersLast30DaysCount`	`integer`	Total number of reminders in last 30 days	`Any`
`remindersLast30DaysRepetitiveCount`	`integer`	Total number of reminders for repetitive events in last 30 days	`Any`
`remindersDuringWeekdayLast30DaysCount`	`integer`	Total number of reminders during the weekday in last 30 days	`Any`

❗️
The values in the API response will be null if the permission is not granted or there is no data available

Response body example (application/json)

{
      "code": "reminders",
      "value": {
        "remindersTotalCount": "7",
        "remindersDuringWeekdayCount": "7",
        "remindersMoreThan1AttendeeCount": "0",
        "remindersDifferentTimeZonesCount": "0",
        "remindersLast30DaysCount": "7",
        "remindersLast30DaysRepetitiveCount": "0",
        "remindersDuringWeekdayLast30DaysCount": "7"
      },
      "calculatedDate": "2023-08-14T08:29:27.8536354Z"
    }

Contacts

Requires integration of Contact Module

Field	Data Type	Description	Min SDK
`contactsTotalCount`	`integer`	Total number of contacts	`Any`
`contactsWithoutNumberCount`	`integer`	Total number of contacts without any phone number	`Any`
`contactsMultipleNumbersCount`	`integer`	Total number of contacts with multiple associated phone numbers	`Any`
`contactsWithPictureCount`	`integer`	Total number of contacts with associated picture	`Any`
`phoneNumberTotalCount`	`integer`	Total number of phone numbers	`Any`
`contactsEmailCount`	`integer`	Total number of contacts with email address	`Any`
`contactsWorkCount`	`integer`	Total number of contacts with company name	`Any`

❗️
The values in the API response will be null if the permission is not granted or there is no data available

Response body example (application/json)

{
      "code": "contacts",
      "value": {
        "contactsTotalCount": "3",
        "contactsWithoutNumberCount": "1",
        "contactsMultipleNumbersCount": "1",
        "contactsWithPictureCount": "0",
        "phoneNumberTotalCount": "3",
        "contactsEmailCount": "2",
        "contactsWorkCount": "1"
      },
      "calculatedDate": "2023-08-14T08:29:27.8536345Z"
    }

Images

Requires integration of Media Module

Field	Data Type	Description	Min SDK
`imagesCount`	`integer`	Total number of images	`Any`
`imagesCountWithLocation`	`integer`	Total number of images with location property	`Any`
`imageResolution`	`string`	Most frequent image resolution. Max length: 100	`Any`
`imagesLast30DaysCount`	`integer`	Total number of images created in the last 30 days	`Any`
`imagesLast360DaysCount`	`integer`	Total number of images created in the last 360 days	`Any`
`imagesFirstMonth10Images`	`string`	First month with more than 10 images. Max length: 100	`Any`

❗️
The values in the API response will be null if the permission is not granted or there is no data available

Response body example (application/json)

{
      "code": "images",
      "value": {
        "imagesCount": "73",
        "imagesCountWithLocation": "6",
        "imageResolution": "3024x4032",
        "imagesLast30DaysCount": "0",
        "imagesLast360DaysCount": "72",
        "imagesFirstMonth10Images": "2021-03"
      },
      "calculatedDate": "2023-08-08T13:40:16.3508145Z"
    }

Video

Requires integration of Media Module

Field	Data Type	Description	Min SDK
`videoCount`	`integer`	Total number of video files	`Any`
`videoLast30DaysCount`	`integer`	Total number of video files created in the last 30 days	`Any`

❗️
The values in the API response will be null if the permission is not granted or there is no data available

Response body example (application/json)

{
      "code": "video",
      "value": {
        "videoCount": "4",
        "videoLast30DaysCount": null
      },
      "calculatedDate": "2023-08-14T08:29:27.8536352Z"
    }

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-14T08:29:27.8536352Z`

iOS

Insights Overview

📘
Accessing API Fields

📌
Note

Device

Velocity

IP Info

📘
Note

Permissions

📘
Permission Value Description

Calendar Events

❗️
The values in the API response will be `null` if the permission is not granted or there is no data available

Calendar Reminders

❗️
The values in the API response will be `null` if the permission is not granted or there is no data available

Contacts

❗️
The values in the API response will be `null` if the permission is not granted or there is no data available

Images

❗️
The values in the API response will be `null` if the permission is not granted or there is no data available

Video

❗️
The values in the API response will be `null` if the permission is not granted or there is no data available

Type Specification

Insights Overview

📘Accessing API Fields

📌Note

Device

Velocity

IP Info

📘Note

Permissions

📘Permission Value Description

Calendar Events

❗️The values in the API response will be null if the permission is not granted or there is no data available

Calendar Reminders

❗️The values in the API response will be null if the permission is not granted or there is no data available

Contacts

❗️The values in the API response will be null if the permission is not granted or there is no data available

Images

❗️The values in the API response will be null if the permission is not granted or there is no data available

Video

❗️The values in the API response will be null if the permission is not granted or there is no data available

Type Specification

📘
Accessing API Fields

📌
Note

📘
Note

📘
Permission Value Description

❗️
The values in the API response will be `null` if the permission is not granted or there is no data available

❗️
The values in the API response will be `null` if the permission is not granted or there is no data available

❗️
The values in the API response will be `null` if the permission is not granted or there is no data available

❗️
The values in the API response will be `null` if the permission is not granted or there is no data available

❗️
The values in the API response will be `null` if the permission is not granted or there is no data available