Data Dictionary

Note: Not all data types are available in sandbox. Production availability depends on equipment capabilities.

Engine & Operating Hours

Data Type	Description	Unit
averageDailyEngineLoadFactor	The percentage calculated as the actual fuel consumed over the previous 24 h period divided by the fuel that would have been consumed during that period if the machine had been continually operated at the engine’s rated output.	percentage
cumulativeActiveRegenerationHours	Time when the machine is placed in a non-productive state to complete the regeneration process	hours
cumulativeIdleHours	Total idle hours since the initial start of the equipment. Definition of Idle hours may vary between data sources. (Also available as a daily value)	hours
cumulativeOperatingHours	Total engine hours since the initial start of the equipment. (Also available as a daily value)	hours
engineCondition	Running state of the engine as of the specified date and time. This data type is Boolean with false (i.e. 0) indicating not running and true (i.e. 1) indicating running.	boolean
engineCoolantTemperature	Current engine coolant temperature	°C
engineLoadPercentage	Current engine load vs maximum capacity	percentage

⚠️ Deprecated: cumulativeUsageHours duplicates cumulativeOperatingHours

Fuel & Energy

Data Type	Description	Unit
cumulativeFuel	Total fuel consumed since the initial start of the equipment. (Also available as a daily value)	L (liters)
cumulativeIdleFuel	Total fuel consumed during idle time since the initial start of the equipment. (Also available as a daily value)	L (liters)
dailyCO2	CO2 emissions for the date	kg
dailyEvEnergyUsed	Daily electrical energy consumption for electric vehicles	kWh (kilowatt-hours)
dailyIdleFuel	Fuel consumed during idle time for the date	L (liters)
defRemainingRatio	Diesel exhaust fluid remaining in the tank, also called AUS32 or AdBlue	percentage
evBatteryChargeCyclesCount	Total number of charge cycles the battery has undergone	count
evBatteryCurrent	Current flowing in or out of the battery	A (amperes)
evBatteryHealth	Electric vehicle battery condition	percentage
evBatteryLevel	Electric vehicle battery charge remaining	percentage
evBatteryTemperature	Current temperature of the battery pack	°C
evBatteryVoltage	Current voltage of the battery pack	V (volts)
evChargingState	Current charging status of the electric vehicle (not_charging	charging
evEnergyCharged	Total electrical energy charged into the battery	Wh (watt-hours)
evEnergyUsed	Total electrical energy consumption	Wh (watt-hours)
fuelRemaining	Current fuel level in tank	percentage

Movement & Location

Data Type	Description	Unit
cumulativeDistance	Total kilometers since the initial start of the equipment. (Also available as a daily value)	km
dailyDistance	Distance traveled for the date	km
peakDailySpeed	Maximum speed recorded on date	km/h
positions	GPS location with additional context when available	{date,latitude,longitude,altitude,speed,heading}

Work Metrics

Data Type	Description	Unit
activities	Activity is a complex kind mixing a dateStart, dateEnd, distance traveled, average speed and address of the first and last position	array<{dateStart, dateStop, distanceMeters, averageSpeedKmH, firstPositionAddress, lastPositionAddress}>
cumulativeLoadCount	The total number of load cycles performed. The precise definition of load depends on the OEM. (Also available as a daily value)	count
cumulativePayloadTotal	Total payload lifted, hauled, or processed. (Also available as a daily value)	tons
cumulativePowerTakeOffHours	Time the power take-off was driving an implement such as a mower or sprayer. (Also available as a daily value)	hours
dailyLoadCount	Number of load cycles performed for the date	count
dailyPayload	Payload lifted, hauled, or processed for the date	tons
dailyUsages	Comprehensive daily usage data including operating hours, idle hours	object

System & Diagnostics

Data Type	Description	Unit
batteryLevel	The percentage of remaining battery of the asset	percentage
batteryVoltage	The measured voltage of the battery of the asset	V (volts)
deviceBatteryLevel	The percentage of remaining battery of the telematics device	percentage
deviceBatteryVoltage	The measured voltage of the battery of the telematics device	V (volts)
faults	Also called Diagnostic Trouble Codes (DTC). Fault codes are an indicator of components operating out of tolerance or failure. They are composed of a date, a short identifier, a description for more information and a level of severity (severity is a number between -1 and 3, levelLabel is the human readable from unknown to critical)	array<{date,description,identifier,severity,levelLabel}>
sensorBoolean	General boolean sensor readings	boolean
temperature	General temperature sensor readings	°C