Samsara Vehicle Stats API
The Vehicle Stats API from Samsara — 1 operation(s) for vehicle stats.
Samsara Vehicle Stats API is one of 90 APIs that Samsara publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Vehicle Stats. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and a GitHub repository.
This API exposes 1 operation across 1 path, and defines 155 schemas. It is described by OpenAPI 3.0.1, at version 2024-11-18.
Requests are made against 2 base URLs: https://api.samsara.com/, https://api.eu.samsara.com/.
1 operations
1 paths
155 schemas
1 GET
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 1
Samsara Vehicle Stats API declares
1 security scheme
for authenticating requests.
It accepts HTTP bearer tokens (AccessTokenHeader).
By default, every request must be authenticated.
Paths & Operations 1
Across 1 path, the API surfaces 1 operation — 1 GET. Each is listed below with its method, path, parameters, and response codes.
Vehicle Stats 1
GET
/fleet/vehicles/stats
Stats Snapshot
Schemas 155
The contract defines 155 schemas that model the data the API accepts and returns. The most detailed are VehicleStatsResponse_data (62 properties), VehicleStatsDecorations (58 properties), VehicleStatsFaultCodesPassengerMonitorStatus (12 properties), VehicleStatsFaultCodesValue_obdii_monitorStatus (12 properties). Each schema is shown below with its type and property counts.
VehicleStatsResponse_spreaderPlowStatus
object
Snow plow status (Up or Down), as read from the material spreader. Note: this is separate from plow status defined via auxInput.
2 properties
2 required
VehicleStatsResponse_spreaderBlastState
object
Whether vehicle is actively spreading material in blast mode.
2 properties
2 required
VehicleStatsEngineState
object
Vehicle engine state event.
2 properties
2 required
VehicleStatsResponse_evDistanceDrivenMeters
object
Electric distance driven for electric and hybrid vehicles in meters. Not all EV and HEVs may report this field.
2 properties
2 required
time
string
UTC timestamp in RFC 3339 format. Example: 2020-01-27T07:06:25Z.
VehicleStatsAuxInputValue
boolean
Boolean indicating the state of the auxiliary equipment.
VehicleStatsDecorations_ecuSpeedMph
object
1 property
1 required
VehicleStatsEvDistanceDrivenMeters
object
Electric distance driven for electric and hybrid vehicles in meters. Not all EV and HEVs may report this field.
2 properties
2 required
VehicleStatsEcuSpeedMphValue
number
The speed of the vehicle in miles per hour, as reported by the ECU.
VehicleStatsEvRegeneratedEnergyMicroWh
object
Regenerated energy for electric and hybrid vehicles in microwatt hours. Not all EV and HEVs may report this field.
2 properties
2 required
VehicleStatsResponse_evChargingEnergyMicroWh
object
Charging energy for electric and hybrid vehicles in microwatt hours. Not all EV and HEVs may report this field.
2 properties
2 required
standardErrorResponse
object
Error response
2 properties
VehicleStatsFuelPercentValue
integer
The engine fuel level in percentage points (e.g. 99, 50, etc).
VehicleStatsFaultCodesOemTroubleCode
object
Proprietary diagnostic trouble code for some OEM vehicles.
4 properties
VehicleAuxInputName
string
The type of auxiliary input configured for this Vehicle. Once configured, these inputs will generate dynamic, time-series data that will be available to view i…
VehicleStatsFaultCodesJ1939TroubleCode
object
Diagnostic trouble code for J1939 vehicles.
9 properties
5 required
VehicleStatsSpreaderPrewetName
object
Name of most recent type of prewet material spread, read from the material spreader.
2 properties
2 required
VehicleStatsFaultCodesJ1939TroubleCodes
array
Diagnostic trouble codes for J1939 vehicles.
VehicleStatsFaultCodesPassengerMonitorStatus
object
Readings from engine sensors
12 properties
VehicleStatsDecorations_gpsDistanceMeters
object
1 property
1 required
VehicleStatsGpsDistanceMetersValue
number
Number of meters the vehicle has traveled since the gateway was installed, based on GPS calculations.
VehicleId
string
The unique Samsara ID of the Vehicle. This is automatically generated when the Vehicle object is created. It cannot be changed.
VehicleStatsDecorations_engineStates
object
1 property
1 required
VehicleStatsResponse_evAverageBatteryTemperatureMilliCelsius
object
Battery temperature for electric and hybrid vehicles in milli celsius. Not all EV and HEVs may report this field.
2 properties
2 required
VehicleStatsEvChargingStatus
object
Charging status for electric and hybrid vehicles. Not all EV and HEVs may report this field.
2 properties
2 required
vehicleStatsAuxInputTime
string
UTC timestamp in RFC 3339 format. Example: 2020-01-27T07:06:25Z.
VehicleStatsIntakeManifoldTempMilliC
object
Vehicle intake manifold temperature reading.
2 properties
2 required
VehicleStatsFaultCodesValue_obdii_monitorStatus
object
Readings from engine sensors
12 properties
VehicleStatsNfcCardScan_card
object
The card that was scanned.
1 property
VehicleStatsResponse_spreaderRoadTemp
object
Road temperature reading in milli celsius from material spreader.
2 properties
2 required
paginationResponse
object
Pagination parameters.
2 properties
2 required
VehicleStatsEngineLoadPercentValue
integer
The engine load in percentage points (e.g. 99, 50, etc).
VehicleStatsEngineRpmValue
integer
The revolutions per minute of the engine.
VehicleStatsSeatbeltDriver
object
Seatbelt Driver Status as read from the vehicle. Buckled or Unbuckled.
2 properties
2 required
VehicleStatsSpreaderGranularName
object
Name of most recent type of granular material spread, read from the material spreader.
2 properties
2 required
VehicleStatsResponse_evConsumedEnergyMicroWh
object
Consumed energy (including regenerated) for electric and hybrid vehicles in microwatt hours. Not all EV and HEVs may report this field.
2 properties
2 required
VehicleStatsResponse_spreaderGranularRate
object
Granular spread rate reading in milliliters per meter, read from the material spreader. Unfiltered live stats are supplied as-read from the Material Spreader u…
2 properties
2 required
VehicleStatsEngineImmobilizer
object
Data for the engine immobilizer
3 properties
3 required
VehicleStatsSpreaderGranularRate
object
Granular spread rate reading in milliliters per meter, read from the material spreader. Unfiltered live stats are supplied as-read from the Material Spreader u…
2 properties
2 required
VehicleStatsResponse_spreaderGranularName
object
Name of most recent type of granular material spread, read from the material spreader.
2 properties
2 required
VehicleStatsResponse_spreaderActive
object
Whether vehicle is actively spreading any material.
2 properties
2 required
VehicleStatsSpreaderLiquidRate
object
Liquid spread rate reading in milliliters per meter, read from the material spreader. Unfiltered live stats are supplied as-read from the Material Spreader uni…
2 properties
2 required
VehicleStatsResponse_spreaderLiquidRate
object
Liquid spread rate reading in milliliters per meter, read from the material spreader. Unfiltered live stats are supplied as-read from the Material Spreader uni…
2 properties
2 required
VehicleStatsFaultCodesOemTroubleCodes
array
Proprietary diagnostic trouble codes for OEM vehicles.
VehicleStatsDecorations_engineRpm
object
1 property
1 required
VehicleStatsDefLevelMilliPercent
object
The Diesel Exhaust Fluid (DEF) milli percentage reading.
2 properties
2 required
VehicleStatsGpsOdometerMetersValue
integer
Number of meters the vehicle has traveled according to the GPS calculations and the manually-specified odometer reading.
VehicleStatsResponse_spreaderPrewetName
object
Name of most recent type of prewet material spread, read from the material spreader.
2 properties
2 required
VehicleStatsDecorations_barometricPressurePa
object
1 property
1 required
VehicleLocationLongitude
number
GPS longitude represented in degrees
VehicleStatsObdEngineSeconds
object
Vehicle OBD engine seconds reading.
2 properties
2 required
VehicleStatsDecorations_defLevelMilliPercent
object
1 property
1 required
VehicleStatsResponse_spreaderOnState
object
Whether vehicle spreader is enabled.
2 properties
2 required
VehicleStatsFaultCodesIgnitionType
string
The ignition type of this passenger vehicle. Valid values: spark, compression.
VehicleStatsEvChargingCurrentMilliAmp
object
Charging current for electric and hybrid vehicles in milli amps. Not all EV and HEVs may report this field.
2 properties
2 required
VehicleStatsEvChargingEnergyMicroWh
object
Charging energy for electric and hybrid vehicles in microwatt hours. Not all EV and HEVs may report this field.
2 properties
2 required
VehicleStatsGpsOdometerMeters
object
Vehicle GPS odometer event.
2 properties
2 required
VehicleStatsResponse
object
Vehicle stats snapshot and pagination info.
2 properties
2 required
VehicleStatsFaultCodesOBDII
object
Vehicle fault codes for passenger vehicles.
2 properties
VehicleStatsGps
object
GPS location data for the vehicle.
8 properties
3 required
VehicleStatsEvBatteryStateOfHealthMilliPercent
object
Milli percent battery state of health for electric and hybrid vehicles. Not all EV and HEVs may report this field.
2 properties
2 required
VehicleStatsSyntheticEngineSeconds
object
Data for the synthetic engine seconds for the vehicle
3 properties
2 required
VehicleStatsDecorations_gpsOdometerMeters
object
1 property
1 required
VehicleLocationHeading
number
Heading of the vehicle in degrees.
VehicleStatsFaultCodesJ1939Lights
object
Status of engine lights on J1939 vehicles.
4 properties
4 required
VehicleStatsResponse_spreaderLiquidName
object
Name of most recent type of liquid material spread, read from the material spreader.
2 properties
2 required
reverseGeo
object
Reverse geocoded information.
1 property
VehicleStatsFaultCodesValue_oem
object
Vehicle fault codes for OEM vehicles.
1 property
VehicleStatsFaultCodesPassengerMonitorStatusValue
string
Enum of monitor status: -U: Unsupported -N: Not Complete -R: Complete
VehicleStatsFaultCodesCanBusType
string
The CAN bus type of the vehicle.
VehicleStatsDecorations_fuelPercents
object
1 property
1 required
VehicleStatsAuxInput
object
Data for auxiliary digio equipment.
3 properties
VehicleStatsResponse_evChargingCurrentMilliAmp
object
Charging current for electric and hybrid vehicles in milli amps. Not all EV and HEVs may report this field.
2 properties
2 required
VehicleStatsAuxInputDecoration
object
2 properties
2 required
VehicleStatsEngineRpm
object
Vehicle engine RPM reading.
2 properties
2 required
VehicleStatsSpreaderAirTemp
object
Air (ambient) temperature in milli celsius reading from material spreader.
2 properties
2 required
VehicleExternalIds
object
The external IDs for the given object.
VehicleStatsEvBatteryCurrentMilliAmp
object
Battery current for electric and hybrid vehicles in milli amps. Not all EV and HEVs may report this field.
2 properties
2 required
VehicleStatsBarometricPressurePa
object
Vehicle barometric pressure reading.
2 properties
2 required
VehicleStatsResponse_evRegeneratedEnergyMicroWh
object
Regenerated energy for electric and hybrid vehicles in microwatt hours. Not all EV and HEVs may report this field.
2 properties
2 required
VehicleStatsFaultCodesValue_obdii_confirmedDtcs
object
Passenger vehicle DTC information
3 properties
1 required
VehicleStatsFaultCodesOBDIITroubleCode
object
Diagnostic trouble code for passenger vehicles.
7 properties
1 required
VehicleStatsResponse_evBatteryStateOfHealthMilliPercent
object
Milli percent battery state of health for electric and hybrid vehicles. Not all EV and HEVs may report this field.
2 properties
2 required
VehicleStatsAmbientAirTempMilliCValue
integer
The ambient air temperature reading in millidegree Celsius.
VehicleStatsResponse_evStateOfChargeMilliPercent
object
State of Charge for electric and hybrid vehicles. Not all EV and HEVs may report this field.
2 properties
2 required
VehicleStatsFaultCodesOem
object
Vehicle fault codes for OEM vehicles.
1 property
VehicleStatsResponse_spreaderAirTemp
object
Air (ambient) temperature in milli celsius reading from material spreader.
2 properties
2 required
VehicleStatsFaultCodes
object
Engine fault codes read from J1939, OBDII, and OEM vehicles.
5 properties
1 required
VehicleStatsSpreaderRoadTemp
object
Road temperature reading in milli celsius from material spreader.
2 properties
2 required
VehicleStatsEngineStateSetting
string
The state of the engine.
VehicleStatsDecorations_intakeManifoldTemperatureMilliC
object
1 property
1 required
VehicleStatsFaultCodesValue_obdii_diagnosticTroubleCodes
object
Diagnostic trouble code for passenger vehicles.
7 properties
1 required
VehicleStatsEvChargingVoltageMilliVolt
object
Charging voltage for electric and hybrid vehicles in milli volts. Not all EV and HEVs may report this field.
2 properties
2 required
VehicleStatsResponse_evBatteryVoltageMilliVolt
object
Battery voltage for electric and hybrid vehicles in milli volts. Not all EV and HEVs may report this field.
2 properties
2 required
VehicleStatsEvBatteryVoltageMilliVolt
object
Battery voltage for electric and hybrid vehicles in milli volts. Not all EV and HEVs may report this field.
2 properties
2 required
VehicleStatsSpreaderActive
object
Whether vehicle is actively spreading any material.
2 properties
2 required
VehicleStatsBatteryMilliVoltsValue
integer
The battery voltage in millivolts.
VehicleStatsEvConsumedEnergyMicroWh
object
Consumed energy (including regenerated) for electric and hybrid vehicles in microwatt hours. Not all EV and HEVs may report this field.
2 properties
2 required
VehicleStatsNfcCardScan
object
Data for the nfc card and the time that it was scanned.
2 properties
2 required
VehicleStatsFaultCodesValue_j1939
object
Vehicle fault codes for J1939 vehicles.
2 properties
VehicleStatsResponse_spreaderPrewetRate
object
Prewet spread rate reading in milliliters per meter, read from the material spreader. Unfiltered live stats are supplied as-read from the Material Spreader uni…
2 properties
2 required
VehicleLocationSpeed
number
GPS speed of the vehicle in miles per hour. See isEcuSpeed to determine speed data source.
VehicleStatsSpreaderPrewetRate
object
Prewet spread rate reading in milliliters per meter, read from the material spreader. Unfiltered live stats are supplied as-read from the Material Spreader uni…
2 properties
2 required
VehicleStatsResponse_evChargingStatus
object
Charging status for electric and hybrid vehicles. Not all EV and HEVs may report this field.
2 properties
2 required
VehicleStatsEngineOilPressureKPa
object
Vehicle engine oil pressure reading.
2 properties
2 required
VehicleStatsResponse_seatbeltDriver
object
Seatbelt Driver Status as read from the vehicle. Buckled or Unbuckled.
2 properties
2 required
VehicleStatsFuelPercent
object
Vehicle fuel percentage reading.
2 properties
2 required
VehicleStatsSpreaderLiquidName
object
Name of most recent type of liquid material spread, read from the material spreader.
2 properties
2 required
VehicleStatsDecorations_gps
object
7 properties
2 required
VehicleStatsFaultCodesVendorSpecificFields
object
Vendor specific data for J1939 vehicles.
2 properties
VehicleStatsDecorations
object
Optional decorations to the primary stat event. See [here](doc:decorations) for more details. The example shows the response if you were to submit decorations=…
58 properties
VehicleName
string
The human-readable name of the Vehicle. This is set by a fleet administrator and will appear in both Samsaras cloud dashboard as well as the Samsara Driver mob…
VehicleLocationLatitude
number
GPS latitude represented in degrees
VehicleStatsEngineOilPressureKPaValue
integer
The engine oil pressure reading in kilopascals.
VehicleStatsEngineCoolantTempMilliC
object
Vehicle engine coolant temperature reading.
2 properties
2 required
VehicleStatsFaultCodesTxId
integer
The TX identifier.
VehicleStatsFaultCodesJ1939
object
Vehicle fault codes for J1939 vehicles.
2 properties
VehicleStatsSpreaderPlowStatus
object
Snow plow status (Up or Down), as read from the material spreader. Note: this is separate from plow status defined via auxInput.
2 properties
2 required
VehicleStatsIntakeManifoldTempMilliCValue
integer
The intake manifold temperature reading in millidegree Celsius.
VehicleStatsObdOdometerMetersValue
integer
Number of meters the vehicle has traveled according to the on-board diagnostics.
VehicleStatsFaultCodesValue_oem_diagnosticTroubleCodes
object
Proprietary diagnostic trouble code for some OEM vehicles.
4 properties
VehicleStatsFaultCodesValue_j1939_diagnosticTroubleCodes
object
Diagnostic trouble code for J1939 vehicles.
9 properties
5 required
VehicleStatsResponse_data
object
A vehicle and its most recent stat.
62 properties
2 required
VehicleStatsFaultCodesValue_j1939_vendorSpecificFields
object
Vendor specific data for J1939 vehicles.
2 properties
VehicleStatsObdEngineSecondsValue
integer
Number of seconds the vehicle's engine has been on according to the on-board diagnostics.
VehicleStatsDecorations_batteryMilliVolts
object
1 property
1 required
VehicleStatsEvAverageBatteryTemperatureMilliCelsius
object
Battery temperature for electric and hybrid vehicles in milli celsius. Not all EV and HEVs may report this field.
2 properties
2 required
VehicleStatsSyntheticEngineSecondsValue
integer
Stats for the number of seconds the vehicle's engine has been on, calculated based on a manually-specified engine seconds reading and the number of seconds the…
VehicleStatsEcuSpeedMph
object
The speed of the vehicle in miles per hour, as reported by the ECU.
2 properties
2 required
VehicleStatsFaultCodesPassengerDtc
object
Passenger vehicle DTC information
3 properties
1 required
VehicleStatsDecorations_engineCoolantTemperatureMilliC
object
1 property
1 required
VehicleStatsDefLevelMilliPercentValue
integer
The Diesel Exhaust Fluid (DEF) level in milli percentage points (e.g. 99001, 49999, etc).
VehicleStatsFaultCodesValue_obdii
object
Vehicle fault codes for passenger vehicles.
2 properties
VehicleStatsDecorations_obdOdometerMeters
object
1 property
1 required
VehicleStatsTirePressures
object
Tire pressure readings for each of four tires in kilopascals.
4 properties
VehicleStatsDecorations_engineLoadPercent
object
1 property
1 required
VehicleStatsDecorations_ambientAirTemperatureMilliC
object
1 property
1 required
VehicleStatsFaultCodesValue
object
Fault codes for the vehicle
4 properties
VehicleStatsEngineLoadPercent
object
The engine load percentage reading.
2 properties
2 required
VehicleStatsObdOdometerMeters
object
Vehicle OBD odometer reading.
2 properties
2 required
VehicleStatsDecorations_obdEngineSeconds
object
1 property
1 required
VehicleStatsGpsDistanceMeters
object
Vehicle GPS distance event.
2 properties
2 required
VehicleStatsSpreaderBlastState
object
Whether vehicle is actively spreading material in blast mode.
2 properties
2 required
VehicleStatsDecorations_engineOilPressureKPa
object
1 property
1 required
VehicleStatsSpreaderOnState
object
Whether vehicle spreader is enabled.
2 properties
2 required
VehicleStatsBarometricPressurePaValue
integer
The barometric pressure reading in pascals.
VehicleLocationIsEcuSpeed
boolean
True if the speed value is reported from the ECU. Speed value is reported from GPS otherwise.
VehicleLocationAddress
object
Address that the location is in.
2 properties
VehicleStatsAmbientAirTempMilliC
object
Vehicle ambient air temperature reading.
2 properties
2 required
VehicleStatsEngineCoolantTempMilliCValue
integer
The engine coolant temperature reading in millidegree Celsius.
VehicleStatsResponse_evChargingVoltageMilliVolt
object
Charging voltage for electric and hybrid vehicles in milli volts. Not all EV and HEVs may report this field.
2 properties
2 required
VehicleStatsBatteryVoltage
object
Vehicle battery voltage reading.
2 properties
2 required
VehicleStatsEvStateOfChargeMilliPercent
object
State of Charge for electric and hybrid vehicles. Not all EV and HEVs may report this field.
2 properties
2 required
VehicleStatsResponse_evBatteryCurrentMilliAmp
object
Battery current for electric and hybrid vehicles in milli amps. Not all EV and HEVs may report this field.
2 properties
2 required
VehicleStatsFaultCodesValue_j1939_checkEngineLights
object
Status of engine lights on J1939 vehicles.
4 properties
4 required
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Samsara 12
Other APIs Samsara publishes across the network.
Samsara Activity API
Samsara Addresses API
Samsara Aemp API
Samsara Applications API
Samsara Assets API
Samsara Assignments API
Samsara Attributes API
Samsara Audit API
Samsara Beta A P Is API
Samsara Camera API
Samsara Cameras API
Samsara Cargo API
#Vehicle Stats
Where this information came from
This is an independent, third-party profile of Samsara Vehicle Stats API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.
The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.
Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.
info@apievangelist.com
·
Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and
you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.