> ## 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 Journey History
> Returns the journey tracking history for a vehicle for each journey that started in the specified period. No details are returned for a private journey. 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.
vehicleId must be specified and only journeys for the specified vehicle are included in the output.
If there are more than 50 tracking events that match the search criteria, then by default only the first 50 tracking events are returned. To view details of the other events 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}/tracking/history/vehicle
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}/tracking/history/vehicle:
get:
tags:
- /tracking/history
summary: Vehicle Journey History
description: >-
Returns the journey tracking history for a vehicle for each journey that
started in the specified period. No details are returned for a private
journey. 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.
vehicleId must be specified and only
journeys for the specified vehicle are included in the
output.
If there are more than 50 tracking events that match
the search criteria, then by default only the first 50 tracking events
are returned. To view details of the other events you will need to
specify values for pageSize and pageIndex.
operationId: getEventHistoryByVehicle
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 tracking history 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 tracking history 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 tracking history 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 tracking history search period. Format:
yyyy-MM-dd'T'HH:mm:ss in UTC. Required.
format: date-time
- name: dateType
in: query
description: Type of date to use for filtering tracking events
required: false
schema:
type: string
description: Type of date to use for filtering tracking events
- name: vehicleId
in: query
description: Unique identifier of the vehicle to retrieve tracking history for
required: true
schema:
type: string
description: Unique identifier of the vehicle to retrieve tracking history for
responses:
'200':
description: Successful operation
content:
application/json;charset=UTF-8:
schema:
$ref: >-
#/components/schemas/WithPaginationResultTrackingHistoryResultDto
'400':
description: Invalid request parameters or validation errors.
'404':
description: Vehicle not found.
components:
schemas:
WithPaginationResultTrackingHistoryResultDto:
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/TrackingHistoryResultDto'
TrackingHistoryResultDto:
type: object
properties:
eventDate:
type: string
description: >-
Date and time of the tracking event. Format: yyyy-MM-dd'T'HH:mm:ss
in UTC.
format: date-time
vehicleId:
type: string
description: Unique identifier of the vehicle
vehicleRegistration:
type: string
description: Registration number of the vehicle
vehicleName:
type: string
description: Name of the vehicle
vehicleGroupName:
type: string
description: Name of the vehicle's group
driverId:
type: string
description: Unique identifier of the driver
driverName:
type: string
description: Name of the driver
driverGroupName:
type: string
description: Name of the driver's group
eventStatus:
type: string
description: Status of the tracking event
longitude:
type: number
description: Longitude coordinate of the vehicle location
format: double
latitude:
type: number
description: Latitude coordinate of the vehicle location
format: double
formattedAddress:
type: string
description: Formatted address of the vehicle location
locationId:
type: string
description: Unique identifier of the location
locationName:
type: string
description: Name of the location
locationCategory:
type: string
description: Category of the location
speed:
type: number
description: Vehicle speed in kilometers per hour
format: double
heading:
type: number
description: Vehicle heading in degrees
format: double
inputId:
type: string
description: Unique identifier of the input device
inputLabel:
type: string
description: Label of the input device
inputState:
type: string
description: State of the input device
customInputLabel:
type: string
description: Custom label of the input device
customInputState:
type: string
description: Custom state of the input device
cumulativeRuntime:
type: integer
description: Cumulative runtime of the vehicle in seconds
format: int64
cumulativeRuntimeType:
type: string
description: Type of cumulative runtime measurement
enum:
- CAN
- ESTIMATED
cumulativeIdleTime:
type: integer
description: Cumulative idle time of the vehicle in seconds
format: int64
cumulativePtoTime:
type: integer
description: Cumulative PTO (Power Take-Off) time of the vehicle in seconds
format: int64
cumulativeDistance:
type: number
description: Cumulative distance traveled by the vehicle in kilometers
format: double
cumulativeFuelUsage:
type: number
description: Cumulative fuel usage by the vehicle
format: double
fuelLevelPercentage:
type: number
description: Fuel level as a percentage
format: float
fuelLevelLitres:
type: number
description: Fuel level in litres
format: float
electricRangeKm:
type: number
description: Electric vehicle range in kilometers
format: float
electricRangeKmEstimated:
type: boolean
description: Whether the electric range is estimated
electricBatteryLevelPercent:
type: number
description: Electric vehicle battery level as a percentage
format: float
electricBatteryLevelPercentEstimated:
type: boolean
description: Whether the electric battery level is estimated
createdDate:
type: string
description: Date when the record was created
format: date-time
distanceKms:
type: number
description: Distance traveled in kilometers for this event
format: double
description: >-
Vehicle tracking history information containing location, status, and
vehicle/driver details
securitySchemes:
bearerAuth:
type: http
scheme: bearer
````