Timeline

The Vehicle Timeline Service offers an overview of a vehicle's 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 and summarizing trip details over the selected period. The same statistics are retrieved for each individual road context.

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

circle-info

If you have your admin API key, you can try the API via this linkarrow-up-right.

Get vehicle timeline

get
Authorizations
DriveKit-Admin-API-KeystringRequired
Path parameters
vehicleIdstringRequired

The vehicle's identifier

Query parameters
dateFormatstring · enumOptional

Date format in the response:

  • timestamp: number of milliseconds since January 1, 1970, 00:00:00 GMT (e.g., 1685625600000)
  • isodate: ISO 8601 date format (e.g., '2023-06-01T13:20:00.168Z')
Default: isodatePossible values:
Header parameters
DriveKit-Admin-API-KeystringRequired

Drivekit Admin API key

Responses
chevron-right
200

OK

application/json
get
/drivekit/admin/vehicles/{vehicleId}/timeline
circle-info

Note

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 isodate format.

Response

The table below summarizes the list of timeline data.

Field
Type
Description

month

Monthly statistics

week

Weekly statistics

Timeline

The table below summarizes the content of a timeline object.

Field
Type
Description

allContext

Average statistics for all contexts

roadContext

array[object]

Average statistics for each context (see TimelineItemVehicle)

GlobalTimelineItemVehicle

The table below summarizes the content of a globalTimelineItemVehicle object.

Field
Type
Description

date

array[string]

First date of the period Default date format: YYYY-MM-dd’T’HH:mm:ss.SSSZ

numberTrip

array[integer]

Number of trips during the period

distance

array[number]

Distance driven during the period (in km)

distanceLoss

array[number]

Estimated loss distance during the period at the beginning of the trips (in km).

Requires the route start completion feature to be enabled.

duration

array[number]

Trip duration during the period (in min)

fuelVolume

array[number]

Amount of fuel used during the period (in L)

fuelConsumption

array[number]

Fuel consumption during the period (in L/100km)

co2

array[number]

Consumption during the period (in gCO2/km)

co2Opti

array[number]

Optimal consumption during the period (in gCO2/km)

energyKWh

array[number]

Energy during the period (in kWh)

energyKWhOpti

array[number]

Optimal Energy during the period (in kWh)

energyConsumption

array[number]

Energy consumption during the period (in kWh/100km)

energyOptiConsumption

array[number]

Optimal Energy during the period (in kWh/100km)

TimelineItemVehicle

The table below summarizes the content of a timelineItemVehicle object.

Field
Type
Description

date

array[string]

First date of the period Default date format: YYYY-MM-dd’T’HH:mm:ss.SSSZ

roadContext

array[string]

Type of RoadContext.

Allowed values: HEAVY_URBAN_TRAFFIC, CITY, SUBURBAN, EXPRESSWAYS

numberTrip

array[integer]

Number of trips for which this road context was the major one

distance

array[number]

Distance driven in this context (in km)

distanceLoss

array[number]

Estimated loss distance during the period at the beginning of the trips (in km).

Requires the route start completion feature to be enabled.

duration

array[number]

Trip duration in this context (in min)

fuelVolume

array[number]

Amount of fuel used in this context (in L)

fuelConsumption

array[number]

Fuel consumption in this context (in L/100km)

co2

array[number]

Consumption in this context (in gCO2/km)

co2Opti

array[number]

Optimal consumption in this context (in gCO2/km)

energyKWh

array[number]

Energy in this context (in kWh)

energyKWhOpti

array[number]

Optimal Energy in this context (in kWh)

energyConsumption

array[number]

Energy consumption in this context (in kWh/100km)

energyOptiConsumption

array[number]

Optimal Energy in this context (in kWh/100km)

RoadContext

Road 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

Last updated

Was this helpful?