Android

Insights Overview

NameAPI CodeRequired Module
1DevicedeviceInfoCore Module
2VelocityvelocityCore Module
3IP InfoipInfoCore Module
4Apps InfoappsInfoCore Module v4.6.0+
5Fraud AlertsfraudAlertsCore Module v4.6.0+
6Last Installed AppslastAppsCore Module v4.6.0+
7Risky AppsriskyAppsCore Module v4.6.0+
8PermissionspermissionsCore Module v4.6.0+
9AudioaudioAudio Module
10Calendar EventscalendarCalendar Module
11ContactscontactsContacts Module
12ImagesimagesImages Module
13SMSsmsSMS Module
14VideovideoVideo 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 latest Core Module

FieldData TypeDescription
deviceIdstringUnique device identifier. Max length: 100
deviceBrandstringThe brand with which the product/hardware will be associated. Max length: 100
deviceModelstringProduct name visible to the end user. Max length: 100
deviceOsVersionstringVersion of the operating system (Android). Max length: 100
deviceProductstringThe name of the overall product. Max length: 100
deviceScreenSizestringScreen resolution of the device. Max length: 100
deviceExternalStorageTotalfloatTotal size of the device's external storage in Megabytes
deviceExternalStorageFreefloatAvailable space of the device's external storage
deviceMainStorageTotalfloatTotal size of the storage on the device (data directory)
deviceMainStorageFreefloatAvailable storage space on the device (data directory) in Megabytes
deviceRamTotalSizefloatTotal size of the RAM on the device
deviceLocationEnabledbooleanIndicates whether the device location is enabled or not
deviceWifiIsEnabledbooleanIndicates whether the WiFi is enabled or not
deviceBluetoothOnbooleanIndicates whether the bluetooth is enabled or not
deviceDataRoamingbooleanIndicates whether the data roaming is enabled or not
deviceAccessibilityEnabledbooleanIndicates whether the accessibility is enabled or not
deviceBatteryIsChargingbooleanIndicates whether the battery is charging or not
deviceBatteryStatusfloatIndicates the current battery level in percentage
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
deviceIsVirtualbooleanIndicates if the device is running in a virtual environment
deviceEmulatorNamestringName of the virtual device emulator. Max length: 100
deviceIsRootedbooleanIndicates if the device is rooted
deviceIsFingerprintEnrolledbooleanIndicates if there is at least one fingerprint enrolled
deviceNextAlarmClockdatetimeThe time at which the alarm is going to trigger (UTC)
devicePhoneTypestringThe phone type of the device: GSM, CDMA, etc. 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
deviceNetworkConnectionTypestringActive network connection type. Max length: 100
deviceHostAppIsClonedbooleanIndicates if a host application is cloned.
deviceUSBMassStorageEnabledbooleanIndicates if USB MassStorage is enabled.
deviceADBEnabledbooleanIndicates if Android Debug Bridge is enabled.
deviceDevelopmentSettingsEnabledbooleanIndicates if Developer Mode is enabled.

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",
      "deviceHostAppIsCloned":"false",
      "deviceUSBMassStorageEnabled":"false",
      "deviceADBEnabled":"false",
      "deviceDevelopmentSettingsEnabled":"false"
   },
   "calculatedDate":"2023-08-14T07:29:46.315602Z"
}

Velocity

Requires integration of latest Core Module

FieldData TypeDescription
datasetsCountAllFromDeviceIdintegerTotal number of datasets uploaded from the same device
datasetsCountAllFromIpintegerTotal number of datasets uploaded from the same IP
datasetsCountAllFromDeviceIdAndIpintegerTotal number of datasets uploaded from the same device and IP
datasetsUniqueIpFromDeviceIdintegerUnique IP addresses for given device
datasetsUniqueDeviceIdFromIpintegerUnique devices for given IP address

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

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 the IP address is registered. Max length: 100
postalstringPostal code associated with the IP address location. Max length: 100
timezonestringStandard time of the IP address 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":"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"
}

