For the complete documentation index, see llms.txt. This page is also available as Markdown.

Timeline

The Group Timeline Service offers an overview of a group's score history and related statistics, formatted as a vector with chronologically sorted data.

This information is available in two time scales (weekly and monthly) and is generated by averaging scores and summarizing trip details over the selected period.

The timeline updates automatically with the analysis of each new trip.

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

Timeline of group's scores

GET https://service.drivequant.com/v3/drivekit/admin/group/timeline

Get monthly and weekly averages of DriveQuant scores for a specific group:

Query Parameters

Name
Type
Description

label

string

Group label

Headers

Name
Type
Description

DriveKit-Admin-API-Key

string

Admin API Key

Notes

Group filtering

The timeline data of a specific group can be retrieved using the label query parameter.

If the label parameter is not specified, the service returns the data from a group composed of all the drivers belonging to your organisation.


Dates formatting

Use the dateFormat query parameter to control the format of the date fields in the response. Accepted values are:

  • timestamp : returns dates as a 64-bit integer representing the number of milliseconds elapsed since the Unix epoch (January 1, 1970, 00:00:00 UTC). Example: 1685625600000

  • isodate : returns dates as a string conforming to the ISO 8601 standard. Example: 2023-06-01T13:20:00.168Z

If the dateFormat parameter is not specified, the response defaults to timestamp format.

Response

The table below summarizes the list of timeline data.

Field
Type
Description

roadContext

string

Road context (see below)

date

array[date]

Vector of dates (first day of the period)

Default date format: unix timestamp

numberTripScored

array[int]

Vector of trips number (scored)

numberTripTotal

array[int]

Vector of trips number (total)

distance

array[double]

Vector of driving distances (in km)

duration

array[double]

Vector of driving durations (in min)

efficiency

array[double]

Vector of average ecodriving scores

safety

array[double]

Vector of average safety scores

acceleration

array[int]

Vector of total hard accelerations

braking

array[int]

Vector of total hard brakings

adherence

array[int]

Vector of total adherence limits

co2Mass

array[double]

Vector of total CO2 mass (in kg)

fuelVolume

array[double]

Vector of total fuel volume (in L)

unlock

array[int]

Vector of total unlocks - only for allContext

lock

array[int]

Vector of total locks - only for allContext

callAuthorized

array[int]

Vector of total authorized calls - only for allContext

callForbidden

array[int]

Vector of total unauthorized calls - only for allContext

callAuthorizedDuration

array[int]

Vector of authorized calls duration (in sec) - only for allContext

callForbiddenDuration

array[int]

Vector of unauthorized calls duration (in sec) - only for allContext

numberTripWithForbiddenCall

array[int]

Vector of number of trips with one or more forbidden call

Road context

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

Value
Description

TRAFFIC_JAM

Speed below 10 km/h and distance between two stops greater than 100m

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

Last updated

Was this helpful?