Synthesis

The driver synthesis service provides a driver's scores and driving statistics. The data are obtained by averaging scores and aggregating trip data over the driver's entire activity, the current month, and the current week.

The driver synthesis is updated each time a new trip is analyzed.

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

Synthesis of driver's scores

GET https://service.drivequant.com/v3/drivekit/admin/drivers/{userId}/synthesis

Get a synthesis of DriveQuant scores and statistics for a specified driver.

Path Parameters

Name	Type	Description
userId	string	Driver's unique identifier

Headers

Name	Type	Description
DriveKit-Admin-API-Key	string	Admin API Key

200

{
  "userInfo": {
    "userId": "USER_ID",
    "firstname": "USER_FIRSTNAME",
    "lastname": "USER_LASTNAME",
    "companyName": "COMPANY_NAME",
    "registerDate": "2020-01-25-15-41-41",
    "firstTrip": "2020-01-28T12:36:45.000+0000",
    "lastTrip": "2020-10-10T09:42:52.999+0000"
  },
  "smartphoneData": {
    "phoneModel": "Google Pixel 3a",
    "appBuildNumber": "364",
    "osVersion": "30",
    "osType": "Android",
    "sdkVersion": "1.6.1",
    "phoneLanguage": "ENGLISH",
    "rawPhoneLanguage": "en-EN"
  },
  "scoresTimeRange": {
    "efficiency": {
      "overall": 7.96,
      "currentWeek": 7.7,
      "currentMonth": 7.97
    },
    "safety": {
      "overall": 8.28,
      "currentWeek": 7.3,
      "currentMonth": 7.71
    },
    "phoneDistraction": {
      "overall": 9.79,
      "currentWeek": 10,
      "currentMonth": 10
    },
    "speeding": {
      "overall": 1.01,
      "currentWeek": 2.17,
      "currentMonth": 2.09
    },
    "distance": {
      "overall": 6931.019999999995,
      "currentWeek": 130.74599999999998,
      "currentMonth": 194.183
    },
    "acceleration": {
      "overall": 0,
      "currentWeek": 0,
      "currentMonth": 0
    },
    "braking": {
      "overall": 0,
      "currentWeek": 0,
      "currentMonth": 0
    },
    "adherence": {
      "overall": 0,
      "currentWeek": 0,
      "currentMonth": 0
    },
    "fuelVolume": {
      "overall": 0,
      "currentWeek": 0,
      "currentMonth": 0
    },
    "co2Mass": {
      "overall": 0,
      "currentWeek": 0,
      "currentMonth": 0
    }
  },
  "scoresRoadContext": [
    {
      "roadContext": "TRAFFIC_JAM",
      "distance": 54.20400000000003,
      "duration": 3.8825000000000007,
      "efficiencyScore": 0,
      "safetyScore": 0
    },
    {
      "roadContext": "HEAVY_URBAN_TRAFFIC",
      "distance": 33.150000000000006,
      "duration": 1.7058333333333333,
      "efficiencyScore": 7.405208333333333,
      "safetyScore": 9.85
    },
    {
      "roadContext": "CITY",
      "distance": 1549.5510000000008,
      "duration": 37.7361111111111,
      "efficiencyScore": 7.527835051546392,
      "safetyScore": 8.022529644268776
    },
    {
      "roadContext": "SUBURBAN",
      "distance": 2290.7050000000004,
      "duration": 34.89499999999998,
      "efficiencyScore": 7.792338709677419,
      "safetyScore": 8.247272727272728
    },
    {
      "roadContext": "EXPRESSWAYS",
      "distance": 2978.6750000000006,
      "duration": 27.01527777777778,
      "efficiencyScore": 9.058461538461538,
      "safetyScore": 8.745161290322581
    }
  ],
  "customerData": {}
}

401

404

Response

The table below summarizes the list of synthesis data.

Field	Type	Description
userInfo	UserInfo	User information
smartphoneData	SmartphoneData	Information about the user's smartphone
customerData	CustomerData	Specific customer-related data
scoresTimeRange	ScoresTimeRange	Average driving scores per period
scoresRoadContext	ScoresRoadContext	Driving statistics and average scores per road context

User info

Field	Type	Description
userId	string	User unique identifier
firstname	string	User first name
lastname	string	User last name
companyName	string	Company name
registerDate	date	User registration date Date format: YYYY-MM-dd’T’HH:mm:ss.SSSZ
firstTrip	date	Date of the first trip Date format: YYYY-MM-dd’T’HH:mm:ss.SSSZ
lastTrip	date	Date of the last trip Date format: YYYY-MM-dd’T’HH:mm:ss.SSSZ
lastUpdate	date	Date of the last synthesis data update. Date format: YYYY-MM-dd’T’HH:mm:ss.SSSZ

Smartphone data

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

Customer data

Customer data consists of customer-specific metadata such as: license plate number, commercial email opt-in, contract number (formatted as a map of key-value).

ScoresTimeRange

For each theme (efficiency, safety, phoneDistraction, speeding, distance, acceleration, braking, adherence, fuelVolume, co2Mass):

Field	Type	Description
overall	double	Average score based on all trips
currentWeek	double	Average score based on trips performed during the current week
currentMonth	double	Average score based on trips performed during the current month

ScoresRoadContext

Field	Type	Description
roadContext	string	Road context (see below)
distance	double	Total driving distance (in km)
duration	double	Total driving duration (in min)
efficiencyScore	double	Average ecodriving score
safetyScore	double	Average safety score

Road context

Driving contexts are calculated from the GPS velocity. They are not based on map data.

Value	Description
HEAVY_URBAN_TRAFFIC	Speed below 30 km/h and distance between two stops greater than 100m
CITY	30 km/h < Speed < 65 km/h
SUBURBAN	65 km/h < Speed < 96 km/h
EXPRESSWAYS	Speed > 96 km/h