Fraud Alerts

FieldData TypeDescription
riskEmulatorstringIndicates if the device is running in a virtual environment
riskTorUsagestringIndicates if there is a risk of using TOR
riskVpnUsagestringIndicates if there is a risk of using VPN
riskHttpProxystringIndicates if there a risk of HTTP Proxy is configured
riskNewDevicestringIndicates if the device is new
riskAutomationstringIndicates if there is a risk of automation
riskDeviceFarmstringIndicates if there is a risk of device farm
riskEmptyDevicestringIndicates if the device is empty
riskRemoteAccessstringIndicates whether the device can be accessed remotely
riskRootedDevicestringIndicates if the device is rooted
riskCryptoEnthusiaststringIndicates if a device belongs to a crypto enthusiast
riskLocationSpoofingstringIndicates whether the location can be spoofed
riskTimeManipulationstringIndicates whether the time or timezone may have been manipulated
riskGeographyMismatchstringIndicates whether there is mismatch in geography
riskTemporaryEmailUsagestringIndicates if there is a risk of using temporary email apps
riskDeviceIdChangerUsagestringIndicates if there is a risk of cnanging device ID
riskHostApplicationClonedstringIndicates if a host application is cloned
riskApplicationClonerUsagestringIndicates if there is a risk of clonning applications
riskControlledFromComputerstringIndicates if there is a risk that a user manipulates the device from computer
riskAnonymousMessengerUsagestringIndicates if there is a risk of using anonymous messengers
riskApplicationManipulationstringIndicates if there is a risk of the host application manipulation
riskApplicationGamblingUsagestringIndicates if a device belongs to a gambler
riskNonMarketApplicationUsagestringIndicates if the host application installed not from official app markets
riskHostApplicationNotInstalledFromMarketstringIndicates if other applications could be installed not from official app markets
riskFinancialApplicationsInstallationSurgestringIndicates a surge in financial apps installation

Response body example (application/json)

{
  "code": "fraudAlerts",
  "value": {
    "riskEmulator": "low",
    "riskTorUsage": "low",
    "riskVpnUsage": "low",
    "riskHttpProxy": "low",
    "riskNewDevice": "low",
    "riskAutomation": "low",
    "riskDeviceFarm": "low",
    "riskEmptyDevice": "high",
    "riskRemoteAccess": "low",
    "riskRootedDevice": "low",
    "riskCryptoEnthusiast": "low",
    "riskLocationSpoofing": "low",
    "riskTimeManipulation": "low",
    "riskGeographyMismatch": "high",
    "riskTemporaryEmailUsage": "low",
    "riskDeviceIdChangerUsage": "low",
    "riskHostApplicationCloned": "low",
    "riskApplicationClonerUsage": "low",
    "riskControlledFromComputer": "high",
    "riskAnonymousMessengerUsage": "low",
    "riskApplicationManipulation": "high",
    "riskApplicationGamblingUsage": "low",
    "riskNonMarketApplicationUsage": "high",
    "riskHostApplicationNotInstalledFromMarket": "low",
    "riskFinancialApplicationsInstallationSurge": "low"
  },
  "calculatedDate": "2025-02-27T11:13:33.559676Z"
}

Apps Info

Requires integration of Core Module v4.6.0+

