LogoLogo
ProductsUse casesDocsSupport
  • Introducing DriveKit
  • DriveKit Guides
  • Get started with drivekit
    • Trip recording lifecycle
    • iOS
      • ๐Ÿš€Quick start
      • Advanced configurations
      • References
      • iOS DriveKit Demo App
    • Android
      • ๐Ÿš€Quick start
      • Advanced configurations
      • References
      • Android DriveKit Demo App
      • Android 15 Migration guide
      • Android 14 Migration guide
      • Troubleshooting
  • Trip analysis
    • Introduction
    • iOS
      • Permissions
      • Trip management
      • TripListener
      • Crash Detection
      • Beacon usage
      • Bluetooth usage
      • Custom metadata
      • References (iOS)
    • Android
      • Runtime permissions
      • Trip management
      • TripListener
      • Crash Detection
      • Beacon usage
      • Bluetooth usage
      • Custom metadata
      • References (Android)
    • User interface
      • iOS
        • Get started
        • Working hours
        • Driver alert in case of crash
        • Trip recording widget
        • Location sharing
      • Android
        • Get started
        • Working hours
        • Driver alert in case of crash
        • Trip recording widget
        • Location sharing
    • REST services
      • Trip
      • References
    • Trip Simulator
      • iOS
      • Android
  • PERMISSIONS UTILS
    • Introduction
    • User interface
      • iOS
        • Get started
        • Main configurations
      • Android
        • Get started
        • Main configurations
  • COMMON UI
    • Introduction
    • iOS
      • Get started
    • Android
      • Get started
    • References
  • DRIVER DATA
    • Introduction
    • iOS
      • Get started
      • References (iOS)
    • Android
      • Get started
      • References (Android)
    • User interface
      • iOS
        • Get started
        • Advanced configurations
        • Trips widgets
        • My Synthesis
        • My Driver Profile
      • Android
        • Get Started
        • Advanced configurations
        • Trips widgets
        • My Synthesis
        • My Driver Profile
  • Driver Data Timeline UI
    • Introduction
    • iOS
      • Get started
    • Android
      • Get started
  • Vehicle
    • Introduction
    • iOS
      • Get started
      • Vehicle management
      • Beacon management
      • Bluetooth device management
      • Odometer
      • References (iOS)
    • Android
      • Get started
      • Vehicle management
      • Beacon management
      • Bluetooth device management
      • Odometer
      • References (Android)
    • User interface
      • iOS
        • Get started
        • Main configurations
        • Advanced configurations
      • Android
        • Get started
        • Main configurations
        • Advanced configurations
  • DRIVER ACHIEVEMENT
    • Introduction
    • iOS
      • Get started
    • Android
      • Get Started
    • User interface
      • iOS
      • Android
  • CHALLENGE
    • Introduction
    • Important challenge rules
    • iOS
      • Get started
      • References (iOS)
    • Android
      • Get started
      • References (Android)
    • User interface
      • iOS
        • Get started
      • Android
        • Get started
  • GROUP
    • Introduction
    • iOS
      • Get started
    • Android
      • Get started
  • React Native
    • Get started
    • Integration
  • Flutter
    • Get started
    • Integration
  • Push services
    • Introduction
    • Push Trip Data
    • Push Deleted trip
    • Push Crash Data
    • Push Diagnosis Data
  • ADMIN SERVICES
    • Beacon
      • Add
      • Replace
      • Delete
      • Configuration
    • Challenges
      • List of challenges
      • Challenge details
      • Registered users
      • Challenge ranking
      • Users' progress
      • Definitions
    • Customer
      • Activity timeline
    • Driver
      • Timeline
      • Synthesis
      • Identity
      • Status
      • Add or update a metadata
      • Vehicles
      • Profile
      • Application diagnoses
    • Drivers
      • Account
      • Statistics
      • Ranking
      • Expired accounts
    • Group
      • Timeline
      • Synthesis
    • Trips
      • Add or update a metadata
      • Delete a metadata
    • Vehicle
      • Create
      • Characteristics
      • Configuration
      • Statistics
      • Update mileage
      • Tire and brake wear update
      • References
  • Crashes
    • Annotate a crash
    • Revoke crash location URL
  • ENTERPRISE SERVICES
    • Introduction
    • Teams
      • Create a team
      • List of teams
      • Enable or disable a team
    • Hyper-admins
      • Create a hyper-admin
      • List of hyper-admins
      • Delete a hyper-admin
    • Monitoring
      • Get a push trip data report
      • Get a push crash data report
      • Request to retry failed trips
      • Request to retry failed crashes
      • Get the status of a task
  • Release notes
    • Changelog
      • iOS
      • Android
      • UI iOS
      • UI Android
Powered by GitBook
On this page

Was this helpful?

Export as PDF
  1. ADMIN SERVICES
  2. Driver

Application diagnoses

PreviousProfileNextDrivers

Last updated 1 month ago

Was this helpful?

