A filter on the data based on this comma-separated list of parent tag IDs, for use by orgs with tag hierarchies. Specifying a parent tag will implicitly include all descendent tags of the parent tag. Example: parentTagIds=345,678

A filter on the data based on this comma-separated list of tag IDs. Example: tagIds=1234,5678

A filter on the data based on this comma-separated list of vehicle IDs. Example: vehicleIds=1234,5678

The stat types you want this endpoint to return information on. See also the Telematics guide for more details.

You may list up to 3 types using comma-separated format. For example: types=gps,engineStates,obdOdometerMeters.

Note: auxInput3-auxInput10 count as a single type against the limit of 3. For example, you could list types=engineStates,obdOdometerMeters,auxInput3,auxInput4 because auxInput3 and auxInput4 count as a single stat type. auxInput1 and auxInput2 still count as their own individual types.

• ambientAirTemperatureMilliC: The ambient air temperature reading in millidegree Celsius.
• auxInput1-auxInput13: Stat events from the auxiliary inputs for the vehicle.
• barometricPressurePa: The barometric pressure reading in pascals.
• batteryMilliVolts: The vehicle battery voltage reading.
• defLevelMilliPercent: The Diesel Exhaust Fluid (DEF) level in milli percentage points (e.g. 99001, 49999, etc).
• ecuSpeedMph: The speed of the engine in miles per hour according to the ECU.
• engineCoolantTemperatureMilliC: The engine coolant temperature reading in millidegree Celsius.
• engineImmobilizer: The state of the engine immobilizer - Valid values: ignition_disabled, ignition_enabled. This stat type will only return states of our first Engine Immobilizer Hardware (ACC-EI). Please use Get engine immobilizer states to get states for both Engine Immobilizer Hardware versions (incl. HW-EI21).
• engineLoadPercent: The engine load in percentage points (e.g. 99, 50, etc).
• engineOilPressureKPa: The engine oil pressure reading in kilopascals.
• engineRpm: The revolutions per minute of the engine.
• engineStates: The state of the engine (Off, On, Idle).
• faultCodes: The diagnostic fault codes for the vehicle.
• fuelPercents: The engine fuel level in percentage points (e.g. 99, 50, etc).
• fuelConsumedMilliliters: The cumulative fuel consumption in milliliters for vehicles. Cumulative values always increase. This includes all fuel consumption reported by vehicles without filtering of invalid data points. For filtered fuel consumption that matches the Fuel & Energy Report, please use the Fuel and Energy API.
• gps: GPS data including lat/long, heading, speed, address book entry (if exists), and a reverse geocoded address.
• gpsDistanceMeters: The distance the vehicle has traveled since the gateway was installed based on GPS calculations.
• gpsOdometerMeters: Odometer reading provided by GPS calculations when OBD odometer cannot be pulled automatically. You must provide a manual odometer reading before this value is updated. Manual odometer readings can be provided via the PATCH /fleet/vehicles/{id} endpoint or through the cloud dasbhoard. Odometer readings that are manually set will update as GPS trip data is gathered. Try combining with obdOdometerMeters.
• idlingDurationMilliseconds: The cumulative idling duration in milliseconds. Cumulative values always increase. For filtering of idling duration please use the Idling Events API.
• intakeManifoldTemperatureMilliC: The intake manifold temperature reading in millidegree Celsius.
• nfcCardScans: ID card scans.
• obdEngineSeconds: The cumulative number of seconds the engine has run according to onboard diagnostics. When onboard diagnostic data is unavailable, ignition-based engine data (for ELD vehicles) will be used as a proxy to accumulate engine hours.
• obdOdometerMeters: The odometer reading according to onboard diagnostics. If Samsara does not have diagnostic coverage for a particular vehicle, the value for this stat type will be omitted.
• syntheticEngineSeconds: The cumulative number of seconds the engine has run estimated based on when the engine is running. Please note that this method requires the addition of a baseline to trigger accumulation.
• evStateOfChargeMilliPercent: Milli percent State of Charge for electric and hybrid vehicles. Not all EV and HEVs may report this field.
• evChargingStatus: Charging status for electric and hybrid vehicles. Not all EV and HEVs may report this field. Statuses: unknown - 0, not charging - 1, charging - 2.
• evChargingEnergyMicroWh: Charging energy for electric and hybrid vehicles in microwatt hours. Not all EV and HEVs may report this field.
• evChargingVoltageMilliVolt: Charging voltage for electric and hybrid vehicles in milli volts. Not all EV and HEVs may report this field.
• evChargingCurrentMilliAmp: Charging current for electric and hybrid vehicles in milli amps. Not all EV and HEVs may report this field.
• evConsumedEnergyMicroWh: Consumed energy (including regenerated) for electric and hybrid vehicles in microwatt hours. Not all EV and HEVs may report this field.
• evRegeneratedEnergyMicroWh: Regenerated energy for electric and hybrid vehicles in microwatt hours. Not all EV and HEVs may report this field.
• evBatteryVoltageMilliVolt: Battery voltage for electric and hybrid vehicles in milli volts. Not all EV and HEVs may report this field.
• evBatteryCurrentMilliAmp: Battery current for electric and hybrid vehicles in milli amps. Not all EV and HEVs may report this field.
• evBatteryStateOfHealthMilliPercent: Milli percent battery state of health for electric and hybrid vehicles. Not all EV and HEVs may report this field.
• evAverageBatteryTemperatureMilliCelsius: Battery temperature for electric and hybrid vehicles in milli celsius. Not all EV and HEVs may report this field.
• evDistanceDrivenMeters: Electric distance driven for electric and hybrid vehicles in meters. Not all EV and HEVs may report this field.
• spreaderLiquidRate: Liquid spread rate reading in milliliters per meter, read from the material spreader. Unfiltered live stats are supplied as-read from the Material Spreader unit. Readings do not consider total spread rate(s) over time or distance.
• spreaderGranularRate: Granular spread rate reading in milliliters per meter, read from the material spreader. Unfiltered live stats are supplied as-read from the Material Spreader unit. Readings do not consider total spread rate(s) over time or distance.
• spreaderPrewetRate: Prewet spread rate reading in milliliters per meter, read from the material spreader. Unfiltered live stats are supplied as-read from the Material Spreader unit. Readings do not consider total spread rate(s) over time or distance.
• spreaderAirTemp: Air (ambient) temperature in milli celsius reading from material spreader.
• spreaderRoadTemp: Road temperature reading in milli celsius from material spreader.
• spreaderOnState: Whether vehicle spreader is enabled.
• spreaderActive: Whether vehicle is actively spreading any material.
• spreaderBlastState: Whether vehicle is actively spreading material in ‘blast mode’.
• spreaderGranularName: Name of most recent type of granular material spread, read from the material spreader.
• spreaderPrewetName: Name of most recent type of prewet material spread, read from the material spreader.
• spreaderLiquidName: Name of most recent type of liquid material spread, read from the material spreader.
• spreaderPlowStatus: Snow plow status (Up or Down), as read from the material spreader. Note: this is separate from plow status defined via auxInput.
• seatbeltDriver: Seatbelt Driver Status as read from the vehicle. Buckled or Unbuckled. (Beta only)
• tellTales: Tell tales status as read from the vehicle.
• ecuDoorStatus: Status of doors, sourced from ECU or from AUX port assigned to a Door label if diagnostic from ECU is not available. Either Closed, Open or Unknown.

