Profile

Each driver has a signature that depends on the way they use their vehicle. This service provides an accurate picture of the driver's profile based on an analysis of driving data.

The driver profile reflects the driver's habits: frequency of trips, regularity, distance travelled per year and mobility area.

The reliability and accuracy of the results improves with the amount of historical data analyzed. A minimum of 2 active weeks and 500 km travelled are required to get a response.

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

Get driver profile and driving habits

get

This service returns information describing a driver's profile and his driving habits. The accuracy of the results depends on the distance travelled and the activity duration. A minimum of 2 active weeks and 500 km travelled are required to get a response.

Path parameters

userIdstringRequired

User's username

Header parameters

DriveKit-Admin-API-KeystringRequired

Drivekit Admin API key

Responses

200

OK

application/json

400

Bad Request

application/json

401

Unauthorized

application/json

403

Forbidden (feature not activated for customer)

application/json

404

Driver Not Found

application/json

get

/drivekit/admin/drivers/{userId}/profile

HTTPcURLJavaScriptPython

GET /v3/drivekit/admin/drivers/{userId}/profile HTTP/1.1
Host: service.drivequant.com
DriveKit-Admin-API-Key: text
Accept: */*

{
  "userInfo": {
    "userId": "USER_ID",
    "firstname": "USER_FIRSTNAME",
    "lastname": "USER_LASTNAME",
    "companyName": "COMPANY_NAME",
    "registerDate": "2022-04-08T14:37:17.000+0000",
    "firstTrip": "2022-04-08T13:25:43.000+0000",
    "lastTrip": "2023-05-05T22:34:08.000+0000"
  },
  "statistics": {
    "tripsNumber": 3264,
    "totalDistance": 53659,
    "totalDuration": 1033,
    "week": 57,
    "activeWeek": 57,
    "month": 14,
    "activeMonth": 14,
    "peakHour": "10:00",
    "peakDay": "THURSDAY"
  },
  "percentageRoadContext": [
    {
      "context": "TRAFFIC_JAM",
      "distance": 3.3,
      "duration": 13,
      "energy": 0
    },
    {
      "context": "HEAVY_URBAN_TRAFFIC",
      "distance": 2.3,
      "duration": 6.9,
      "energy": 0.9
    },
    {
      "context": "CITY",
      "distance": 15.3,
      "duration": 28.4,
      "energy": 14.2
    },
    {
      "context": "SUBURBAN",
      "distance": 20.5,
      "duration": 19.1,
      "energy": 18
    },
    {
      "context": "EXPRESSWAYS",
      "distance": 58.6,
      "duration": 32.5,
      "energy": 66.9
    }
  ],
  "regularity": {
    "week": {
      "numberWeek": 50,
      "numberTripMean": 59,
      "numberTripStd": 10,
      "distanceMean": 964,
      "distanceStd": 290,
      "durationMean": 1115,
      "durationStd": 240
    },
    "month": {
      "numberMonth": 13,
      "numberTripMean": 248,
      "numberTripStd": 52,
      "distanceMean": 4126,
      "distanceStd": 1578,
      "durationMean": 4725,
      "durationStd": 1321
    }
  },
  "distanceEstimation": {
    "week": 980,
    "month": 4300,
    "year": 50000,
    "confidence": "HIGH"
  },
  "commonTrips": [
    {
      "type": "MOST_FREQUENT",
      "count": 126,
      "distance": 3,
      "duration": 6,
      "roadContext": "CITY"
    }
  ],
  "mobilityArea": [
    {
      "type": "50TH_PERCENTILE",
      "radius": 7
    },
    {
      "type": "90TH_PERCENTILE",
      "radius": 29.9
    }
  ],
  "profile": {
    "distance": "VERY_LONG",
    "activity": "HIGH",
    "regularity": "REGULAR",
    "roadContext": "EXPRESSWAYS",
    "mobility": "WIDE",
    "comment": "This user is a professional driver who travels about 50000 km/year. He has a high activity corresponding to 100% of active weeks. He has fairly regular habits. The majority of his trips are in an expressways environment. His mobility area is wide and 90% of his trips are within a 29.9 km radius."
  }
}

Path parameters

Field	Type	Description
userId	string	Driver's unique identifier

Response

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

Field	Type
userInfo	UserInfo	Generic information about the user
statistics	Statistics	Synthesis of the user's data since his first recorded trip
regularity	Regularity	Regularity of the user
distanceEstimation	DistanceEstimation	Estimated driving distances per week, month and year
profile	Profile	User's driving habits
percentageRoadContext	array[object]	Distribution of the user's trip by road context (see PercentageRoadContext)
commonTrips	array[object]	Typology of usual user trips (see CommonTrips)
mobilityArea	array[object]	User mobility area (see MobilityArea)

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

Statistics

The table below summarizes the content of the statistics object.

Field	Type	Description
tripsNumber	int	Total number of trips
totalDistance	int	Total distance (in km)
totalDuration	int	Total driving duration (in min)
week	int	Number of weeks since user registration
activeWeek	int	Number of active weeks since user registration
month	int	Number of months since user registration
activeMonth	int	Number of active months since user registration
peakHour	string	Peak hour trip start Format: hh:mm
peakDay	string	Weekday with most trips completed. Allowed values: MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY, SUNDAY

Regularity

The table below summarizes the content of the regularity object.

Field	Type	Description
week	object	User's regularity on a weekly basis
month	object	User's regularity on a monthly basis

The structure of week an month object is very similar, as described in the tables below:

week

Field	Type	Description
numberWeek	int	Number of weeks used to compute the regularity
numberTripMean	int	Average number of trips per week
numberTripStd	int	Standard deviation of the number of trips per week
distanceMean	int	Average weekly distance (in km)
distanceStd	int	Standard deviation for the weekly distance (in km)
durationMean	int	Average weekly driving duration (in min)
durationStd	int	Standard deviation of the weekly driving duration (in min)

month

DistanceEstimation

The table below summarizes the content of the distanceEstimation object.

Field	Type	Description
week	int	Estimated weekly distance (in km)
month	int	Estimated monthly distance (in km)
year	int	Estimated annual distance (in km)
confidence	string	Confidence level indicator Allowed values: LOW, MEDIUM, HIGH

The confidence level indicator in based on the available data: LOW if less than 8 weeks, MEDIUM if less than 16 weeks, HIGH otherwise.

Profile

The table below summarizes the content of the profile object.

Field	Type	Description
distance	string	User's distance class Allowed values: VERY_SHORT, SHORT, MEDIUM, LONG, VERY_LONG
activity	string	User's activity class Allowed values: LOW, MEDIUM, HIGH
regularity	string	User's regularity class Allowed values: REGULAR, INTERMITTENT
roadContext	string	User's major road context (distance based) Allowed values: TRAFFIC_JAM, HEAVY_URBAN_TRAFFIC, CITY, SUBURBAN, EXPRESSWAYS
mobility	string	User's mobility class Allowed values: NARROW, SMALL, MEDIUM, LARGE, WIDE, VAST
comment	string	Short description of the user's profile in plain english

The comment is a summary of the driver's driving habits.

Example:

This user is a professional driver who travels about 51000 km/year. He has a high activity corresponding to 100% of active weeks. He has fairly regular habits. The majority of his trips are in an expressways environment. His mobility area is vast and 90% of his trips are within a 30 km radius.

Definition of distance field values

Value	Description	Estimated yearly distance (in km)
VERY_SHORT	Very short distance driver	less than 5 000
SHORT	Short distance driver	5 000 to 10 000
MEDIUM	Medium distance driver	10 000 to 20 000
LONG	Long distance driver	20 000 to 40 000
VERY_LONG	Professional driver	more than 40 000

Definition of activity field values

Value	Description	Percentage of active weeks
LOW	Low activity driver	less than 30 %
MEDIUM	Medium activity driver	30 to 60 %
HIGH	High activity driver	more than 60 %

Definition of mobility field values

Value	Definition
NARROW	90% of trips are within a radius of less than 10 km
SMALL	90% of trips are within a radius of less than 20 km
MEDIUM	90% of trips are within a radius of less than 30 km
LARGE	90% of trips are within a radius of less than 50 km
WIDE	90% of trips are within a radius of less than 100 km
VAST	90% of trips are within a radius of 100 km or more

PercentageRoadContext

The percentageRoadContext array contains a data object for each allowed context value:

Field	Type	Description
context	string	Road context Allowed values: TRAFFIC_JAM, HEAVY_URBAN_TRAFFIC, CITY, SUBURBAN, EXPRESSWAYS
distance	double	Percentage of total distance spent in this context
duration	double	Percentage of total duration spent in this context
energy	double	Percentage of total energy spent in this context

CommonTrips

The commonTrips array contains a data object for each allowed type value:

Field	Type	Description
type	string	Typology of the most common trip. Allowed values: MOST_FREQUENT
count	int	Number of trips
distance	int	Average trip distance (in km)
duration	int	Average trip duration (in min)
roadContext	string	Road context Allowed values: TRAFFIC_JAM, HEAVY_URBAN_TRAFFIC, CITY, SUBURBAN, EXPRESSWAYS

MobilityArea

The mobilityArea array contains a data object for each allowed type value:

Field	Type	Description
type	string	Percentile of trips Allowed values: PERCENTILE_50TH, PERCENTILE_90TH
radius	int	Radius (in km) of the circle containing the trips