Skip to main content
GET
Vehicle Journeys

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 of time interval used for filtering. Mandatory and cannot be later then 'endDate'.

endDate
string<date-time>
required

End date of time interval used for filtering. Mandatory and cannot be sooner then 'startDate'.

groupId
string

Id of Group used for filtering. @Visible validation, mandatory if 'id' is not provided, but cannot be both filled

pageIndex
integer<int32>

Number of page, default = 0.

pageSize
integer<int32>

Batches per page, default = 50.

excludeChildGroups
boolean

Exclude child groups, default = FALSE.

vehicleId
string

Id of vehicle used for filtering. @Visible validation, mandatory if 'groupId' is not provided, but cannot be both filled

Response

List for Journeys Details (TimestampedWithPaginationResult) selected by VehicleId or GroupId, and from given Execution time. May be empty list if now Journeys has been found.

Generic wrapper for paginated API responses containing items, pagination metadata, and processing timestamp.

totalPages
integer<int32>

Total number of pages based on the pageSize.

totalCount
integer<int64>

Total number of items that matched the search parameters.

items
object[]

Array of items.

processedDateTime
string<date-time>

Date and time when the request was completed, in UTC, in format of YYYY-MM-DDThh:mm:ss.ms.