> ## Documentation Index
> Fetch the complete documentation index at: https://docs.connectedfleet.michelin.com/llms.txt
> Use this file to discover all available pages before exploring further.
# Vehicle Fuel Consumption
> Returns the fuel consumption and CO2 information for a vehicle for all journeys where the journey started within the period. The end date of the journey does not have to be within the period. Includes the fuel used on a private journey.
If vehicleId or groupId is not specified, then details for all vehicles are returned. If groupId is specified, then the fuel consumption for all vehicles in the specified group is included in the output. Either vehicleId or groupId can be specified as an input parameter, an error is returned if both are specified.
## OpenAPI
````yaml /api-reference/performance.json get /public/v1/customer/{customerId}/fuel/vehicle
openapi: 3.0.1
info:
title: Performance
description: >-
Delivers deeper insights into driver behaviour, fuel efficiency, CO₂ impact
and safe driving practices.
contact:
name: Masternaut
url: https://www.masternaut.com
email: support@masternautconnect.com
version: 124.0.2607160821
servers:
- url: https://api.masternautconnect.com/connect-webservices/services
description: Product Server
security:
- basicAuth: []
tags:
- name: /alert
description: Alert history and notification management operations
- name: /driver
description: Driver Operations
- name: /driverbehaviourmetrics
description: Driver Behaviour Metrics
- name: customers
description: Customer Behaviour Metrics
- name: /ecoscore
description: EcoScore
- name: /fuel
description: Fuel
- name: /idling
description: Idling
- name: /speeding
description: Speeding
- name: /tokenInformation
description: Token operations
- name: /utilisation
description: Utilisation
- name: /vehicle
description: Vehicle management operations
paths:
/public/v1/customer/{customerId}/fuel/vehicle:
get:
tags:
- /fuel
summary: Vehicle Fuel Consumption
description: >-
Returns the fuel consumption and CO2 information for a vehicle for all
journeys where the journey started within the period. The end date of
the journey does not have to be within the period. Includes the fuel
used on a private journey.
If vehicleId or groupId is not
specified, then details for all vehicles are returned. If groupId is
specified, then the fuel consumption for all vehicles in the specified
group is included in the output. Either vehicleId or groupId can be
specified as an input parameter, an error is returned if both are
specified.
operationId: getVehicleConsumptions
parameters:
- name: customerId
in: path
required: true
schema:
type: string
- name: startDate
in: query
description: >-
The start date and time for the period, in UTC, in the format of
YYYY-MM-DDThh:mm:ss. Required.
required: true
schema:
type: string
description: >-
The start date and time for the period, in UTC, in the format of
YYYY-MM-DDThh:mm:ss. Required.
format: date-time
- name: endDate
in: query
description: >-
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.
required: true
schema:
type: string
description: >-
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.
format: date-time
- name: vehicleId
in: query
description: >-
Vehicle identifier for querying consumption by specific vehicle.
Cannot be used with groupId.
required: false
schema:
type: string
description: >-
Vehicle identifier for querying consumption by specific vehicle.
Cannot be used with groupId.
- name: groupId
in: query
description: >-
Group identifier for querying consumption by group. Cannot be used
with vehicleId.
required: false
schema:
type: string
description: >-
Group identifier for querying consumption by group. Cannot be used
with vehicleId.
responses:
'200':
description: Successful operation
content:
application/json;charset=UTF-8:
schema:
type: array
items:
$ref: '#/components/schemas/VehicleConsumptionResultDto'
'400':
description: Bad input parameters
content:
application/json;charset=UTF-8:
schema:
$ref: '#/components/schemas/ApiErrorDto'
'404':
description: Resource not found
content:
application/json;charset=UTF-8:
schema:
$ref: '#/components/schemas/ApiErrorDto'
components:
schemas:
VehicleConsumptionResultDto:
type: object
properties:
assetId:
type: string
description: Unique, unchangeable system generated identifier for the vehicle.
assetRegistration:
type: string
description: Vehicle registration.
assetName:
type: string
description: Friendly name of the vehicle.
distance:
type: number
description: Total distance (in KM) for journeys.
format: double
totalFuel:
type: number
description: >-
Total quantity of fuel used (in litres) for all journeys. Will be
the same value as fuelUsedLitres.
format: double
benchmarkConsumption:
type: number
description: The benchmark fuel consumption.
format: double
manufacturerConsumption:
type: number
description: The manufacturer’s fuel consumption.
format: float
energyType:
type: string
description: The energy type for the vehicle.
enum:
- ICE
- EV
- HEV
- PHEV
- CNG
- LNG
- LPG
- FCEV
- BI_FUEL
- UNDEFINED
fuelType:
type: array
description: A list of the primary and secondary fuel types for the vehicle.
items:
type: string
description: A list of the primary and secondary fuel types for the vehicle.
enum:
- PETROL
- DIESEL
- METHANE
- PROPANE
- HYDROGEN
- ELECTRIC
electricUsedkWh:
type: number
description: Electricity used for all journeys in kWh.
format: float
gasUsedKg:
type: number
description: Gas for all journeys in Kg.
format: float
fuelUsedLitres:
type: number
description: Fuel consumed in litres.
format: double
fuelUsedPetrolEquivalentLitres:
type: number
description: Fuel consumed in petrol equivalent litres.
format: double
co2:
type: number
description: >-
The total energy (Electricity, Gas,Petrol, Diesel) used for all
journeys expressed as the petrol equivalent in litres.
format: double
description: >-
Vehicle fuel consumption results including distance, fuel usage, CO2
emissions, and vehicle details.
ApiErrorDto:
type: object
properties:
errorCode:
type: integer
format: int32
errorMessage:
type: string
offendingFields:
type: array
items:
type: string
securitySchemes:
basicAuth:
type: http
scheme: basic
````