Driver Idling
Returns idling details for a vehicle for each idling activity block that started in the specified period.
No details for idling that occurred inside a private journey are returned. The end date of the idling activity block 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.
Either driverId or groupId must be specified. If driverId is specified, then idling activity for the specified driver is included in the output. If groupId is specified, then idling for all drivers in the specified group is included in the output. Either driverId or groupId can be specified as an input parameter, an error is returned if both are specified.
If there are more than 50 idling activity blocks that match the search criteria, then by default only the first 50 idling blocks are returned. To view details of the other idling activity blocks you will need to specify values for pageSize and pageIndex.
Asset Day Limit
The asset day limit on this endpoint is 50 asset days. You will receive an HTTP status code of 400 (Bad input parameters) and no details will be returned if you exceed this restriction.
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
Query Parameters
Specifies the pagination page index.
Pages are zero indexed, i.e. the first page has an index value of zero.
Specifies the number of items to include on a page.
Must be specified if pageIndex has been specified.
Start date and time for the search period. Format: yyyy-MM-dd'T'HH:mm:ss in UTC. 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.
Group identifier for searching idling episodes by group. Required if not using specific entity ID.
Whether to exclude child groups from the search. Defaults to false.
Minimum idling duration in seconds for filtering. Must be >= 1 if specified.
Driver identifier for searching idling episodes by specific driver. Required if not using groupId.
