> ## 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 Input Usage
> Returns input usage details for each instance when an input on a vehicle was activated on a vehicle driven by the driver in the specified period. The input deactivation does not have to be within the specified period. Details of an input activated during a private journey are not included in the response.
The value specified for the endDate cannot be before startDate and the date range between startDate and endDate cannot be more than 90 days.
A value for driverId must be specified and only inputs activated on a vehicle driven by the specified driver are included in the output.
If there are more than 50 input usage details that match the search criteria, then by default only the first 50 input usage details are returned. To view details of the other input usage details you will need to specify values for pageSize and pageIndex.
## OpenAPI
````yaml https://api.connectedfleet.michelin.com/vehicle-tracking/api-docs get /public/v1/customer/{customerId}/input/usage/driver
openapi: 3.0.1
info:
title: Vehicle Tracking
description: >-
A foundational pack delivering essential “track & trace” capability across
your fleet.
contact:
name: Masternaut
url: https://www.masternaut.com
email: support@masternautconnect.com
version: 124.0.2607160821
servers:
- url: https://api.connectedfleet.michelin.com/vehicle-tracking
description: Product Server
security:
- bearerAuth: []
tags:
- name: /alert
description: Alert history and notification management operations
- name: /input
description: Input usage operations for vehicles and drivers
- name: /journey/detail
description: Journey detail operations with vehicle and driver perspectives
- name: /location
description: Location management operations
- name: /tokenInformation
description: Token operations
- name: /tracking/history
description: Tracking history operations for vehicles and drivers
- name: /tracking/journey
description: Journey tracking and management operations
- name: /tracking/live
description: Live tracking operations
- name: /vehicle
description: Vehicle management operations
paths:
/public/v1/customer/{customerId}/input/usage/driver:
get:
tags:
- /input
summary: Driver Input Usage
description: >-
Returns input usage details for each instance when an input on a vehicle
was activated on a vehicle driven by the driver in the specified period.
The input deactivation does not have to be within the specified period.
Details of an input activated during a private journey are not included
in the response.
The value specified for the endDate cannot be
before startDate and the date range between startDate and endDate cannot
be more than 90 days.
A value for driverId must be specified
and only inputs activated on a vehicle driven by the specified driver
are included in the output.
If there are more than 50 input
usage details that match the search criteria, then by default only the
first 50 input usage details are returned. To view details of the other
input usage details you will need to specify values for pageSize and
pageIndex.
operationId: getInputUsageDriver
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: >-
Start date and time for the search period. Format:
yyyy-MM-dd'T'HH:mm:ss in UTC. Required.
required: true
schema:
type: string
description: >-
Start date and time for the search period. Format:
yyyy-MM-dd'T'HH:mm:ss in UTC. Required.
format: date-time
- name: endDate
in: query
description: >-
End date and time for the search period. Format:
yyyy-MM-dd'T'HH:mm:ss in UTC. Required.
required: true
schema:
type: string
description: >-
End date and time for the search period. Format:
yyyy-MM-dd'T'HH:mm:ss in UTC. Required.
format: date-time
- name: enableSecondaryGroupAssignments
in: query
description: Flag to enable secondary group assignments in the response
required: false
schema:
type: boolean
description: Flag to enable secondary group assignments in the response
- name: driverId
in: query
description: Unique identifier of the driver to retrieve input usage for
required: true
schema:
type: string
description: Unique identifier of the driver to retrieve input usage for
responses:
'200':
description: Successful operation
content:
application/json;charset=UTF-8:
schema:
$ref: '#/components/schemas/WithPaginationResultInputUsageDto'
'400':
description: Missing validation such as driverId, startDate, or endDate.
'404':
description: Driver not found.
components:
schemas:
WithPaginationResultInputUsageDto:
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/InputUsageDto'
InputUsageDto:
type: object
properties:
vehicleRegistration:
type: string
description: Vehicle registration number
vehicleName:
type: string
description: Vehicle display name
vehicleId:
type: string
description: Unique vehicle identifier
driverName:
type: string
description: Name of the driver assigned to the vehicle during the input activity
driverId:
type: string
description: >-
Unique identifier of the driver assigned to the vehicle during the
input activity
vehicleGroupName:
type: string
description: Name of the vehicle's primary group
vehicleGroupId:
type: string
description: Unique identifier of the vehicle's primary group
driverGroupName:
type: string
description: Name of the driver's primary group
driverGroupId:
type: string
description: Unique identifier of the driver's primary group
inputBlock:
$ref: '#/components/schemas/InputBlockDto'
secondaryVehicleGroups:
type: array
description: List of secondary vehicle groups if enabled
items:
$ref: '#/components/schemas/IdNameDto'
secondaryDriverGroups:
type: array
description: List of secondary driver groups if enabled
items:
$ref: '#/components/schemas/IdNameDto'
description: >-
Vehicle input usage information containing details about input activity
blocks for a specific vehicle
InputBlockDto:
type: object
properties:
eventStartDate:
type: string
description: >-
Start date and time of the input activity block. Format:
yyyy-MM-dd'T'HH:mm:ss in UTC.
format: date-time
eventStartLatitude:
type: number
description: Latitude of the event start location
format: double
eventStartLongitude:
type: number
description: Longitude of the event start location
format: double
eventStartFormattedAddress:
type: string
description: Formatted address of the event start location
eventStartLocationName:
type: string
description: Name of the event start location
eventStartLocationGroupName:
type: string
description: Name of the event start location's group
eventStartLocationId:
type: string
description: Unique identifier of the event start location
eventStartLocationGroupId:
type: string
description: Unique identifier of the event start location's group
eventEndDate:
type: string
description: >-
End date and time of the input activity block. Format:
yyyy-MM-dd'T'HH:mm:ss in UTC.
format: date-time
eventEndLatitude:
type: number
description: Latitude of the event end location
format: double
eventEndLongitude:
type: number
description: Longitude of the event end location
format: double
eventEndFormattedAddress:
type: string
description: Formatted address of the event end location
eventEndLocationName:
type: string
description: Name of the event end location
eventEndLocationGroupName:
type: string
description: Name of the event end location's group
eventEndLocationId:
type: string
description: Unique identifier of the event end location
eventEndLocationGroupId:
type: string
description: Unique identifier of the event end location's group
inputLabel:
type: string
description: Label of the input device
inputId:
type: string
description: Unique identifier of the input device
customLabel:
type: string
description: Custom label for the input device
activeStateLabel:
type: string
description: Label for the active state of the input
customActiveStateLabel:
type: string
description: Custom label for the active state of the input
inactiveStateLabel:
type: string
description: Label for the inactive state of the input
customInactiveStateLabel:
type: string
description: Custom label for the inactive state of the input
fuelUsed:
type: number
description: Amount of fuel used during the input activity block
format: double
distanceKms:
type: number
description: Distance traveled in kilometers during the input activity block
format: double
speedKph:
type: number
description: Average speed in kilometers per hour during the input activity block
format: double
durationSeconds:
type: integer
description: Duration of the input activity block in seconds
format: int64
description: >-
Details of an input activity block including start/end times, locations,
and input state information
IdNameDto:
type: object
properties:
id:
type: string
description: Unique identifier of the entity (alphanumeric)
name:
type: string
description: Display name of the entity. Not returned if empty
description: Simple identifier and name pair for groups, vehicles, or other entities.
securitySchemes:
bearerAuth:
type: http
scheme: bearer
````