Insights Overview

NameAPI CodeRequired Module
1DevicedeviceInfoCore Module
2VelocityvelocityCore Module
3IP InfoipInfoCore Module
4PermissionspermissionsCore Module
5Calendar EventscalendarCalendar Events Module
6Calendar RemindersremindersCalendar Reminders Module
7ContactscontactsContact Module
8ImagesimagesMedia Module
9VideovideoMedia 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

FieldData TypeDescriptionMin SDK
deviceIdstringUnique device identifier. Max length: 100Any
deviceBrandstringBrand or manufacturer of the device. Max length: 100Any
deviceModelstringModel of the device. Max length: 100Any
deviceOsVersionstringOperating System version of the device. Max length: 100Any
deviceScreenSizestringScreen size. Max length: 100Any
deviceMainStorageTotalfloatTotal main storage in MegabytesAny
deviceMainStorageFreefloatFree main storage in MegabytesAny
deviceRamTotalSizefloatTotal RAM sizeAny
deviceLocationEnabledbooleanIndicates if location is enabledAny
deviceAllowsVOIPbooleanIndicates is VOIP is allowedAny
deviceCurrencyCodestringCurrency code. Max length: 100Any
deviceNetworkOperatorNamestringName of the mobile network operator (only active SiM card is detected). Max length: 100Any
deviceNetworkConnectionTypestringActive network connection type. Max length: 1003.1.0+
deviceSimCountryIsostringISO country code of the SIM card. Max length: 100Any
deviceLanguageCodestringCode for the primary language. Max length: 100Any
deviceRegionCodestringCode for the region or country based on locale settings of the device. Max length: 100Any
deviceTimeZoneIdstringTime zone setting of the device. Max length: 100Any
deviceLocaleDisplayLanguagestringLanguage for displaying text and UI. Max length: 100Any
deviceBatteryIsChargingbooleanIndicates whether the battery is charging or not3.1.0+
deviceBatteryStatusfloatIndicates the current battery level in percentage (for ios only in case the battery monitoring is enabled)3.1.0+
deviceCPUTypestringThe name of CPU type. Max length: 1003.1.0+
deviceIsLyingbooleanThe approximate device position: is lying flat or not3.1.0+
deviceIsAngledbooleanThe approximate device position: is angled or not3.1.0+
deviceIsStandingbooleanThe approximate device position: is standing or not3.1.0+
deviceIsSimulatorbooleanIndicates whether the device is simulator or not2.2.0+
deviceIsJailBrokenbooleanIndicates whether the device is JailBroken or not2.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

FieldData TypeDescriptionMin SDK
datasetsCountAllFromDeviceIdintegerTotal number of datasets uploaded from the same deviceAny
datasetsCountAllFromDeviceIdAndIpintegerTotal number of datasets uploaded from the same device and IPAny
datasetsCountAllFromIpintegerTotal number of datasets uploaded from the same IPAny
datasetsUniqueIpFromDeviceIdintegerUnique IP adresses for given deviceAny
datasetsUniqueDeviceIdFromIpintegerUnique devices for given IP addressAny

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

FieldData TypeDescriptionMin SDK
ipstringUnique identifier assigned to a device on a network. Max length: 100Any
hostnamestringHost name of an IP address. Max length: 100Any
citystringUrban area where an IP address is located. Max length: 100Any
regionstringGeographical subdivision of a country where an IP address is situated. Max length: 100Any
countrystringCountry where an IP address is registered. Max length: 100Any
locstringGPS location of area where an IP address is registered. Max length: 100Any
postalstringPostal code associated with an IP address's location. Max length: 100Any
timezonestringStandard time of an IP address's geographical area. Max length: 100Any
privacyVpnbooleanConnection via VPN (IP address masking)Any
privacyProxybooleanConnection via proxy (IP address masking)Any
privacyTorbooleanConnection via tor (IP address masking)Any
privacyRelaybooleanConnection via privat relay (IP address masking)Any
privacyHostingbooleanConnection 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

