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 latest Core Module

Response body example (application/json)

{
      "code": "deviceInfo",
      "value": {
        "deviceBrand": "samsung",
        "deviceModel": "SM-A528B",
        "deviceOsVersion": "13",
        "deviceProduct": "a52sxqeea",
        "deviceScreenSize": "1080x2400",
        "deviceExternalStorageTotal": "61024",
        "deviceExternalStorageFree": "34686.875",
        "deviceMainStorageTotal": "108865.984375",
        "deviceMainStorageFree": "65761.796875",
        "deviceRamTotalSize": "5367.4609375",
        "deviceLocationEnabled": "false",
        "deviceWifiIsEnabled": "true",
        "deviceBluetoothOn": "false",
        "deviceDataRoaming": "true",
        "deviceAccessibilityEnabled": "false",
        "deviceBatteryIsCharging": "false",
        "deviceBatteryStatus": "0.76",
        "deviceCPUType": "arm64-v8a;armeabi-v7a;armeabi",
        "deviceIsLying": "false",
        "deviceIsAngled": "true",
        "deviceIsStanding": "false",
        "deviceIsFingerprintEnrolled": "1",
        "deviceNextAlarmClock": "2023-08-14 09:20:00",
        "devicePhoneType": "1",
        "deviceIsVirtual": "false",
        "deviceId": "fe533e40da103950ac649cf1a0090404",
        "deviceEmulatorName": null,
        "deviceIsRooted": "false",
        "deviceNetworkOperatorName": "KAKTUS",
        "deviceSimCountryIso": "cz",
        "deviceLanguageCode": "eng",
        "deviceRegionCode": "GBR",
        "deviceTimeZoneId": "Europe/Prague",
        "deviceLocaleDisplayLanguage": "English"
        "deviceNetworkConnectionType": "wifi"
      },
      "calculatedDate": "2023-08-14T07:29:46.315602Z"
    }

Velocity

Requires integration of latest Core Module

Response body example (application/json)

{
      "code": "velocity",
      "value": {
        "datasetsCountAllFromDeviceId": "18",
        "datasetsCountAllFromIp": "1",
        "datasetsCountAllFromDeviceIdAndIp": "1",
        "datasetsUniqueIpFromDeviceId": "7",
        "datasetsUniqueDeviceIdFromIp": "1"
      },
      "calculatedDate": "2023-08-14T07:29:46.3156019Z"
}

IP Info

Requires integration of latest 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": "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"
    }

Apps Info

Requires integration of Core Module v4.6.0+

🚧

As of Core Module v4.6.0, the Application Module is integrated into Core

For previous Core Module versions Application Module is required.

Response body example (application/json)

