> ## 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.
# Driver Utilisation Hours
> Returns summary utilisation information for a driver for all journeys where the journey started in the specified period.
The end date of the journey does not have to be within the period. If the vehicle driven by the driver has been configured for a PTO, then driving and idling time with PTO active and with PTO inactive are included in the response. Details for private journeys that started in the period are included in the utilisation values.
If driverId or groupId is not specified, then details for all drivers are returned. If groupId is specified, then the utilisation for all drivers in the specified group are included in the output. Either driverId or groupId can be specified as an input parameter, an error is returned if both are specified.
## OpenAPI
````yaml https://api.connectedfleet.michelin.com/performance/api-docs get /public/v1/customer/{customerId}/utilisation/driver
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}/utilisation/driver:
get:
tags:
- /utilisation
summary: Driver Utilisation Hours
description: >-
Returns summary utilisation information for a driver for all journeys
where the journey started in the specified period.
The end date
of the journey does not have to be within the period. If the vehicle
driven by the driver has been configured for a PTO, then driving and
idling time with PTO active and with PTO inactive are included in the
response. Details for private journeys that started in the period are
included in the utilisation values.
If driverId or groupId is
not specified, then details for all drivers are returned. If groupId is
specified, then the utilisation for all drivers in the specified group
are included in the output. Either driverId or groupId can be specified
as an input parameter, an error is returned if both are specified.
operationId: getDriverUtilisation
parameters:
- name: customerId
in: path
required: true
schema:
type: string
- name: startDate
in: query
description: >-
Start date and time for the utilisation period in UTC (ISO 8601
format)
required: true
schema:
type: string
description: >-
Start date and time for the utilisation period in UTC (ISO 8601
format)
format: date-time
- name: endDate
in: query
description: >-
End date and time for the utilisation period in UTC (ISO 8601
format)
required: true
schema:
type: string
description: >-
End date and time for the utilisation period in UTC (ISO 8601
format)
format: date-time
- name: driverId
in: query
description: >-
Unique identifier of the driver to retrieve utilisation data for.
Mutually exclusive with groupId.
required: false
schema:
type: string
description: >-
Unique identifier of the driver to retrieve utilisation data for.
Mutually exclusive with groupId.
- name: groupId
in: query
description: >-
Unique identifier of the group to retrieve utilisation data for all
drivers in the group. Mutually exclusive with driverId.
required: false
schema:
type: string
description: >-
Unique identifier of the group to retrieve utilisation data for
all drivers in the group. Mutually exclusive with driverId.
responses:
'200':
description: Driver utilisation data successfully returned
content:
application/json;charset=UTF-8:
schema:
$ref: '#/components/schemas/UtilisationDriverResultDto'
'400':
description: >-
When both driverId and groupId are specified, or when filtering
field contains id of resource which is not visible to user
content:
application/json;charset=UTF-8:
schema:
$ref: '#/components/schemas/ApiErrorDto'
'404':
description: No utilisation data found for the specified criteria
components:
schemas:
UtilisationDriverResultDto:
type: object
properties:
utilisations:
type: array
description: >-
List of individual driver utilisation records with detailed hours
and activity data
items:
$ref: '#/components/schemas/UtilisationDriverDto'
averageStartTime:
type: string
description: >-
Calculated average start time across all driver utilisations in
HH:mm format
example: '14:55:22'
averageEndTime:
type: string
description: >-
Calculated average end time across all driver utilisations in HH:mm
format
example: '15:17:06'
description: >-
Response containing driver utilisation hours data including individual
utilisation records and calculated average start/end times
ApiErrorDto:
type: object
properties:
errorCode:
type: integer
format: int32
errorMessage:
type: string
offendingFields:
type: array
items:
type: string
UtilisationDriverDto:
type: object
properties:
driverId:
type: string
description: Unique identifier of the driver
driverName:
type: string
description: Full name of the driver
groupName:
type: string
description: Name of the group the driver belongs to
utilisation:
type: array
description: >-
List of utilisation periods for the driver with detailed hours and
activity data
items:
$ref: '#/components/schemas/UtilisationDto'
description: >-
Individual driver utilisation record containing driver details and list
of utilisation periods
UtilisationDto:
type: object
properties:
firstStart:
type: string
description: >-
Date and time of the first journey start (ignition on), in UTC, in
format of YYYY-MM-DDThh:mm:ss.
format: date-time
lastStop:
type: string
description: >-
Date and time of the last journey end (ignition off), in UTC, in
format of YYYY-MM-DDThh:mm:ss.
format: date-time
totalTime:
type: integer
description: Sum of (driveTime + IdleTime + idleTimeWithPto) (in seconds).
format: int64
driveTime:
type: integer
description: Sum of (driveTimeWithPto + driveTimeWithoutPto) (in seconds).
format: int64
driveTimeWithPto:
type: integer
description: Total time driving with PTO active (in seconds).
format: int64
driveTimeWithoutPto:
type: integer
description: Total time driving with PTO inactive (in seconds).
format: int64
idleTime:
type: integer
description: Total time idling with PTO inactive (in seconds).
format: int64
idleTimeWithPto:
type: integer
description: Total time idling with PTO active (in seconds).
format: int64
stopTime:
type: integer
description: Total time stopped (in seconds).
format: int64
countOfStopTime:
type: integer
description: Number of stops for all journeys.
format: int32
description: >-
Detailed utilisation period data containing timestamps and various time
measurements for vehicle/driver activity analysis
securitySchemes:
bearerAuth:
type: http
scheme: bearer
````