FieldData TypeDescription
deviceAgeSinceFirstAppInstallByUserfloatEstimated duration since installation of first user application
appsTotalCountintegerTotal number of installed applications
appsSystemCountintegerTotal number of system-preinstalled applications
appsUserCountintegerTotal number of applications installed by user himself
appsUserInstalledLast30DaysCountintegerTotal number of applications installed by user in the last 30 days
appsUserInstalledLast3MonthsCountintegerTotal number of applications installed by user in the last 3 months
appsUserInstalledLast6MonthsCountintegerTotal number of applications installed by user in the last 6 months
appsUserInstalledLast12MonthsCountintegerTotal number of applications installed by user in the last 12 months
appsInstalledLast30DaysCountintegerTotal number of applications installed in the last 30 days
appsPaidCountintegerTotal number of applications installed by user and marked as paid apps in Google Play
appsFreeCountintegerTotal number of applications installed by user and marked as free apps in Google Play
appsContentRating3+integerTotal number of applications with content rating 3+ according to the Google Play Market
appsContentRating7+integerTotal number of applications with content rating 7+ according to the Google Play Market
appsContentRating12+integerTotal number of applications with content rating 12+ according to the Google Play Market
appsContentRating16+integerTotal number of applications with content rating 16+ according to the Google Play Market
appsContentRating18+integerTotal number of applications with content rating 18+ according to the Google Play Market
appsArtsAndEntertainmentCountintegerNumber of applications with "Arts and Entertainment" category
appsGamesCountintegerNumber of applications with "Games" category
appsSocialAndCommunicationsCountintegerNumber of applications with "Social and Communications" category
appsToolAndUtilitiesCountintegerNumber of applications with "Tools and Utilities" category
appsOthersCountintegerNumber of applications with other rare categories
appsMissingCountintegerNumber of applications that weren't found in Google Play Market
appsArtAndDesignCountintegerNumber of applications with "ArtAndDesign" category
appsBooksAndReferenceCountintegerNumber of applications with "BooksAndReference" category
appsComicsCountintegerNumber of applications with "Comics" category
appsEntertainmentCountintegerNumber of applications with "Entertainment" category
appsPhotographyCountintegerNumber of applications with "Photography" category
appsVideoPlayersAndEditorsCountintegerNumber of applications with "VideoPlayersAndEditors" category
appsEducationCountintegerNumber of applications with "Education" category
appsGamesActionCountintegerNumber of applications with "GamesAction" category
appsGamesAdventureCountintegerNumber of applications with "GamesAdventure" category
appsGamesArcadeCountintegerNumber of applications with "GamesArcade" category
appsGamesBoardCountintegerNumber of applications with "GamesBoard" category
appsGamesCardCountintegerNumber of applications with "GamesCard" category
appsGamesCasinoCountintegerNumber of applications with "GamesCasino" category
appsGamesCasualCountintegerNumber of applications with "GamesCasual" category
appsGamesEducationalCountintegerNumber of applications with "GamesEducational" category
appsGamesMusicCountintegerNumber of applications with "GamesMusic" category
appsGamesPuzzleCountintegerNumber of applications with "GamesPuzzle" category
appsGamesRacingCountintegerNumber of applications with "GamesRacing" category
appsGamesRolePlayingCountintegerNumber of applications with "GamesRolePlaying" category
appsGamesSimulationCountintegerNumber of applications with "GamesSimulation" category
appsGamesStrategyCountintegerNumber of applications with "GamesStrategy" category
appsGamesTriviaCountintegerNumber of applications with "GamesTrivia" category
appsGamesWordCountintegerNumber of applications with "GamesWord" category
appsBeautyCountintegerNumber of applications with "Beauty" category
appsDatingCountintegerNumber of applications with "Dating" category
appsFoodAndDrinkCountintegerNumber of applications with "Food And Drink" category
appsHealthAndFitnessCountintegerNumber of applications with "HealthAndFitness" category
appsLifestyleCountintegerNumber of applications with "Lifestyle" category
appsMapsAndNavigationCountintegerNumber of applications with "MapsAndNavigation" category
appsMusicAndAudioCountintegerNumber of applications with "MusicAndAudio" category
appsShoppingCountintegerNumber of applications with "Shopping" category
appsTravelAndLocalCountintegerNumber of applications with "TravelAndLocal" category
appsAutoVehiclesCountintegerNumber of applications with "AutoVehicles" category
appsBusinessCountintegerNumber of applications with "Business" category
appsHouseAndHomeCountintegerNumber of applications with "HouseAndHome" category
appsLibrariesDemoCountintegerNumber of applications with "LibrariesDemo" category
appsMedicalCountintegerNumber of applications with "Medical" category
appsNewsMagazinesCountintegerNumber of applications with "NewsMagazines" category
appsParentingCountintegerNumber of applications with "Parenting" category
appsSportsCountintegerNumber of applications with "Sports" category
appsPersonalizationCountintegerNumber of applications with "Personalization" category
appsFinanceCountintegerNumber of applications with "Finance" category
appsProductivityCountintegerNumber of applications with "Productivity" category
appsCommunicationCountintegerNumber of applications with "Communication" category
appsSocialCountintegerNumber of applications with "Social" category
appsEventsCountintegerNumber of applications with "Events" category
appsToolsCountintegerNumber of applications with "Tools" category
appsWeatherCountintegerNumber of applications with "Weather" category

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+