{
      "code": "appsInfo",
      "value": {
        "deviceAgeSinceFirstAppInstallByUser": "13498.3642958333",
        "appsTotalCount": "476",
        "appsSystemCount": "405",
        "appsUserCount": "71",
        "appsUserInstalledLast30DaysCount": "2",
        "appsUserInstalledLast3MonthsCount": "5",
        "appsUserInstalledLast6MonthsCount": "7",
        "appsUserInstalledLast12MonthsCount": "15",
        "appsInstalledLast30DaysCount": "2",
        "appsPaidCount": "1",
        "appsFreeCount": "96",
        "appsContentRating3+": "85",
        "appsContentRating7+": "1",
        "appsContentRating12+": "3",
        "appsContentRating16+": "7",
        "appsContentRating18+": "0",
        "appsArtsAndEntertainmentCount": "7",
        "appsGamesCount": "4",
        "appsSocialAndCommunicationsCount": "18",
        "appsToolAndUtilitiesCount": "19",
        "appsOthersCount": "10",
        "appsMissingCount": "379",
        "appsArtAndDesignCount": "0",
        "appsBooksAndReferenceCount": "1",
        "appsComicsCount": "0",
        "appsEntertainmentCount": "3",
        "appsPhotographyCount": "2",
        "appsVideoPlayersAndEditorsCount": "1",
        "appsEducationCount": "2",
        "appsGamesActionCount": "0",
        "appsGamesAdventureCount": "0",
        "appsGamesArcadeCount": "0",
        "appsGamesBoardCount": "3",
        "appsGamesCardCount": "0",
        "appsGamesCasinoCount": "0",
        "appsGamesCasualCount": "0",
        "appsGamesEducationalCount": "0",
        "appsGamesMusicCount": "0",
        "appsGamesPuzzleCount": "1",
        "appsGamesRacingCount": "0",
        "appsGamesRolePlayingCount": "0",
        "appsGamesSimulationCount": "0",
        "appsGamesStrategyCount": "0",
        "appsGamesTriviaCount": "0",
        "appsGamesWordCount": "0",
        "appsBeautyCount": "0",
        "appsDatingCount": "0",
        "appsFoodAndDrinkCount": "0",
        "appsHealthAndFitnessCount": "4",
        "appsLifestyleCount": "0",
        "appsMapsAndNavigationCount": "5",
        "appsMusicAndAudioCount": "1",
        "appsShoppingCount": "1",
        "appsTravelAndLocalCount": "7",
        "appsAutoVehiclesCount": "1",
        "appsBusinessCount": "8",
        "appsHouseAndHomeCount": "0",
        "appsLibrariesDemoCount": "0",
        "appsMedicalCount": "0",
        "appsNewsMagazinesCount": "1",
        "appsParentingCount": "0",
        "appsSportsCount": "0",
        "appsPersonalizationCount": "1",
        "appsFinanceCount": "11",
        "appsProductivityCount": "7",
        "appsCommunicationCount": "16",
        "appsSocialCount": "2",
        "appsEventsCount": "0",
        "appsToolsCount": "19",
        "appsWeatherCount": "0"
      },
      "calculatedDate": "2023-08-14T07:29:46.3156006Z"
    }

Last Installed Apps

Requires integration of Core Module v4.6.0+

🚧

As of Core Module v4.6.0, the Application Module is integrated into Core

For previous Core Module versions Application Module is required.

Response body example (application/json)

{
      "code": "lastApps",
      "value": [
        {
          "appPackageName": "com.transferwise.android",
          "appGooglePlayCategory": "finance",
          "appDateInstalled": "2023-07-31 20:08:14.496",
          "appDateLastUpdated": "2023-08-10 23:56:55.50",
          "appPaid": "false",
          "appContentRatings": "rated for 3+",
          "appDateInstalledRankDesc": "1"
        },
        {
          "appPackageName": "com.credolab.play",
          "appGooglePlayCategory": null,
          "appDateInstalled": "2023-07-21 14:44:22.63",
          "appDateLastUpdated": "2023-07-21 14:44:22.63",
          "appPaid": "false",
          "appContentRatings": null,
          "appDateInstalledRankDesc": "2"
        },
        {
          "appPackageName": "com.google.android.apps.walletnfcrel",
          "appGooglePlayCategory": "finance",
          "appDateInstalled": "2023-06-17 14:28:25.361",
          "appDateLastUpdated": "2023-08-02 19:04:12.907",
          "appPaid": "false",
          "appContentRatings": "rated for 3+",
          "appDateInstalledRankDesc": "3"
        },
        {
          "appPackageName": "com.google.ar.lens",
          "appGooglePlayCategory": "tools",
          "appDateInstalled": "2023-06-17 13:55:50.417",
          "appDateLastUpdated": "2023-07-02 00:41:40.796",
          "appPaid": "false",
          "appContentRatings": "rated for 3+",
          "appDateInstalledRankDesc": "4"
        },
        {
          "appPackageName": "com.credoapply",
          "appGooglePlayCategory": "finance",
          "appDateInstalled": "2023-06-15 15:41:57.598",
          "appDateLastUpdated": "2023-07-20 20:57:39.875",
          "appPaid": "false",
          "appContentRatings": "rated for 3+",
          "appDateInstalledRankDesc": "5"
        }
      ],
      "calculatedDate": "2023-08-14T07:29:46.3156003Z"
}

Risky Apps

Requires integration of Core Module v4.6.0+

🚧

As of Core Module v4.6.0, the Application Module is integrated into Core

For previous Core Module versions Application Module is required.

Response body example (application/json)

