Skip to main content
GET
Vehicle Fuel Consumption

Authorizations

Authorization
string
header
required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Path Parameters

customerId
string
required

Query Parameters

startDate
string<date-time>
required

The start date and time for the period, in UTC, in the format of YYYY-MM-DDThh:mm:ss. Required.

endDate
string<date-time>
required

The end date and time for the period, in UTC, in the format of YYYY-MM-DDThh:mm:ss. Required and must be after startDate.

vehicleId
string

Vehicle identifier for querying consumption by specific vehicle. Cannot be used with groupId.

groupId
string

Group identifier for querying consumption by group. Cannot be used with vehicleId.

Response

Successful operation

assetId
string

Unique, unchangeable system generated identifier for the vehicle.

assetRegistration
string

Vehicle registration.

assetName
string

Friendly name of the vehicle.

distance
number<double>

Total distance (in KM) for journeys.

totalFuel
number<double>

Total quantity of fuel used (in litres) for all journeys. Will be the same value as fuelUsedLitres.

benchmarkConsumption
number<double>

The benchmark fuel consumption.

manufacturerConsumption
number<float>

The manufacturer’s fuel consumption.

energyType
enum<string>

The energy type for the vehicle.

Available options:
ICE,
EV,
HEV,
PHEV,
CNG,
LNG,
LPG,
FCEV,
BI_FUEL,
UNDEFINED
fuelType
enum<string>[]

A list of the primary and secondary fuel types for the vehicle.

A list of the primary and secondary fuel types for the vehicle.

Available options:
PETROL,
DIESEL,
METHANE,
PROPANE,
HYDROGEN,
ELECTRIC
electricUsedkWh
number<float>

Electricity used for all journeys in kWh.

gasUsedKg
number<float>

Gas for all journeys in Kg.

fuelUsedLitres
number<double>

Fuel consumed in litres.

fuelUsedPetrolEquivalentLitres
number<double>

Fuel consumed in petrol equivalent litres.

co2
number<double>

The total energy (Electricity, Gas,Petrol, Diesel) used for all journeys expressed as the petrol equivalent in litres.