FieldData TypeDescriptionMin SDK
NSAppleMusicUsageDescriptionintegerPermission that allows reading metadata related to music and music albumsAny
NSContactsUsageDescriptionintegerPermission that allows reading metadata related to Contacts and Contacts GroupAny
NSRemindersUsageDescriptionintegerPermission that allows reading metadata related to Calendar remindersAny
NSCalendarsUsageDescriptionintegerPermission that allows reading metadata related to Calendar eventsAny
NSPhotoLibraryUsageDescriptionintegerPermission that allows reading metadata related to images and videosAny

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

ValueDescription
nullThe corresponding SDK module is not integrated
0Permission is not granted
1Permission is granted

Calendar Events

Requires integration of Calendar Events Module

FieldData TypeDescriptionMin SDK
CalendarEventsPastCountintegerTotal number of past eventsAny
calendarEventsTotalCountintegerTotal number of calendar eventsAny
calendarEventsAsOrganizerCountintegerTotal number of organized calendar eventsAny
calendarEventsStatusConfirmedCountintegerTotal number of calendar events with confirmed statusAny
calendarEventsDuringWeekdayCountintegerTotal number of calendar events during the weekdayAny
calendarEventsMoreThan1AttendeeCountintegerTotal number of calendar events with more than 1 attendeeAny
calendarEventsDifferentTimeZonesCountintegerTotal number of calendar events in different time zoneAny
calendarEventsLast30DaysCountintegerTotal number of calendar events in the last 30 daysAny
calendarEventsNext30DaysCountintegerTotal number of events in the next 30 daysAny
calendarEventsLast30DaysRepetitiveCountintegerTotal number of repetitive calendar events in the last 30 daysAny
calendarEventsDuringWeekdayLast30DaysCountintegerTotal number of calendar events during the weekday in the last 30 daysAny

❗️

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

FieldData TypeDescriptionMin SDK
remindersTotalCountintegerTotal number of remindersAny
remindersDuringWeekdayCountintegerTotal number of reminders during the weekdaysAny
remindersMoreThan1AttendeeCountintegerTotal number of reminders with more than one attendeeAny
remindersDifferentTimeZonesCountintegerTotal number of reminders with different time zonesAny
remindersLast30DaysCountintegerTotal number of reminders in last 30 daysAny
remindersLast30DaysRepetitiveCountintegerTotal number of reminders for repetitive events in last 30 daysAny
remindersDuringWeekdayLast30DaysCountintegerTotal number of reminders during the weekday in last 30 daysAny

❗️

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

FieldData TypeDescriptionMin SDK
contactsTotalCountintegerTotal number of contactsAny
contactsWithoutNumberCountintegerTotal number of contacts without any phone numberAny
contactsMultipleNumbersCountintegerTotal number of contacts with multiple associated phone numbersAny
contactsWithPictureCountintegerTotal number of contacts with associated pictureAny
phoneNumberTotalCountintegerTotal number of phone numbersAny
contactsEmailCountintegerTotal number of contacts with email addressAny
contactsWorkCountintegerTotal number of contacts with company nameAny

❗️

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

FieldData TypeDescriptionMin SDK
imagesCountintegerTotal number of imagesAny
imagesCountWithLocationintegerTotal number of images with location propertyAny
imageResolutionstringMost frequent image resolution. Max length: 100Any
imagesLast30DaysCountintegerTotal number of images created in the last 30 daysAny
imagesLast360DaysCountintegerTotal number of images created in the last 360 daysAny
imagesFirstMonth10ImagesstringFirst month with more than 10 images. Max length: 100Any

❗️

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

FieldData TypeDescriptionMin SDK
videoCountintegerTotal number of video filesAny
videoLast30DaysCountintegerTotal number of video files created in the last 30 daysAny

❗️

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

TypeDescriptionExample
stringA string is a sequence of characters. It can include letters, numbers, symbols, and spaces."Europe/Kyiv"
booleanBoolean represents values true or falsetrue
floatFloat represents decimal numbers with fractional parts 3.142
integerInteger represents whole numbers without decimals42
datetimeDate and time values expressed in UTC and have the following format
yyyy-mm-ddThh:mm:ss.ffffffZ
2023-08-14T08:29:27.8536352Z