This API returns information about a user's application diagnosis. It can be used to determine whether the application settings are correct:

  • In a nominal state, the user's trips will be detected and recorded.

  • If the smartphone is not correctly configured, or if the user has not granted the proper accesses for the application, the trip recording may be altered.

When a user reports an issue with trip detection or recording, this API can help identify the most probable cause, which can greatly accelerate user support.

If you have your admin API key, you can try the API via this .

Path parameters

Field
Type
Description

userId

string

Driver's unique identifier

Response

The table below summarizes the list of a driver application's diagnosis data.

Field
Type
Description

userInfo

User information

diagnoses

array[object]

In the nominal case, the user's account is active on one device, and the diagnoses array will contain a single entry.

However, if the account is active on multiple devices, or if the application was reinstalled, the array will include one entry for each installation. Each device is uniquely identified by its installationId.

UserInfo

The table below summarizes the content of the userInfo object.

Field
Type
Description

userId

string

User unique identifier

firstname

string

User firstname

lastname

string

User lastname

companyName

string

Company name

registerDate

string

User registration date

Date format: YYYY-MM-ddโ€™Tโ€™HH:mm:ss.SSSZ

firstTrip

string

Date of the first trip

Date format: YYYY-MM-ddโ€™Tโ€™HH:mm:ss.SSSZ

lastTrip

string

Date of the last trip

Date format: YYYY-MM-ddโ€™Tโ€™HH:mm:ss.SSSZ

DiagnosisResponse

The table below summarizes the content of the diagnoses array items.

Field
Type
Description

installationId

string

Unique identifier of an installation

smartphoneData

Information about the user's smartphone

lastUpdate

string

Last update of application diagnostic data

Date format: YYYY-MM-ddโ€™Tโ€™HH:mm:ss.SSSZ

status

string

Allowed values: VALID, WARNING, ERROR

comments

array[object]

sensors

Sensors status

permissions

Permissions status

settings

Additional settings status

events

Events related to user actions

SmartphoneData

The table below summarizes the content of the smartphoneData object.

Field
Type
Description

phoneModel

string

Device model name

appBuildNumber

string

Application build number

osVersion

string

Version of the operating system

osType

string

Platform: iOS or Android

sdkVersion

string

Version of the DriveKit SDK

phoneLanguage

string

Phone language

rawPhoneLanguage

string

Raw phone language

Comments

The table below summarizes the content of the comments object.

Field
Type
Description

code

integer

Comment identifier

comment

string

Short description (in English)

Sensors

The table below summarizes the content of the sensors object.

Field
Type
Description

location

string

Location sensor status

Allowed values: ENABLED, DISABLED, UNKNOWN

bluetooth

string

Bluetooth sensor status

Allowed values: ENABLED, DISABLED, UNKNOWN

Permissions

The table below summarizes the content of the permissions object.

Field
Type
Description

location

string

Location permission status

Allowed values: GRANTED, DENIED, UNKNOWN

bluetooth

string

Bluetooth permission status

Allowed values: GRANTED, DENIED, UNKNOWN

activity

string

Activity permission status

Allowed values: GRANTED, DENIED, UNKNOWN

notification

string

Notification permission status

Allowed values: GRANTED, DENIED, UNKNOWN

Settings

The table below summarizes the content of the settings object.

Field
Type
Description

permissionAutodelete

string

Status of permission revocation functionality in case of prolonged inactivity (Android only).

Allowed values: ENABLED, DISABLED, UNKNOWN, NOT_APPLICABLE

batteryOptimisation

string

Battery optimization status (Android only)

Allowed values: ENABLED, DISABLED, UNKNOWN, NOT_APPLICABLE

lowPowerMode

string

Low power mode status (iOS only)

Allowed values: ENABLED, DISABLED, UNKNOWN, NOT_APPLICABLE

Events

The table below summarizes the content of the events object.

Field
Type
Description

device

string

Status indicating whether the phone is on

Allowed values: TURNED_ON, TURNED_OFF, UNKNOWN

app

string

Status indicating whether the application is installed on the phone

Allowed values: INSTALLED, UNINSTALLED, UNKNOWN

user

string

Status indicating whether the user is logged in

Allowed values: LOGGED_IN, LOGGED_OUT, UNKNOWN

Definitions

Global status

The global status value depends on the status of each individual parameter:

Status
Description

ERROR

At least one of the parameters is in CRITICAL state (๐Ÿ”ด).

WARNING

At least one of the parameters is in WARNING state (๐ŸŸก), but no parameter is in CRITICAL state (๐Ÿ”ด).

VALID

No parameter is in CRITICAL (๐Ÿ”ด) or WARNING states (๐ŸŸก).

Note:

Individual parameters criticality

The criticality of each parameter is determined by its status and, in some cases, is specific to the OS of the smartphone. We define 3 levels of criticality:

Level
Description

๐Ÿ”ด CRITICAL

Trip detection and/or recording is not possible