FieldData TypeDescription
appPackageNamestringPackage name of the app (last 5 installed apps are displayed). Max length: 100
appGooglePlayCategorystringGooglePlay category of the application (last 5 installed apps are displayed). Max length: 100
appDateInstalleddatetimeDatetime when app was installed for the first time (last 5 installed apps are displayed)
appDateLastUpdateddatetimeDatetime when app was updated last time (last 5 installed apps are displayed)
appPaidbooleanIndicates if the application is paid or free (last 5 installed apps are displayed)
appContentRatingsstringApp's rating according to the Google Play Market (last 5 installed apps are displayed). Max length: 100
appDateInstalledRankDescintegerOrder of the app based installed date (1 = last installed app)

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+

FieldData TypeDescription
appClonerFlagbooleanPresence of App Cloner installation on the phone
anonymousMessengerFlagbooleanPresence of an anonymous messenger app on the phone
callCenterFlagbooleanPresence of a call center app on the phone
TorBrowserFlagbooleanPresence of Tor Browser installation on the phone
temporaryEmailFlag booleanPresence of a temporary email app on the phone
vpnFlagbooleanPresence of a VPN (Virtual Private Network) app on the phone
locationSpoofingFlagbooleanPresence of location spoofing functionality or app on the phone
appHiderFlagbooleanPresence of app hider app on the phone
virtualAndroidFlagbooleanPresence of virtual android app on the phone
deveiceIdChangerFlagbooleanPresence of device ID changing funcitonality or app on the phone
desktopMobileBridgeFlagbooleanPresence of app with controling phone from PC functionality

Response body example (application/json)

{
   "code":"risky_apps",
   "value":{
      "appClonerFlag":"0",
      "anonymousMessengerFlag":"1",
      "callCenterFlag":"0",
      "TorBrowserFlag":"0",
      "temporaryEmailFlag":"0",
      "vpnFlag":"1",
      "locationSpoofingFlag":"0",
      "appHiderFlag":"0",
      "virtualAndroidFlag":"0",
      "deviceIdChangerFlag":"0",
      "desktopMobileBridgeFlag":"0"
   },
   "calculatedDate":"2023-10-06T13:21:27.190941Z"
}

Permissions

FieldData TypeDescription
readContactsintegerPermission that allows reading metadata related to Contacts and Contacts Group
readExternalStorageintegerPermission that allows reading metadata related to the media files
readMediaAudiointegerPermission that allows reading metadata related to the audio files
readMediaImagesintegerPermission that allows reading metadata related to the image files
readMediaVideointegerPermission that allows reading metadata related to the video files
readCalendarintegerPermission that allows reading metadata related to the calendar information presented on the device. The metadata includes calendars such as Events, Attendees, Reminders.
getAccountsintegerPermission that allows reading metadata related to the user's accounts on the device. For example Gmail, Facebook, etc
accessWifiStateintegerPermission that allows reading metadata related to the wifi
useFingerprintintegerPermission that allows reading metadata related to the device's fingerprint
accessNetworkStateintegerPermission that allows reading metadata related to the network
readSmsintegerPermission that allows reading metadata related to SMS

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