Decorations to add to the primary stats listed in the types parameter. For example, if you wish to know the vehicle's location whenever the engine changes state, you may set types=engineStates&decorations=gps.

You may list up to 2 decorations using comma-separated format. If multiple stats are listed in the types parameter, the decorations will be added to each one. For example: types=engineStates,obdOdometerMeters,faultCodes&decorations=gps,fuelPercents will list GPS and fuel decorations for each engine state change, each odometer reading, and each fault code. See the Telematics guide for more details.

Note that decorations may significantly increase the response payload size.

• ambientAirTemperatureMilliC: The ambient air temperature reading in millidegree Celsius.
• auxInput1-auxInput13: Stat events from the auxiliary inputs for the vehicle.
• batteryMilliVolts: The vehicle battery voltage reading.
• barometricPressurePa: The barometric pressure reading in pascals.
• ecuSpeedMph: The speed of the engine in miles per hour according to the ECU.
• engineCoolantTemperatureMilliC: The engine coolant temperature reading in millidegree Celsius.
• engineImmobilizer: The state of the engine immobilizer - Valid values: ignition_disabled, ignition_enabled. This stat type will only return states of our first Engine Immobilizer Hardware (ACC-EI). Please use Get engine immobilizer states to get states for both Engine Immobilizer Hardware versions (incl. HW-EI21).
• engineOilPressureKPa: The engine oil pressure reading in kilopascals.
• engineLoadPercent: The engine load in percentage points (e.g. 99, 50, etc).
• engineRpm: The revolutions per minute of the engine.
• engineStates: The state of the engine (Off, On, Idle).
• faultCodes: The diagnostic fault codes for the vehicle.
• fuelPercents: The engine fuel level in percentage points (e.g. 99, 50, etc).
• fuelConsumedMilliliters: The cumulative fuel consumption in milliliters for vehicles. Cumulative values always increase. This includes all fuel consumption reported by vehicles without filtering of invalid data points. For filtered fuel consumption that matches the Fuel & Energy Report, please use the Fuel and Energy API.
• gps: GPS data including lat/long, heading, speed, address book entry (if exists), and a reverse geocoded address.
• gpsDistanceMeters: The distance the vehicle has traveled since the gateway was installed based on GPS calculations.
• idlingDurationMilliseconds: The cumulative idling duration in milliseconds. Cumulative values always increase. For filtering of idling duration please use the Idling Events API.
• intakeManifoldTemperatureMilliC: The intake manifold temperature reading in millidegree Celsius.
• nfcCardScans: ID card scans.
• obdEngineSeconds: The cumulative number of seconds the engine has run according to onboard diagnostics. When onboard diagnostic data is unavailable, ignition-based engine data (for ELD vehicles) will be used as a proxy to accumulate engine hours.
• obdOdometerMeters: The odometer reading according to onboard diagnostics. If Samsara does not have diagnostic coverage for a particular vehicle, the value for this stat type will be omitted.
• syntheticEngineSeconds: The cumulative number of seconds the engine has run estimated based on when the engine is running. Please note that this method requires the addition of a baseline to trigger accumulation.
• evStateOfChargeMilliPercent: Milli percent State of Charge for electric and hybrid vehicles. Not all EV and HEVs may report this field.
• evChargingStatus: Charging status for electric and hybrid vehicles. Not all EV and HEVs may report this field. Statuses: unknown - 0, not charging - 1, charging - 2.
• evChargingEnergyMicroWh: Charging energy for electric and hybrid vehicles in microwatt hours. Not all EV and HEVs may report this field.
• evChargingVoltageMilliVolt: Charging voltage for electric and hybrid vehicles in milli volts. Not all EV and HEVs may report this field.
• evChargingCurrentMilliAmp: Charging current for electric and hybrid vehicles in milli amps. Not all EV and HEVs may report this field.
• evConsumedEnergyMicroWh: Consumed energy (including regenerated) for electric and hybrid vehicles in microwatt hours. Not all EV and HEVs may report this field.
• evRegeneratedEnergyMicroWh: Regenerated energy for electric and hybrid vehicles in microwatt hours. Not all EV and HEVs may report this field.
• evBatteryVoltageMilliVolt: Battery voltage for electric and hybrid vehicles in milli volts. Not all EV and HEVs may report this field.
• evBatteryCurrentMilliAmp: Battery current for electric and hybrid vehicles in milli amps. Not all EV and HEVs may report this field.
• evBatteryStateOfHealthMilliPercent: Milli percent battery state of health for electric and hybrid vehicles. Not all EV and HEVs may report this field.
• evAverageBatteryTemperatureMilliCelsius: Battery temperature for electric and hybrid vehicles in milli celsius. Not all EV and HEVs may report this field.
• evDistanceDrivenMeters: Electric distance driven for electric and hybrid vehicles in meters. Not all EV and HEVs may report this field.
• spreaderLiquidRate: Liquid spread rate reading in milliliters per meter, read from the material spreader. Unfiltered live stats are supplied as-read from the Material Spreader unit. Readings do not consider total spread rate(s) over time or distance.
• spreaderGranularRate: Granular spread rate reading in milliliters per meter, read from the material spreader. Unfiltered live stats are supplied as-read from the Material Spreader unit. Readings do not consider total spread rate(s) over time or distance.
• spreaderPrewetRate: Prewet spread rate reading in milliliters per meter, read from the material spreader. Unfiltered live stats are supplied as-read from the Material Spreader unit. Readings do not consider total spread rate(s) over time or distance.
• spreaderAirTemp: Air (ambient) temperature in milli celsius reading from material spreader.
• spreaderRoadTemp: Road temperature reading in milli celsius from material spreader.
• spreaderOnState: Whether vehicle spreader is enabled.
• spreaderActive: Whether vehicle is actively spreading any material.
• spreaderBlastState: Whether vehicle is actively spreading material in 'blast mode'.
• spreaderGranularName: Name of most recent type of granular material spread, read from the material spreader.
• spreaderPrewetName: Name of most recent type of prewet material spread, read from the material spreader.
• spreaderLiquidName: Name of most recent type of liquid material spread, read from the material spreader.
• spreaderPlowStatus: Snow plow status (Up or Down), as read from the material spreader. Note: this is separate from plow status defined via auxInput.
• seatbeltDriver: Seatbelt Driver Status as read from the vehicle. Buckled or Unbuckled. (Beta only)
• tellTales: Tell tales status as read from the vehicle.
• ecuDoorStatus: Status of doors, sourced from ECU or from AUX port assigned to a Door label if diagnostic from ECU is not available. Either Closed, Open or Unknown.