> ## 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 Score Events
> Returns the vehicle score driving events that occurred during a journey where the journey started in the specified period.
Events that occurred during a private journey are included in the response unless the "exclude private journey from EcoDrive" option has been selected.
Events generated during a private journey will not include address details.
The end date of the journey does not have to be within the specified period. The value specified for the endDate cannot be before startDate and the date range between startDate and endDate cannot be more than 7 days.
Either vehicleId or groupId must be specified as an input parameter. If groupId is specified, then the driving events for all vehicles in the specified group are included in the output.
In ecoDrive, a speeding event is when the vehicle's speed exceeds the value set for the ecoDrive speed threshold. The ecoDrive speed threshold is not checked against the road speed limit and is not the same as a speeding episode.
## OpenAPI
````yaml https://api.connectedfleet.michelin.com/performance/api-docs get /public/v1/customer/{customerId}/ecoscore/event/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.connectedfleet.michelin.com/performance
description: Product Server
security:
- bearerAuth: []
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}/ecoscore/event/vehicle:
get:
tags:
- /ecoscore
summary: Vehicle Score Events
description: >-
Returns the vehicle score driving events that occurred during a journey
where the journey started in the specified period.
Events that
occurred during a private journey are included in the response unless
the "exclude private journey from EcoDrive" option has been
selected.
Events generated during a private journey will not include
address details.
The end date of the journey does not have to
be within the specified period. The value specified for the endDate
cannot be before startDate and the date range between startDate and
endDate cannot be more than 7 days.
Either vehicleId or groupId
must be specified as an input parameter. If groupId is specified, then
the driving events for all vehicles in the specified group are included
in the output.
In ecoDrive, a speeding event is when the
vehicle's speed exceeds the value set for the ecoDrive speed threshold.
The ecoDrive speed threshold is not checked against the road speed limit
and is not the same as a speeding episode.
operationId: getEcoScoreEventVehicle
parameters:
- name: customerId
in: path
required: true
schema:
type: string
- name: pageIndex
in: query
description: >-
Specifies the pagination page index.
Pages are zero indexed,
i.e. the first page has an index value of zero.
required: false
schema:
type: integer
description: >-
Specifies the pagination page index.
Pages are zero indexed,
i.e. the first page has an index value of zero.
format: int32
- name: pageSize
in: query
description: >-
Specifies the number of items to include on a page.
Must be
specified if pageIndex has been specified.
required: false
schema:
type: integer
description: >-
Specifies the number of items to include on a page.
Must be
specified if pageIndex has been specified.
format: int32
- 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: true
schema:
type: string
description: >-
The start date and time for the period, in UTC, in the format of
YYYY-MM-DDThh:mm:ss.
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: true
schema:
type: string
description: >-
The end date and time for the period, in UTC, in the format of
YYYY-MM-DDThh:mm:ss.
format: date-time
- name: dateType
in: query
description: Type of date filter
required: false
schema:
type: string
description: Type of date filter
- name: groupId
in: query
description: >-
Identifier of a group. Must be specified if a value for vehicleId
has not been specified.
required: false
schema:
type: string
description: >-
Identifier of a group. Must be specified if a value for vehicleId
has not been specified.
- name: eventFilter
in: query
description: Event type filter
required: false
schema:
type: string
description: Event type filter
- name: vehicleId
in: query
description: >-
Identifier for a vehicle. Must be specified if a value for groupId
has not been specified.
required: false
schema:
type: string
description: >-
Identifier for a vehicle. Must be specified if a value for groupId
has not been specified.
responses:
'200':
description: Successful operation
content:
application/json;charset=UTF-8:
schema:
$ref: >-
#/components/schemas/WithPaginationResultEcoScoreEventResponseDto
'400':
description: Bad input parameters
'404':
description: Resource not found
components:
schemas:
WithPaginationResultEcoScoreEventResponseDto:
type: object
properties:
totalPages:
type: integer
description: Total number of pages based on the pageSize.
format: int32
totalCount:
type: integer
description: Total number of items that matched the search parameters.
format: int64
items:
type: array
description: Array of items.
items:
$ref: '#/components/schemas/EcoScoreEventResponseDto'
EcoScoreEventResponseDto:
type: object
properties:
vehicleRegistration:
type: string
description: Vehicle registration number
vehicleName:
type: string
description: Vehicle name
vehicleId:
type: string
description: Vehicle ID
driverName:
type: string
description: Driver name
driverId:
type: string
description: Driver ID
vehicleGroupName:
type: string
description: Vehicle group name
vehicleGroupId:
type: string
description: Vehicle group ID
driverGroupName:
type: string
description: Driver group name
driverGroupId:
type: string
description: Driver group ID
eventType:
type: string
description: Type of event
eventDate:
type: string
description: Date when the event occurred
format: date-time
createdDate:
type: string
description: Date when the event was created
format: date-time
address:
$ref: '#/components/schemas/Address'
coordinate:
$ref: '#/components/schemas/Coordinate'
eventDurationMs:
type: number
description: Duration of the event in milliseconds
format: double
speedKph:
type: number
description: Speed in kilometers per hour
format: double
maximumRecordedSpeedKph:
type: number
description: Maximum recorded speed in kilometers per hour (for SpeedingEvent)
format: double
rateOfAcceleration:
type: number
description: Rate of acceleration (for HarshAccelerationEvent)
format: double
rateOfLateralAcceleration:
type: number
description: Rate of lateral acceleration (for HarshCorneringEvent)
format: double
rateOfDeceleration:
type: number
description: Rate of deceleration (for HarshBreakingEvent)
format: double
durationInSeconds:
type: number
description: Duration in seconds (for ExcessiveIdlingEvent)
format: double
maximumRecordedRPM:
type: number
description: Maximum recorded RPM (for EngineOverRevvingEvent)
format: double
locationId:
type: string
description: Location ID
locationName:
type: string
description: Location name
locationCategoryId:
type: string
description: Location category ID
locationCategoryName:
type: string
description: Location category name
isAtBaseLocation:
type: boolean
description: Whether the event occurred at base location
idlingFidelity:
type: integer
description: Idling fidelity
format: int32
description: Response DTO for Eco Score events
Address:
type: object
properties:
formattedAddress:
type: string
road:
type: string
roadNumber:
type: string
city:
type: string
postCode:
type: string
country:
type: string
roadSpeedKph:
type: number
format: float
roadType:
type: string
speedLimitType:
type: integer
format: int32
countryIsoCode:
type: string
division:
type: string
subDivision:
type: string
privateRoadMinSpeedLimit:
type: number
format: float
speedLimitUnit:
type: string
enum:
- KPH
- MPH
divisionIsoCode:
type: string
subDivisionIsoCode:
type: string
private:
type: boolean
description: Address where the event occurred
Coordinate:
type: object
properties:
longitude:
type: number
description: Longitude coordinate in decimal degrees.
format: double
example: -1.3421
latitude:
type: number
description: Latitude coordinate in decimal degrees.
format: double
example: 53.8304
description: >-
Geographic coordinate with latitude and longitude values in decimal
degrees.
securitySchemes:
bearerAuth:
type: http
scheme: bearer
````