ValueDescription
nullThe corresponding SDK module is not integrated
-1Permission is not included in the manifest
0Permission is not granted
1Permission is granted

Audio

Requires integration of Audio Module

FieldData TypeDescription
audioCountintegerTotal number of audio files
audioMusicCountintegerTotal number of "music" audio files

❗️

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

FieldData TypeDescription
calendarEventsPastCountintegerTotal number of past events
calendarEventsTotalCountintegerTotal number of events
calendarEventsAsOrganizerCountintegerTotal number of organized events
calendarEventsStatusConfirmedCountintegerTotal number of events with confirmed status
calendarEventsDuringWeekdayCountintegerTotal number of events during the weekdays
calendarEventsMoreThan1AttendeeCountintegerTotal number of events with more than 1 attendee
calendarEventsDifferentTimeZonesCountintegerTotal number of events in different time zone
calendarEventsLast30DaysCountintegerTotal number of events in the last 30 days
calendarEventsNext30DaysCountintegerTotal number of events in the next 30 days
calendarEventsLast30DaysRepetitiveCountintegerTotal number of repetitive events in the last 30 days
calendarEventsDuringWeekdayLast30DaysCountintegerTotal number of events during the weekdays 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":{
      "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

FieldData TypeDescription
contactsTotalCountintegerTotal number of contacts
contactsWithoutNumberCountintegerTotal number of contacts without any phone number
contactsMultipleNumbersCountintegerTotal number of contacts with multiple associated phone numbers
contactsStaredCountintegerTotal number of contacts marked as "Favourites"
contactsWithPictureCountintegerTotal number of contacts with associated picture
contactsWithRingtoneCountintegerTotal number of contacts with a special ringtone
phoneNumberTotalCountintegerTotal number of phone numbers
phoneNumberMobileCountintegerTotal number of phone numbers in category "Mobile"
phoneNumberWorkCountintegerTotal number of phone numbers in category "Work"
phoneNumberHomeCountintegerTotal number of phone numbers in category "Home"
phoneNumberOtherCountintegerTotal number of phone numbers in category "Other"
contactsWhatsAppCountintegerTotal number of contacts with linked WhatsApp
contactsTelegramCountintegerTotal number of contacts with linked Telegram
contactsMeetCountintegerTotal number of contacts with linked Meet
contactsSkypeCountintegerTotal number of contacts with linked Skype
contactsViberCountintegerTotal number of contacts with linked Viber
contactsZoomCountintegerTotal number of contacts with linked Zoom
contactsLineCountintegerTotal number of contacts with linked Line

❗️

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

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
imagesCameraCountintegerTotal number of images taken by camera
imagesCameraLast30DaysCountintegerTotal number of images taken by camera created 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":"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

FieldData TypeDescription
smsInboxCountintegerThe total number of SMS in Inbox
smsInboxSeenCountintegerThe total number of SMS in Inbox with status "Seen"
smsInboxReadCountintegerThe total number of SMS in Inbox with status "Read"
smsInboxKnownNumberCountintegerThe total number of SMS in Inbox from known number
smsOutboxCountintegerThe total number of SMS in Outbox
smsOutboxDuringWeekdayCountintegerThe total number of SMS in Outbox sent during weekdays

❗️

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

FieldData TypeDescription
videoCountintegerTotal number of video files
videoLast30DaysCountintegerTotal number of video files created in the last 30 days
videoCameraCountintegerTotal number of videos taken by camera
videoCameraLast30DaysCountintegerTotal number of videos taken by camera 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":"153",
      "videoLast30DaysCount":"2",
      "videoCameraCount":"31",
      "videoCameraLast30DaysCount":"0"
   },
   "calculatedDate":"2023-08-14T07:29:46.3156016Z"
}

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-14T07:29:46.3156016Z