Skip to main content
GET
Vehicle Utilisation Hours

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

customerId
string
required

Query Parameters

startDate
string<date-time>
required

Start date and time for the utilisation period in UTC format (yyyy-MM-dd'T'HH:mm:ss)

endDate
string<date-time>
required

End date and time for the utilisation period in UTC format (yyyy-MM-dd'T'HH:mm:ss)

vehicleId
string

Unique identifier of the vehicle to retrieve utilisation data for. Must not be used together with groupId

Example:

"vehicle-id"

groupId
string

Unique identifier of the group to retrieve utilisation data for all vehicles in the group. Must not be used together with vehicleId

Example:

"group-id"

Response

Vehicle utilisation data successfully returned

Response containing vehicle utilisation hours data including individual utilisation records and calculated average start/end times

utilisations
object[]

List of individual vehicle utilisation records with detailed hours and activity data

averageStartTime
string

Calculated average start time across all vehicle utilisations in HH:mm format

averageEndTime
string

Calculated average end time across all vehicle utilisations in HH:mm format