๐ŸŸก WARNING

Trip detection and/or recording is impaired, and trips are likely to be lost

๐ŸŸข MINOR

Trip detection and/or recording should work as expected

The table below describes, for each parameter, the level of impact of a given status on trip detection and/or recording:

Type
Parameter
Criticality
Status

sensors

location

๐Ÿ”ด

DISABLED

sensors

bluetooth

๐ŸŸก

DISABLED

permissions

location

๐Ÿ”ด

DENIED

permissions

bluetooth

๐ŸŸก

DENIED

permissions

activity

๐ŸŸก

DENIED

permissions

notification

๐ŸŸข

GRANTED, DENIED

settings

permissionAutodelete

๐ŸŸข

ENABLED, DISABLED

settings

batteryOptimisation

๐ŸŸก

ENABLED

settings

lowPowerMode

๐ŸŸข

ENABLED, DISABLED

events

device

๐Ÿ”ด

TURNED_OFF

events

app

๐Ÿ”ด

UNINSTALLED

events

user

๐Ÿ”ด

LOGGED_OUT

Known Comments

The table below gives more details about the known values for the comments object. We encourage you to use the comment code to identify the messages, as the comment value might change in the future.

Code
Condition
Comment

0

No issue detected

Trip detection and/or recording should work as expected

1

At least one event in warning state

Trip detection and/or recording is impaired, and trips are likely to be lost

2

At least one event in error state

Trip detection and/or recording is not possible

3

The lastUpdate is more than 7 days in the past

The data has not been updated for more than 7 days. It is not possible to guarantee that the current application settings are correct.

4

The location sensor status OR the location permission status are UNDEFINED

Location sensor status or the permission to access the location sensor could not be retrieved. It is not possible to determine if the application is running normally.

5

Multiple phone models were used at the same time in the last 30 days Or, at least two diagnoses with a different installationId in the last 7 days

The user account is used in more than one smartphone.

6

If an installationId is present, only no more than one diagnosis has been updated in the last 7 days

A single smartphone has been connected to the user account in the last 7 days.

List of all the diagnoses related to the driverโ€™s account. See

Global smartphone status, which indicates if the mobile application is configured to record user trips (see ).

Short description of mobile application configuration status. See

See

We chose not to consider parameters with an UNKNOWN or NOT_APPLICABLE status in the global status. More informations about the global status can be retrieved in the section.

comments
UserInfo
DiagnosisResponse
SmartphoneData
the definition
Comment
Sensors
Permissions
Settings
Events
Known Comments
link

List all driver's application diagnoses

get
Path parameters
userIdstringRequired

User's username

Header parameters
DriveKit-Admin-API-KeystringRequired

Drivekit Admin API key

Responses
200
OK
application/json
401
Unauthorized
application/json
404
Driver Or Application Diagnostic Not Found
application/json
get
GET /v3/drivekit/admin/drivers/{userId}/application/diagnoses HTTP/1.1
Host: service.drivequant.com
DriveKit-Admin-API-Key: text
Accept: */*
{
  "userInfo": {
    "userId": "john.doe@drivequant.com",
    "firstname": "John",
    "lastname": "Doe",
    "companyName": "myMajorCompany",
    "registerDate": "2017-07-02T22:22:18.000+0000",
    "firstTrip": "2017-07-25T18:30:55.065+0000",
    "lastTrip": "2023-11-05T17:49:48.000+0000"
  },
  "diagnoses": [
    {
      "installationId": "03ff926b-4767-5f51-bcfb-91aa9e206799",
      "smartphoneData": {
        "phoneModel": "Google Pixel 7",
        "appBuildNumber": "671",
        "osVersion": "34",
        "osType": "Android",
        "sdkVersion": "1.38.0",
        "phoneLanguage": "FRENCH",
        "rawPhoneLanguage": "fr-FR"
      },
      "lastUpdate": "2023-07-02T22:22:18.000+0000",
      "status": "VALID",
      "comments": [
        {
          "code": 0,
          "comment": "Trip detection and/or recording should work as expected"
        }
      ],
      "sensors": {
        "location": "ENABLED",
        "bluetooth": "ENABLED"
      },
      "permissions": {
        "location": "GRANTED",
        "bluetooth": "GRANTED",
        "activity": "GRANTED",
        "notification": "GRANTED"
      },
      "settings": {
        "permissionAutodelete": "DISABLED",
        "batteryOptimisation": "DISABLED",
        "lowPowerMode": "NOT_APPLICABLE"
      },
      "events": {
        "device": "TURNED_ON",
        "app": "INSTALLED",
        "user": "LOGGED_IN"
      }
    }
  ]
}
  • GETList all driver's application diagnoses
  • Path parameters
  • Response
  • UserInfo
  • DiagnosisResponse
  • SmartphoneData
  • Comments
  • Sensors
  • Permissions
  • Settings
  • Events
  • Definitions
  • Global status
  • Individual parameters criticality
  • Known Comments