GET api/summary/ecoTrak/{asset}/{startDate}/{endDate}/{requiredFields}/{groupByFields}

View summary data containing EcoTrak fields for one or more assets for a given date range.

Request Information

URI Parameters

NameDescriptionTypeAdditional 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 in the format of yyyy-MM-dd HH:mm:ss.

 date

Required
endDate

Specifies the date that summary data should end at in the format of yyyy-MM-dd HH:mm:ss.

 date

Required
requiredFields

A CSV of field names which specifies which fields should be returned, if not specified then all available fields are returned; passing "all" will exhibit the same behaviour.

 string

None.
groupByFields

A CSV of field names which specifies which aggregation fields to group by, if not specified then no grouping is assumed; passing "all" will exhibit the same behaviour. Available fields (DailySummaryId, VehicleId, AssetName, Date, DriverId, DriverCallsign)

 string

None.

Body Parameters

None.

Response Information

Resource Description

Collection of SummaryEcoTrakRecord
NameDescriptionTypeAdditional information
StartTime

Time that the first ignition on ping was received

 date

None.
EndTime

Time that the last ignition on ping was received

 date

None.
ParkedTime

Time in between StartTime and EndTime when the ignition is off

 integer

None.
RunningTime

Total seconds that the ignition has been on. If CANBus data is available, RPM is also checked to be > 0. This is done to (where available) disclude time that the vehicle spends in accessory mode.

 integer

None.
IdleTime

Running time spent stationary and not using PTO for a contiguous period of time in excess of the IdleThreshold assigned to that vehicle.

 integer

None.
PTOEngagedTime

Running time spent stationary that a PTO signal has been broadcast on the CANBus for

 integer

None.
PTORPMTime

Running time spent stationary that the engine's RPM registers as between the minimum PTO RPM and maximum PTO RPM assigned to that vehicle. This is sometimes used over PTOEngagedTime as some vehicle models are known to broadcast a spurious CAN signal

 integer

None.
PTOInputTime

Running time spent stationary that a binary sensor fitted to the vehicle and configured in SupaTrak as PTO reads positive. These are often used if it is not feasible to read data from the CANBus or if full waste body integration is not feasible.

 integer

None.
PTOOverRevvingTime

Time when PTO is active (precedence across the previous three properties is taken in reverse order, i.e. PTOInputTime first, PTOEngagedTime last). This is not done because PTOEngaged time is the least accurate (often it is the most preferable), but because if the installation on the vehicle is using one of the other two methods then it is likely that data from the CANBus may be unreliable.

 integer

None.
PTOMovingTime