{
      "code": "risky_apps",
      "value": {
        "appClonerFlag": "0",
        "anonymousMessengerFlag": "1",
        "callCenterFlag": "0",
        "TorBrowserFlag": "0",
        "temporaryEmailFlag": "0",
        "vpnFlag": "1",
        "locationSpoofingFlag": "0",
        "appHider": "0",
        "virtualAndroid": "0"
        "deviceIdChanger": "0"
      },
      "calculatedDate": "2023-10-06T13:21:27.190941Z"
}

Permissions

Requires integration of Core Module v4.6.0+

🚧

As of Core Module v4.6.0, the Application Module is integrated into Core

For previous Core Module versions Application Module is required.

Response body example (application/json)

{
      "code": "permissions",
      "value": {
        "readContacts": "1",
        "readExternalStorage": null,
        "readMediaAudio": "1",
        "readMediaImages": "1",
        "readMediaVideo": "1",
        "readCalendar": "1",
        "getAccounts": "1",
        "accessWifiState": "1",
        "useFingerprint": "1",
        "accessNetworkState": "1",
        "readSms": "1"
      },
      "calculatedDate": "2023-08-14T07:29:46.3155998Z"
    }

📘

Permission Value Description

Value	Description
null	The corresponding SDK module is not integrated
-1	Permission is not included in the manifest
0	Permission is not granted
1	Permission is granted

Audio

Requires integration of Audio 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": "audio",
      "value": {
        "audioCount": "426",
        "audioMusicCount": "398"
      },
      "calculatedDate": "2023-08-14T07:29:46.3156014Z"
}

Calendar Events

Requires integration of Calendar 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": "2764",
        "calendarEventsTotalCount": "2988",
        "calendarEventsAsOrganizerCount": "1074",
        "calendarEventsStatusConfirmedCount": "2717",
        "calendarEventsDuringWeekdayCount": "2907",
        "calendarEventsMoreThan1AttendeeCount": "2373",
        "calendarEventsDifferentTimeZonesCount": "64",
        "calendarEventsLast30DaysCount": "80",
        "calendarEventsNext30DaysCount": "15",
        "calendarEventsLast30DaysRepetitiveCount": "30",
        "calendarEventsDuringWeekdayLast30DaysCount": "80"
      },
      "calculatedDate": "2023-08-14T07:29:46.315601Z"
    }

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": "174",
        "contactsWithoutNumberCount": "1",
        "contactsMultipleNumbersCount": "108",
        "contactsStaredCount": "1",
        "contactsWithPictureCount": "1",
        "contactsWithRingtoneCount": "0",
        "phoneNumberTotalCount": "295",
        "phoneNumberMobileCount": "281",
        "phoneNumberWorkCount": "3",
        "phoneNumberHomeCount": "9",
        "phoneNumberOtherCount": "2",
        "contactsWhatsAppCount": "148",
        "contactsTelegramCount": "0",
        "contactsMeetCount": "0",
        "contactsSkypeCount": "0",
        "contactsViberCount": "173",
        "contactsZoomCount": "0",
        "contactsLineCount": "1"
      },
      "calculatedDate": "2023-08-14T07:29:46.3156007Z"
    }

Images

Requires integration of Images 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": "7929",
        "imagesCountWithLocation": "0",
        "imageResolution": "4624x3468",
        "imagesLast30DaysCount": "156",
        "imagesLast360DaysCount": "1249",
        "imagesFirstMonth10Images": "2022-01",
        "imagesCameraCount": "1716",
        "imagesCameraLast30DaysCount": "80"
      },
      "calculatedDate": "2023-08-14T07:29:46.3156012Z"
    }

SMS

Requires integration of Sms 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": "sms",
      "value": {
        "smsInboxCount": "218",
        "smsInboxSeenCount": "217",
        "smsInboxReadCount": "216",
        "smsInboxKnownNumberCount": "33",
        "smsOutboxCount": "22",
        "smsOutboxDuringWeekdayCount": "14"
      },
      "calculatedDate": "2023-08-14T07:29:46.3156011Z"
    }

Video

Requires integration of Video 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": "153",
        "videoLast30DaysCount": "2",
        "videoCameraCount": "31",
        "videoCameraLast30DaysCount": "0"
      },
      "calculatedDate": "2023-08-14T07:29:46.3156016Z"
    }

Type Specification