GET api/summary/sweeper/{asset}/{startDate}/{endDate}?requiredFields={requiredFields}&groupByFields={groupByFields}
View summary data containing fields concerning usage types and times, fuel consumption and more for one or all sweepers for a given date range.
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| asset |
Specifies that summary data is only required for a specific asset, all assets will be returned if a user passes "all" no quotes. |
string |
Required |
| startDate |
Specifies the date that summary data should start from. |
date |
Required |
| endDate |
Specifies the date that summary data should end at. |
date |
Required |
| requiredFields |
Specifies which fields should be returned |
string |
Default value is |
| groupByFields |
Specifies which aggregation fields to group by (VehicleId/AssetName/Date/DriverId/DriverCallsign), if not specified then no grouping is assumed |
string |
Default value is |
Body Parameters
None.
Response Information
Resource Description
Collection of SummarySweeperDailyRecord| Name | Description | Type | Additional information |
|---|---|---|---|
| TotalTime |
A measure of the total time for this vehicle/driver/day that telemetry was collected from the asset in seconds. |
integer |
None. |
| IgnitionAuxEngineTime |
A measure of the time for this vehicle/driver/day that the aux engine was ignitioned on in seconds. |
integer |
None. |
| ParkedTime |
A measure of the time for this vehicle/driver/day that the aux engine was ignitioned on in seconds. |
integer |
None. |
| IdleTime |
A measure of the time for this vehicle/driver/day that the ignition was on, but the vehicle was stationary for a contiguous period of time greater than the Idle Alert Threshold set against the asset on the SupaTrak portal. |
integer |
None. |
| TransitTime |
A measure of the time for this vehicle/driver/day that the ignition was on, but the sweeper was not sweeping. |
integer |
None. |
| BrushRPMTime |
A measure of the time for this vehicle/driver/day that the asset reported a brush RPM value greater than zero |
integer |
None. |
| NozzleDownTime |
A measure of the time for this vehicle/driver/day that the asset reported either Nozzle1 or Nozzle2 as being down |
integer |
None. |
| WorkModeSelectedTime |
A measure of the time for this vehicle/driver/day that the asset reported work mode as being selected |
integer |
None. |
| SweepingTime |
A measure of the time for this vehicle/driver/day that the asset reported either work mode as being selected (if available) and the ignition being on or (if work mode is unavailable) either nozzle being down and the ignition being on. |
integer |
None. |
| EngineHours |
A measure of the time for this vehicle/driver/day of the maximum Engine Hours reading received minus the minimum Engine Hours reading received. |
decimal number |
None. |
| EngineHoursWorkMode |
A measure of the time for this vehicle/driver/day of the maximum Engine Hours reading received whilst work mode is selected minus the minimum Engine Hours reading received whilst work mode is selected. |
decimal number |
None. |
| TotalDistance |
A measure of the total distance by GPS for this vehicle/driver/day that the asset has travelled this is expressed in either miles or kilometers depending on the user's Distance Unit setting on the SupaTrak portal. |
decimal number |
None. |
| TotalDistanceWorkMode |
A measure of the total distance by GPS for this vehicle/driver/day that the asset has travelled whilst work mode is selected this is expressed in either miles or kilometers depending on the user's Distance Unit setting on the SupaTrak portal. |
decimal number |
None. |
| TotalDistanceSweeping |
A measure of the total distance by GPS for this vehicle/driver/day that the asset has travelled whilst sweeping this is expressed in either miles or kilometers depending on the user's Distance Unit setting on the SupaTrak portal. |
decimal number |
None. |
| AvgSpeed |
A measure of the aforelisted TotalDistance field divided by the aforelisted EngineHours field. |
decimal number |
None. |
| AvgSpeedWorkMode |
A measure of the aforelisted TotalDistanceWorkMode field divided by the aforelisted EngineHoursWorkMode field. |
decimal number |
None. |
| HoursTillNextService |
A measure of the minimum Hours Till Next Service reading from the asset for this asset/driver/day. |
decimal number |
None. |
| MinRPMAuxEngine |
A measure of the minimum RPM value recorded from the asset for this asset/driver/day. |
integer |
None. |
| MaxRPMAuxEngine |
A measure of the maximum RPM value recorded from the asset for this asset/driver/day. |
integer |
None. |
| AvgRPMAuxEngine |
A measure of the average (mean) RPM value recorded from the asset for this asset/driver/day. |
integer |
None. |
| FuelUsedAuxEngine |
A measure of the total fuel consumed (in litres) by the asset for this asset/driver/day. |
decimal number |
None. |
| FuelUsedAuxEngineWorkMode |
A measure of the total fuel consumed (in litres) by the asset for this asset/driver/day whilst work mode is selected. |
decimal number |
None. |
| DailySummaryId |
Unique integer key for the record. Please note that if a user needs to work with multiple accounts, these will be unique only by account only, not globally. |
integer |
None. |
| VehicleId |
A unique ID representing a vehicle. |
integer |
None. |
| AssetName |
The Asset Name visible on the SupaTrak portal of the asset from which the data on the record was collected. |
string |
None. |
| Date |
The date that for the data on the record was collected. Though a time component is held, it will always have a value of zero. |
date |
None. |
| DriverId |
A unique ID representing a driver. |
integer |
None. |
| DriverCallsign |
The driver identified as using the asset for the date aforelisted. This field will be string.Empty if DriverID has not been used (Keyfob, Tacho card, etc) and if multiple drivers are detected using an asset on one given day there will be one record per driver. |
string |
None. |
Response Formats
application/json, text/json
Sample not available.