Samsara History API
The History API from Samsara — 7 operation(s) for history.
Samsara History API is one of 90 APIs that Samsara publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include History. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and a GitHub repository.
This API exposes 7 operations across 7 paths, and defines 178 schemas. It is described by OpenAPI 3.2.0, at version 2024-11-18.
Requests are made against 2 base URLs: https://api.samsara.com/, https://api.eu.samsara.com/.
7 operations
7 paths
178 schemas
5 GET2 POST
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 1
Samsara History API declares
1 security scheme
for authenticating requests.
It accepts HTTP bearer tokens (AccessTokenHeader).
By default, every request must be authenticated.
Paths & Operations 7
Across 7 paths, the API surfaces 7 operations — 5 GET, 2 POST. Each is listed below with its method, path, parameters, and response codes.
History 7
GET
/fleet/equipment/locations/history
Get Historical Equipment Locations
GET
/fleet/equipment/stats/history
Get Historical Equipment Stats
GET
/fleet/vehicles/locations/history
Historical Locations
GET
/fleet/vehicles/stats/history
Historical Stats
GET
/industrial/data-inputs/data-points/history
List Historical Data Points for Data Inputs
POST
/v1/machines/history
Get Machine History
POST
/v1/sensors/history
Get Sensor History
Schemas 178
The contract defines 178 schemas that model the data the API accepts and returns. The most detailed are VehicleStatsListResponse_data (62 properties), VehicleStatsDecorations (58 properties), EquipmentStatsListResponse_data (13 properties), VehicleStatsFaultCodesPassengerMonitorStatus (12 properties). Each schema is shown below with its type and property counts.
VehicleStatsDefLevelMilliPercentWithDecoration
object
The Diesel Exhaust Fluid (DEF) milli percentage reading.
3 properties
2 required
VehicleStatsSeatbeltDriver
object
Seatbelt Driver Status as read from the vehicle. Buckled or Unbuckled.
2 properties
2 required
VehicleStatsDecorations_intakeManifoldTemperatureMilliC
object
1 property
1 required
EquipmentStatsListResponse
object
A time-series of equipment stats and pagination information
2 properties
2 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
VehicleStatsDecorations_engineStates
object
1 property
1 required
J1939D1StatusDataPoint
object
Active J1939D1 statuses of a device.
2 properties
VehicleStatsDefLevelMilliPercentValue
integer
The Diesel Exhaust Fluid (DEF) level in milli percentage points (e.g. 99001, 49999, etc).
VehicleStatsFaultCodesJ1939Lights
object
Status of engine lights on J1939 vehicles.
4 properties
4 required
EquipmentEngineSeconds
object
[DEPRECATED] Please use either gatewayEngineSeconds or obdEngineSeconds.
2 properties
2 required
EquipmentEngineState
object
[DEPRECATED] Please use either gatewayEngineStates or obdEngineStates.
2 properties
2 required
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
VehicleStatsAuxInputDecoration
object
2 properties
2 required
EquipmentLocation
object
Location reading.
5 properties
3 required
VehicleStatsListGps
object
GPS location data for the vehicle.
9 properties
3 required
EquipmentLocationsListResponse_data
object
A unit of equipment and its time-series of location events.
3 properties
3 required
VehicleStatsSpreaderPrewetName
object
Name of most recent type of prewet material spread, read from the material spreader.
2 properties
2 required
VehicleStatsFaultCodesJ1939
object
Vehicle fault codes for J1939 vehicles.
2 properties
V1SensorHistoryResponse_results
object
2 properties
VehicleStatsAuxInputValue
boolean
Boolean indicating the state of the auxiliary equipment.
VehicleStatsDecorations_batteryMilliVolts
object
1 property
1 required
LocationDataPoint_gpsLocation
object
GPS location information of the data input's datapoint.
6 properties
VehicleStatsFuelPercentWithDecoration
object
Vehicle fuel percentage reading.
3 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
_v1_sensors_history_series
object
V1Sensor ID and field to query.
2 properties
2 required
VehicleStatsIntakeManifoldTempMilliCWithDecoration
object
Vehicle intake manifold temperature reading.
3 properties
2 required
VehicleStatsFaultCodesValue_obdii_monitorStatus
object
Readings from engine sensors
12 properties
EquipmentGatewayEngineSeconds
object
Engine seconds reading from the aux/digio cable.
2 properties
2 required
EquipmentFuelPercent
object
Fuel percent reading.
2 properties
2 required
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
VehicleStatsFaultCodesOBDII
object
Vehicle fault codes for passenger vehicles.
2 properties
VehicleStatsEngineRpmWithDecoration
object
Vehicle engine RPM reading.
3 properties
2 required
VehicleStatsGpsDistanceMetersWithDecoration
object
Vehicle GPS distance event.
3 properties
2 required
VehicleStatsSpreaderRoadTemp
object
Road temperature reading in milli celsius from material spreader.
2 properties
2 required
VehicleStatsDecorations_gps
object
7 properties
2 required
reverseGeo
object
Reverse geocoded information.
1 property
VehicleStatsObdEngineSecondsWithDecoration
object
Vehicle OBD engine seconds reading.
3 properties
2 required
VehicleStatsFaultCodesWithDecoration
object
Engine fault codes read from J1939, OBDII, and OEM vehicles.
6 properties
1 required
VehicleStatsAmbientAirTempMilliCWithDecoration
object
Vehicle ambient air temperature reading.
3 properties
2 required
VehicleLocationSpeed
number
GPS speed of the vehicle in miles per hour. See isEcuSpeed to determine speed data source.
VehicleStatsFaultCodesOemTroubleCode
object
Proprietary diagnostic trouble code for some OEM vehicles.
4 properties
VehicleStatsFaultCodesPassengerMonitorStatusValue
string
Enum of monitor status: -U: Unsupported -N: Not Complete -R: Complete
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…
VehicleStatsDecorations_barometricPressurePa
object
1 property
1 required
EquipmentLocationsListResponse
object
A time-series of equipment locations and pagination information
2 properties
2 required
VehicleStatsSpreaderLiquidName
object
Name of most recent type of liquid material spread, read from the material spreader.
2 properties
2 required
EquipmentGatewayEngineState
object
Engine state reading from the aux/digio cable.
2 properties
2 required
VehicleStatsFaultCodesPassengerDtc
object
Passenger vehicle DTC information
3 properties
1 required
VehicleStatsFaultCodesValue_j1939
object
Vehicle fault codes for J1939 vehicles.
2 properties
VehicleStatsFaultCodesIgnitionType
string
The ignition type of this passenger vehicle. Valid values: spark, compression.
VehicleStatsBarometricPressurePaValue
integer
The barometric pressure reading in pascals.
EquipmentObdEngineSeconds
object
Engine seconds reading from on-board diagnostics.
2 properties
2 required
VehicleLocationsListResponse_data
object
A vehicle and its list of location events.
3 properties
3 required
FftSpectraDataPoint_fftSpectra
object
FFT spectrum data
4 properties
VehicleStatsEcuSpeedMphValue
number
The speed of the vehicle in miles per hour, as reported by the ECU.
VehicleStatsFaultCodesOem
object
Vehicle fault codes for OEM vehicles.
1 property
VehicleStatsFaultCodesValue
object
Fault codes for the vehicle
4 properties
VehicleStatsDecorations_engineOilPressureKPa
object
1 property
1 required
EquipmentStatsListResponse_data
object
A unit of equipment and its time-series of stats events.
13 properties
2 required
VehicleLocationsListResponse
object
List of vehicle location events and pagination info.
2 properties
2 required
VehicleStatsSpreaderBlastState
object
Whether vehicle is actively spreading material in blast mode.
2 properties
2 required
V1MachineHistoryResponse
object
Contains the results for a machine history request
1 property
VehicleStatsNfcCardScanWithDecoration
object
Data for the nfc card and the time that it was scanned.
3 properties
2 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
EquipmentGpsOdometerMeters
object
GPS odometer reading.
2 properties
2 required
VehicleLocationLongitude
number
GPS longitude represented in degrees
AssetLocationHeading
number
Heading of the asset in degrees.
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
VehicleLocationHeading
number
Heading of the vehicle in degrees.
VehicleLocationAddress
object
Address that the location is in.
2 properties
V1SensorHistoryResponse
object
Contains the results for a sensor history request. Each result contains a timestamp and datapoint for each requested (sensor, field) pair.
1 property
VehicleStatsTirePressures
object
Tire pressure readings for each of four tires in kilopascals.
4 properties
AssetLocationSpeed
number
GPS speed of the asset in miles per hour.
EquipmentGatewayJ1939EngineSeconds
object
Engine seconds reading from the J1939/CAT cable.
2 properties
2 required
VehicleStatsEcuSpeedMphWithDecoration
object
The speed of the vehicle in miles per hour, as reported by the ECU.
3 properties
2 required
paginationResponse
object
Pagination parameters.
2 properties
2 required
VehicleStatsEngineImmobilizerWithDecoration
object
Data for the engine immobilizer
4 properties
3 required
VehicleStatsDecorations_obdEngineSeconds
object
1 property
1 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
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
VehicleStatsEngineCoolantTempMilliCValue
integer
The engine coolant temperature reading in millidegree Celsius.
VehicleStatsIntakeManifoldTempMilliCValue
integer
The intake manifold temperature reading in millidegree Celsius.
VehicleStatsFaultCodesValue_j1939_vendorSpecificFields
object
Vendor specific data for J1939 vehicles.
2 properties
VehicleStatsEngineImmobilizer
object
Data for the engine immobilizer
3 properties
3 required
LocationDataPoint
object
A single location data point of a data input.
2 properties
time
string
UTC timestamp in RFC 3339 format. Example: 2020-01-27T07:06:25Z.
VehicleStatsDecorations_gpsOdometerMeters
object
1 property
1 required
VehicleStatsGpsOdometerMetersValue
integer
Number of meters the vehicle has traveled according to the GPS calculations and the manually-specified odometer reading.
VehicleStatsListResponse
object
List of vehicle stat events and pagination info.
2 properties
2 required
VehicleStatsFaultCodesJ1939TroubleCodes
array
Diagnostic trouble codes for J1939 vehicles.
EquipmentEngineRpm
object
Engine RPM reading.
2 properties
2 required
VehicleStatsBatteryVoltageWithDecoration
object
Vehicle battery voltage reading.
3 properties
2 required
VehicleStatsFaultCodesValue_obdii
object
Vehicle fault codes for passenger vehicles.
2 properties
VehicleStatsDecorations_engineRpm
object
1 property
1 required
DataInputResponse
VehicleStatsObdEngineSecondsValue
integer
Number of seconds the vehicle's engine has been on according to the on-board diagnostics.
VehicleStatsFuelPercentValue
integer
The engine fuel level in percentage points (e.g. 99, 50, etc).
VehicleStatsEngineLoadPercentWithDecoration
object
The engine load percentage reading.
3 properties
2 required
VehicleLocationLatitude
number
GPS latitude represented in degrees
VehicleStatsEngineStateSetting
string
The state of the engine.
VehicleStatsSpreaderActive
object
Whether vehicle is actively spreading any material.
2 properties
2 required
VehicleStatsEngineOilPressureKPaValue
integer
The engine oil pressure reading in kilopascals.
VehicleStatsFaultCodesCanBusType
string
The CAN bus type of the vehicle.
VehicleStatsObdOdometerMetersWithDecoration
object
Vehicle OBD odometer reading.
3 properties
2 required
DataInputListResponse
object
2 properties
FftSpectraDataPoint
object
FFT spectrum data point of a data input.
2 properties
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
VehicleStatsNfcCardScan_card
object
The card that was scanned.
1 property
addressTinyResponse
object
Address book entry, if one exists
2 properties
VehicleStatsFaultCodesValue_obdii_diagnosticTroubleCodes
object
Diagnostic trouble code for passenger vehicles.
7 properties
1 required
VehicleStatsFaultCodesPassengerMonitorStatus
object
Readings from engine sensors
12 properties
VehicleStatsListSyntheticEngineSeconds
object
A list of synthetic engine seconds for the vehicle.
3 properties
2 required
VehicleStatsBatteryMilliVoltsValue
integer
The battery voltage in millivolts.
V1MachineHistoryResponse_machines
object
3 properties
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
EquipmentObdEngineState
object
Engine state reading from on-board diagnostics.
2 properties
2 required
VehicleStatsDecorations_engineLoadPercent
object
1 property
1 required
EquipmentTime
string
UTC timestamp of the time the data point was generated by the equipment, in RFC3339 format.
VehicleStatsEngineLoadPercentValue
integer
The engine load in percentage points (e.g. 99, 50, etc).
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
vehicleStatsAuxInputTime
string
UTC timestamp in RFC 3339 format. Example: 2020-01-27T07:06:25Z.
EquipmentName
string
Name of the equipment.
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…
VehicleExternalIds
object
The external IDs for the given object.
NumberDataPoint
object
A single numeric data point of a data input.
2 properties
V1MachineHistoryResponse_vibrations
object
4 properties
VehicleStatsDecorations_defLevelMilliPercent
object
1 property
1 required
VehicleStatsFaultCodesOemTroubleCodes
array
Proprietary diagnostic trouble codes for OEM vehicles.
VehicleStatsDecorations_engineCoolantTemperatureMilliC
object
1 property
1 required
VehicleStatsAuxInputWithDecoration
object
Data for auxiliary digio equipment.
4 properties
VehicleStatsBarometricPressurePaWithDecoration
object
Vehicle barometric pressure reading.
3 properties
2 required
VehicleLocationIsEcuSpeed
boolean
True if the speed value is reported from the ECU. Speed value is reported from GPS otherwise.
inline_object_6
object
5 properties
4 required
VehicleLocation
object
Vehicle location event.
6 properties
3 required
VehicleStatsFaultCodesTxId
integer
The TX identifier.
VehicleStatsEngineRpmValue
integer
The revolutions per minute of the engine.
VehicleStatsSpreaderAirTemp
object
Air (ambient) temperature in milli celsius reading from material spreader.
2 properties
2 required
VehicleStatsEngineOilPressureKPaWithDecoration
object
Vehicle engine oil pressure reading.
3 properties
2 required
VehicleStatsListResponse_data
object
A vehicle and its list of stat events.
62 properties
VehicleStatsDecorations_fuelPercents
object
1 property
1 required
VehicleStatsFaultCodesOBDIITroubleCode
object
Diagnostic trouble code for passenger vehicles.
7 properties
1 required
VehicleStatsFaultCodesVendorSpecificFields
object
Vendor specific data for J1939 vehicles.
2 properties
VehicleStatsEvChargingStatus
object
Charging status for electric and hybrid vehicles. Not all EV and HEVs may report this field.
2 properties
2 required
VehicleStatsGpsDistanceMetersValue
number
Number of meters the vehicle has traveled since the gateway was installed, based on GPS calculations.
V1ErrorResponse
string
Error message describing why the request failed.
VehicleStatsSpreaderOnState
object
Whether vehicle spreader is enabled.
2 properties
2 required
VehicleStatsAmbientAirTempMilliCValue
integer
The ambient air temperature reading in millidegree Celsius.
VehicleStatsDecorations_ecuSpeedMph
object
1 property
1 required
VehicleStatsFaultCodesValue_j1939_diagnosticTroubleCodes
object
Diagnostic trouble code for J1939 vehicles.
9 properties
5 required
VehicleStatsEngineCoolantTempMilliCWithDecoration
object
Vehicle engine coolant temperature reading.
3 properties
2 required
EquipmentId
string
Unique Samsara ID for the equipment.
VehicleStatsEngineStateWithDecoration
object
Vehicle engine state event.
3 properties
2 required
VehicleStatsSpreaderGranularName
object
Name of most recent type of granular material spread, read from the material spreader.
2 properties
2 required
J1939D1StatusDataPoint_value
object
A single J1939D1 status
8 properties
inline_object_3
object
2 properties
2 required
VehicleId
string
The unique Samsara ID of the Vehicle. This is automatically generated when the Vehicle object is created. It cannot be changed.
VehicleStatsDecorations_obdOdometerMeters
object
1 property
1 required
standardErrorResponse
object
Error response
2 properties
LocationDataPoint_gpsLocation_place
object
Address of the location
7 properties
StringDataPoint
object
A single string data point of a data input.
2 properties
DataInputResponse_allOf
object
5 properties
VehicleStatsFaultCodesValue_j1939_checkEngineLights
object
Status of engine lights on J1939 vehicles.
4 properties
4 required
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…
DataInputTinyResponse
object
A minified data input object
5 properties
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
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
EquipmentStatsGps
object
GPS location of equipment.
7 properties
3 required
VehicleStatsFaultCodesJ1939TroubleCode
object
Diagnostic trouble code for J1939 vehicles.
9 properties
5 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
VehicleStatsGpsOdometerMetersWithDecoration
object
Vehicle GPS odometer event.
3 properties
2 required
VehicleStatsFaultCodesValue_oem_diagnosticTroubleCodes
object
Proprietary diagnostic trouble code for some OEM vehicles.
4 properties
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
VehicleStatsDecorations_ambientAirTemperatureMilliC
object
1 property
1 required
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
VehicleStatsDecorations_gpsDistanceMeters
object
1 property
1 required
VehicleStatsObdOdometerMetersValue
integer
Number of meters the vehicle has traveled according to the on-board diagnostics.
VehicleStatsFaultCodesValue_oem
object
Vehicle fault codes for OEM vehicles.
1 property
VehicleStatsFaultCodesValue_obdii_confirmedDtcs
object
Passenger vehicle DTC information
3 properties
1 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
#History
Where this information came from
This is an independent, third-party profile of Samsara History 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.