Time when PTO is active (precedence across the previous three properties is taken in reverse order, i.e. PTOInputTime first, PTOEngagedTime last). This is not done because PTOEngaged time is the least accurate (often it is the most preferable), but the vehicle is not stationary (unlike all other forms of PTO time.

 integer

None.
DrivingTime

Running time when the vehicle is not idling or using PTO.

 integer

None.
CruiseControlTime

Driving time when the CANBus is broadcasting a cruise control signal.

 integer

None.
OptimumDrivingTime

Driving time when the vehicle's engine RPM value registers as between a MinOptimumRPM and MaxOptimumRPM value assigned to the vehicle.

 integer

None.
OverRevvingTime

Driving time when the engine's RPM exceeds a threshold value assigned to the vehicle.

 integer

None.
VehicleSpeedingTime

Driving time when the vehicle's speed exceeds (depending on account-level configuration) either a threshold set against the vehicle or the signposted road speed; a multiplicative and static offset can be applied to this (e.g. SpeedLimit * 1.1 + 2), but this is rarely utilised.

 integer

None.
ExcessiveThrottleTime

Driving time when the throttle position exceeds a threshold value assigned to the vehicle.

 integer

None.
HarshAccelerationTime

Driving time when acceleration g-force exceeds a threshold value assigned to the vehicle.

 integer

None.
HarshBrakingTime

Driving time when braking g-force exceeds a threshold value assigned to the vehicle.

 integer

None.
HarshCorneringTime

Driving time when cornering g-force exceeds a threshold value assigned to the vehicle.

 integer

None.
ExcessiveEngineLoadTime

Driving time when engine load exceeds a threshold value assigned to the vehicle.

 integer

None.
CoastingTime

Driving time when the throttle position is less than 1%, cruise control is off and the vehicle is moving at > 1 MPH for a contiguous number of seconds (default: 3 seconds) assigned to the vehicle.

 integer

None.
OutOfHoursTime

Driving time outside of working hours time range assigned to the driver.

 integer

None.
CrashLogTime

Driving time when the vehicle has reported a CrashLog, a high negative z-axis gforce event (default 1.2g).

 integer

None.
AverageSpeed

Average speed in MPH for this record - CANBus wheel speed is used where available with GPS speed as a fallback.

 decimal number

None.
MaxSpeed

Maximum speed in MPH for this record - CANBus wheel speed is used where available with GPS speed as a fallback.

 decimal number

None.
GPSDistance

Total distance for this record as measured by GPS. Second-level interpolation is used where available, otherwise point to point distance between device messages is used.

 decimal number

None.
OdometerStartValue

First odometer value recieved for this record.

 decimal number

None.
OdometerEndValue

Last odometer value recieved for this record.

 decimal number

None.
OdometerDistance

Total distance for this record according to the vehicle's odometer.

 decimal number

None.
FuelUsed

Total volume of fuel to have passed through the vehicle's injectors for this record.

 decimal number

None.
CarbonOutput

Total carbon output for this record - calculated by FuelUsed * CarbonCoefficient. Coefficient values come from DEFRA annually.

 decimal number

None.
AverageEngineLoad

Measurement of the average engine load for this record.

 decimal number

None.
BrakingApplications

Count of the number of times that the vehicle's brake has been applied for this record.

 integer

None.
TargetMpg

Target MPG assigned to the vehicle

 decimal number

None.
CombinedEedi

integer

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: 
[
  {
    "StartTime": "2025-04-29T19:04:01.1224842+01:00",
    "EndTime": "2025-04-29T19:04:01.1224842+01:00",
    "ParkedTime": 1,
    "RunningTime": 1,
    "IdleTime": 1,
    "PTOEngagedTime": 1,
    "PTORPMTime": 1,
    "PTOInputTime": 1,
    "PTOOverRevvingTime": 1,
    "PTOMovingTime": 1,
    "DrivingTime": 1,
    "CruiseControlTime": 1,
    "OptimumDrivingTime": 1,
    "OverRevvingTime": 1,
    "VehicleSpeedingTime": 1,
    "ExcessiveThrottleTime": 1,
    "HarshAccelerationTime": 1,
    "HarshBrakingTime": 1,
    "HarshCorneringTime": 1,
    "ExcessiveEngineLoadTime": 1,
    "CoastingTime": 1,
    "OutOfHoursTime": 1,
    "CrashLogTime": 1,
    "AverageSpeed": 1.1,
    "MaxSpeed": 1.1,
    "GPSDistance": 1.1,
    "OdometerStartValue": 1.1,
    "OdometerEndValue": 1.1,
    "OdometerDistance": 1.1,
    "FuelUsed": 1.1,
    "CarbonOutput": 1.1,
    "AverageEngineLoad": 1.1,
    "BrakingApplications": 1,
    "TargetMpg": 1.1,
    "CombinedEedi": 1,
    "DailySummaryId": 1,
    "VehicleId": 2,
    "Date": "2025-04-29T19:04:01.1275651+01:00",
    "AssetName": "sample string 3",
    "DriverId": 5,
    "DriverCallsign": "sample string 6"
  },
  {
    "StartTime": "2025-04-29T19:04:01.1224842+01:00",
    "EndTime": "2025-04-29T19:04:01.1224842+01:00",
    "ParkedTime": 1,
    "RunningTime": 1,
    "IdleTime": 1,
    "PTOEngagedTime": 1,
    "PTORPMTime": 1,
    "PTOInputTime": 1,
    "PTOOverRevvingTime": 1,
    "PTOMovingTime": 1,
    "DrivingTime": 1,
    "CruiseControlTime": 1,
    "OptimumDrivingTime": 1,
    "OverRevvingTime": 1,
    "VehicleSpeedingTime": 1,
    "ExcessiveThrottleTime": 1,
    "HarshAccelerationTime": 1,
    "HarshBrakingTime": 1,
    "HarshCorneringTime": 1,
    "ExcessiveEngineLoadTime": 1,
    "CoastingTime": 1,
    "OutOfHoursTime": 1,
    "CrashLogTime": 1,
    "AverageSpeed": 1.1,
    "MaxSpeed": 1.1,
    "GPSDistance": 1.1,
    "OdometerStartValue": 1.1,
    "OdometerEndValue": 1.1,
    "OdometerDistance": 1.1,
    "FuelUsed": 1.1,
    "CarbonOutput": 1.1,
    "AverageEngineLoad": 1.1,
    "BrakingApplications": 1,
    "TargetMpg": 1.1,
    "CombinedEedi": 1,
    "DailySummaryId": 1,
    "VehicleId": 2,
    "Date": "2025-04-29T19:04:01.1275651+01:00",
    "AssetName": "sample string 3",
    "DriverId": 5,
    "DriverCallsign": "sample string 6"
  }
]

application/xml, text/xml

Sample: 
<ArrayOfSummaryEcoTrakRecord xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <SummaryEcoTrakRecord>
    <DailySummaryId>1</DailySummaryId>
    <VehicleId>2</VehicleId>
    <AssetName>sample string 3</AssetName>
    <Date>2025-04-29T19:04:01.1275651+01:00</Date>
    <DriverId>5</DriverId>
    <DriverCallsign>sample string 6</DriverCallsign>
    <StartTime>2025-04-29T19:04:01.1224842+01:00</StartTime>
    <EndTime>2025-04-29T19:04:01.1224842+01:00</EndTime>
    <ParkedTime>1</ParkedTime>
    <RunningTime>1</RunningTime>
    <IdleTime>1</IdleTime>
    <PTOEngagedTime>1</PTOEngagedTime>
    <PTORPMTime>1</PTORPMTime>
    <PTOInputTime>1</PTOInputTime>
    <PTOOverRevvingTime>1</PTOOverRevvingTime>
    <PTOMovingTime>1</PTOMovingTime>
    <DrivingTime>1</DrivingTime>
    <CruiseControlTime>1</CruiseControlTime>
    <OptimumDrivingTime>1</OptimumDrivingTime>
    <OverRevvingTime>1</OverRevvingTime>
    <VehicleSpeedingTime>1</VehicleSpeedingTime>
    <ExcessiveThrottleTime>1</ExcessiveThrottleTime>
    <HarshAccelerationTime>1</HarshAccelerationTime>
    <HarshBrakingTime>1</HarshBrakingTime>
    <HarshCorneringTime>1</HarshCorneringTime>
    <ExcessiveEngineLoadTime>1</ExcessiveEngineLoadTime>
    <CoastingTime>1</CoastingTime>
    <OutOfHoursTime>1</OutOfHoursTime>
    <CrashLogTime>1</CrashLogTime>
    <AverageSpeed>1.1</AverageSpeed>
    <MaxSpeed>1.1</MaxSpeed>
    <GPSDistance>1.1</GPSDistance>
    <OdometerStartValue>1.1</OdometerStartValue>
    <OdometerEndValue>1.1</OdometerEndValue>
    <OdometerDistance>1.1</OdometerDistance>
    <FuelUsed>1.1</FuelUsed>
    <CarbonOutput>1.1</CarbonOutput>
    <AverageEngineLoad>1.1</AverageEngineLoad>
    <BrakingApplications>1</BrakingApplications>
    <TargetMpg>1.1</TargetMpg>
    <CombinedEedi>1</CombinedEedi>
  </SummaryEcoTrakRecord>
  <SummaryEcoTrakRecord>
    <DailySummaryId>1</DailySummaryId>
    <VehicleId>2</VehicleId>
    <AssetName>sample string 3</AssetName>
    <Date>2025-04-29T19:04:01.1275651+01:00</Date>
    <DriverId>5</DriverId>
    <DriverCallsign>sample string 6</DriverCallsign>
    <StartTime>2025-04-29T19:04:01.1224842+01:00</StartTime>
    <EndTime>2025-04-29T19:04:01.1224842+01:00</EndTime>
    <ParkedTime>1</ParkedTime>
    <RunningTime>1</RunningTime>
    <IdleTime>1</IdleTime>
    <PTOEngagedTime>1</PTOEngagedTime>
    <PTORPMTime>1</PTORPMTime>
    <PTOInputTime>1</PTOInputTime>
    <PTOOverRevvingTime>1</PTOOverRevvingTime>
    <PTOMovingTime>1</PTOMovingTime>
    <DrivingTime>1</DrivingTime>
    <CruiseControlTime>1</CruiseControlTime>
    <OptimumDrivingTime>1</OptimumDrivingTime>
    <OverRevvingTime>1</OverRevvingTime>
    <VehicleSpeedingTime>1</VehicleSpeedingTime>
    <ExcessiveThrottleTime>1</ExcessiveThrottleTime>
    <HarshAccelerationTime>1</HarshAccelerationTime>
    <HarshBrakingTime>1</HarshBrakingTime>
    <HarshCorneringTime>1</HarshCorneringTime>
    <ExcessiveEngineLoadTime>1</ExcessiveEngineLoadTime>
    <CoastingTime>1</CoastingTime>
    <OutOfHoursTime>1</OutOfHoursTime>
    <CrashLogTime>1</CrashLogTime>
    <AverageSpeed>1.1</AverageSpeed>
    <MaxSpeed>1.1</MaxSpeed>
    <GPSDistance>1.1</GPSDistance>
    <OdometerStartValue>1.1</OdometerStartValue>
    <OdometerEndValue>1.1</OdometerEndValue>
    <OdometerDistance>1.1</OdometerDistance>
    <FuelUsed>1.1</FuelUsed>
    <CarbonOutput>1.1</CarbonOutput>
    <AverageEngineLoad>1.1</AverageEngineLoad>
    <BrakingApplications>1</BrakingApplications>
    <TargetMpg>1.1</TargetMpg>
    <CombinedEedi>1</CombinedEedi>
  </SummaryEcoTrakRecord>
</ArrayOfSummaryEcoTrakRecord>