Insights Overview

📘

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

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

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

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

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

❗️

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

❗️

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

❗️

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

❗️

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

❗️

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