Skip to main content
GET
Vehicle Idling

Authorizations

Authorization
string
header
required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Path Parameters

customerId
string
required

Query Parameters

pageIndex
integer<int32>

Specifies the pagination page index.
Pages are zero indexed, i.e. the first page has an index value of zero.

pageSize
integer<int32>

Specifies the number of items to include on a page.
Must be specified if pageIndex has been specified.

startDate
string<date-time>
required

Start date and time for the search period. Format: yyyy-MM-dd'T'HH:mm:ss in UTC. Required.

endDate
string<date-time>
required

End date and time for the search period. Format: yyyy-MM-dd'T'HH:mm:ss in UTC. Required and must be within 7 days of startDate.

groupId
string

Group identifier for searching idling episodes by group. Required if not using specific entity ID.

excludeChildGroups
boolean

Whether to exclude child groups from the search. Defaults to false.

idlingDurationSeconds
integer<int64>

Minimum idling duration in seconds for filtering. Must be >= 1 if specified.

vehicleId
string

Vehicle identifier

Response

Successful operation

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.