Insights Overview

  1. Device
  2. Velocity
  3. IP Info
  4. Permissions
  5. Calendar Events
  6. Calendar Reminders
  7. Contacts
  8. Images
  9. Video

πŸ“˜

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 TypeDescription
deviceIdstringUnique device identifier. Max length: 100
deviceIsSimulatorbooleanIndicates whether the device is simulator or not
deviceIsJailBrokenbooleanIndicates whether the device is JailBroken or not
deviceBrandstringBrand or manufacturer of the device. Max length: 100
deviceModelstringModel of the device. Max length: 100
deviceOsVersionstringOperating System version of the device. Max length: 100
deviceScreenSizestringScreen size. Max length: 100
deviceMainStorageTotalfloatTotal main storage in Megabytes
deviceMainStorageFreefloatFree main storage in Megabytes
deviceRamTotalSizefloatTotal RAM size
deviceLocationEnabledbooleanIndicates if location is enabled
deviceAllowsVOIPbooleanIndicates is VOIP is allowed
deviceCurrencyCodestringCurrency code. Max length: 100
deviceNetworkOperatorNamestringName of the mobile network operator (only active SiM card is detected). Max length: 100
deviceSimCountryIsostringISO country code of the SIM card. Max length: 100
deviceLanguageCodestringCode for the primary language. Max length: 100
deviceRegionCodestringCode for the region or country setting. Max length: 100
deviceTimeZoneIdstringTime zone setting of the device. Max length: 100
deviceLocaleDisplayLanguagestringLanguage for displaying text and UI. Max length: 100
deviceBatteryIsChargingbooleanIndicates whether the battery is charging or not
deviceBatteryStatusfloatIndicates the current battery level in percentage (for ios only in case the battery monitoring is enabled)
deviceCPUTypestringThe name of CPU type. Max length: 100
deviceIsLyingbooleanThe approximate device position: is lying flat or not
deviceIsAngledbooleanThe approximate device position: is angled or not
deviceIsStandingbooleanThe approximate device position: is standing or not

Response body example (application/json)

{
      "code": "device",
      "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 TypeDescription
datasetsCountAllFromDeviceIdintegerTotal number of datasets uploaded from the same device
datasetsCountAllFromDeviceIdAndIpintegerTotal number of datasets uploaded from the same device and IP
datasetsCountAllFromIpintegerTotal number of datasets uploaded from the same IP
datasetsUniqueIpFromDeviceIdintegerUnique IP adresses for given device
datasetsUniqueDeviceIdFromIpintegerUnique devices for given IP address

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

Response body example (application/json)

{
      "code": "ip_info",
      "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 TypeDescription
NSAppleMusicUsageDescriptionintegerPermission that allows reading metadata related to music and music albums
NSContactsUsageDescriptionintegerPermission that allows reading metadata related to Contacts and Contacts Group
NSRemindersUsageDescriptionintegerPermission that allows reading metadata related to Calendar reminders
NSCalendarsUsageDescriptionintegerPermission that allows reading metadata related to Calendar events
NSPhotoLibraryUsageDescriptionintegerPermission that allows reading metadata related to images and videos

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 TypeDescription
calendarEventsTotalCountintegerTotal number of calendar events
calendarEventsAsOrganizerCountintegerTotal number of organized calendar events
calendarEventsStatusConfirmedCountintegerTotal number of calendar events with confirmed status
calendarEventsDuringWeekdayCountintegerTotal number of calendar events during the weekday
calendarEventsMoreThan1AttendeeCountintegerTotal number of calendar events with more than 1 attendee
calendarEventsDifferentTimeZonesCountintegerTotal number of calendar events in different time zone
calendarEventsLast30DaysCountintegerTotal number of calendar events in the last 30 days
calendarEventsLast30DaysRepetitiveCountintegerTotal number of repetitive calendar events in the last 30 days
calendarEventsDuringWeekdayLast30DaysCountintegerTotal number of calendar events during the weekday in the last 30 days

❗️

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": {
        "calendarEventsTotalCount": "6461",
        "calendarEventsAsOrganizerCount": "1",
        "calendarEventsStatusConfirmedCount": "3985",
        "calendarEventsDuringWeekdayCount": "6455",
        "calendarEventsMoreThan1AttendeeCount": "1",
        "calendarEventsDifferentTimeZonesCount": "1",
        "calendarEventsLast30DaysCount": "0",
        "calendarEventsLast30DaysRepetitiveCount": "0",
        "calendarEventsDuringWeekdayLast30DaysCount": "0"
      },
      "calculatedDate": "2023-08-14T08:29:27.8536346Z"
    }

Calendar Reminders

Requires integration of Calendar Reminders Module

FieldData TypeDescription
remindersTotalCountintegerTotal number of reminders
remindersDuringWeekdayCountintegerTotal number of reminders during the weekdays
remindersMoreThan1AttendeeCountintegerTotal number of reminders with more than one attendee
remindersDifferentTimeZonesCountintegerTotal number of reminders with different time zones
remindersLast30DaysCountintegerTotal number of reminders in last 30 days
remindersLast30DaysRepetitiveCountintegerTotal number of reminders for repetitive events in last 30 days
remindersDuringWeekdayLast30DaysCountintegerTotal number of reminders during the weekday in last 30 days

❗️

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 TypeDescription
contactsTotalCountintegerTotal number of contacts
contactsWithoutNumberCountintegerTotal number of contacts without any phone number
contactsMultipleNumbersCountintegerTotal number of contacts with multiple associated phone numbers
contactsWithPictureCountintegerTotal number of contacts with associated picture
phoneNumberTotalCountintegerTotal number of phone numbers
contactsEmailCountintegerTotal number of contacts with email address
contactsWorkCountintegerTotal number of contacts with company name

❗️

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 TypeDescription
imagesCountintegerTotal number of images
imagesCountWithLocationintegerTotal number of images with location property
imageResolutionstringMost frequent image resolution. Max length: 100
imagesLast30DaysCountintegerTotal number of images created in the last 30 days
imagesLast360DaysCountintegerTotal number of images created in the last 360 days
imagesFirstMonth10ImagesstringFirst month with more than 10 images. Max length: 100

❗️

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 TypeDescription
videoCountintegerTotal number of video files
videoLast30DaysCountintegerTotal number of video files created in the last 30 days

❗️

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-DD HH:MM:SS.SSS
2023-07-21 14:44:22.63