The Idle Times Report endpoint returns the "various VEHICLE IDLE times (in seconds)" for Devices available on your account.
If the optional 'IdleTimeSeconds' parameter is NOT provided, all idle times are returned. If 'IdleTimeSeconds' is provided, then only idle times GREATER than that value will be returned.
IMPORTANT NOTE: IF either of the return values 'WasIdleAtStartTime' or 'WasIdleAtEndTime' come back as true, the idle times MAY show as less than the IdleTimeSeconds minimum passed in (because these are partial values based on Start or End times, not the entire idle time which could have more idling BEFORE or AFTER the TO/FROM window passed in).
This is specialized endpoint for specific reporting purposes. IF you have any questions, please reach out to: Devs@usft.com.
The following datatype will be JSONified and returned for methods which retrieve values. (NOTE: if param FOBBased = true, three more fields return: Driver, EIN, FOB#)
| public | UInt64 | AccountId; | // The AccountId associated with the Device |
| public | UInt64 | DeviceId; | // The DeviceId (Serial#) associated with the Device |
| public | String | DeviceName; | // The Device Name matched with the DeviceID |
| public | DateTime | StartTime; | // The time the Device STARTED IDLING |
| public | UInt64 | TotalIdleSeconds; | // The total SECONDS of IDLE TIME (time determined on parameters: by TIME or IGNITION). |
| public | Double | Latitude; | // The LATITUDE reading where IDLE event occurred |
| public | Double | Longitude; | // The LONGITUIDE reading where IDLE event occurred |
| public | Boolean | WasIdleAtStartTime; | // Boolean showing if Vehicle was already idling at START TIME of this API Request |
| public | Boolean | WasIdleAtEndTime; | // Boolean showing if Vehicle was still idling at END TIME of this API Request |
The following list provides a reference for all valid /IdleTimesReport HTTP requests.
Summary: Retrieve a report that is run immediately and returned as soon as possible. These reports are typically limited to a small range or timespan (24 hours or less).
Returns:
Parameters:
- id: The AccountId associated with API caller (FromUri)
- from: The DateTime to begin report. If no FROM/TO dates passed in, default is last 24 hours. (FromUri)
- to: The DateTime to end report. If no FROM/TO dates passed in, default is last 24 hours. (FromUri)
- devices: A comma-separated list of DeviceIds to lookup for a report. If not specified, reports will run for all devices visible to the account. (FromUri)
- UTCoffset: (Optional) UTC offset to return results in. Default is CENTRAL TIME. (see https://24timezones.com/time-zones for example strings: "UTC-6" for minus 6 or "UTC%2b6" for plus 6) (FromUri)
- IdleTimeInSeconds: (Optional) If this parameter is left out/null, all idle times will be reported (IDLE EVENT is when IGNITION=On and Velocity = 0). If specified, idle times will only show if they're greater duration than this parameter (in seconds). (FromUri)
- account: (Optional) If this parameter is included, the method will be run on behalf of the specified child Account (if valid). (FromUri)
- fobBased: (Optional) If this bool parameter is set to TRUE, the method will return some additional result elements: Driver, Driver EIN and FOB. This option is for FOB drivers only. (FromUri)
- showZoneNames: (Optional) If this bool parameter is set to TRUE, any idle records will check if within any Geofence/Zone areas and return comma-delimited zone names (or blank, if none). (FromUri)