Samsara Vehicle Stats API
The Vehicle Stats API from Samsara — 1 operation(s) for vehicle stats.
OpenAPI Specification
openapi: 3.0.1
info:
description: Gain greater visibility by connecting your fleets, equipment, sites, and people.
title: Samsara Vehicle Stats API
version: '2024-11-18'
servers:
- url: https://api.samsara.com/
- url: https://api.eu.samsara.com/
security:
- AccessTokenHeader: []
tags:
- name: Vehicle Stats
paths:
/fleet/vehicles/stats:
get:
description: "Returns the last known stats of all vehicles at the given `time`. If no `time` is specified, the current time is used.\n\nRelated guide: <a href=\"/docs/telematics\" target=\"_blank\">Telematics</a>. \n\n **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our <a href=\"https://forms.gle/zkD4NCH7HjKb7mm69\" target=\"_blank\">API feedback form</a>. If you encountered an issue or noticed inaccuracies in the API documentation, please <a href=\"https://www.samsara.com/help\" target=\"_blank\">submit a case</a> to our support team.\n\nTo use this endpoint, select **Read Vehicle Statistics** under the Vehicles category when creating or editing an API token. <a href=\"https://developers.samsara.com/docs/authentication#scopes-for-api-tokens\" target=\"_blank\">Learn More.</a>"
operationId: getVehicleStats
parameters:
- description: If specified, this should be the endCursor value from the previous page of results. When present, this request will return the next page of results that occur immediately after the previous page of results.
in: query
name: after
schema:
type: string
- description: 'A filter on the data that returns the last known data points with timestamps less than or equal to this value. Defaults to now if not provided. Must be a string in RFC 3339 format. Millisecond precision and timezones are supported. (Example: `2020-01-27T07:06:25Z`).'
in: query
name: time
schema:
type: string
- description: '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`'
explode: false
in: query
name: parentTagIds
schema:
items:
type: string
type: array
style: form
- description: 'A filter on the data based on this comma-separated list of tag IDs. Example: `tagIds=1234,5678`'
explode: false
in: query
name: tagIds
schema:
items:
type: string
type: array
style: form
- description: 'A filter on the data based on this comma-separated list of vehicle IDs. Example: `vehicleIds=1234,5678`'
explode: false
in: query
name: vehicleIds
schema:
items:
type: string
type: array
style: form
- description: "The stat types you want this endpoint to return information on. See also the <a href=\"/docs/telematics#query-parameters\" target=\"_blank\">Telematics</a> guide for more details.\n\nYou may list ***up to 3*** types using comma-separated format. For example: `types=gps,engineStates,obdOdometerMeters`.\n\n*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.\n\n- `ambientAirTemperatureMilliC`: The ambient air temperature reading in millidegree Celsius.\n- `auxInput1`-`auxInput13`: Stat events from the <a href=\"https://kb.samsara.com/hc/en-us/articles/360043040512-Auxiliary-Inputs\" target=\"_blank\">auxiliary inputs</a> for the vehicle.\n- `barometricPressurePa`: The barometric pressure reading in pascals.\n- `batteryMilliVolts`: The vehicle battery voltage reading.\n- `defLevelMilliPercent`: The Diesel Exhaust Fluid (DEF) level in milli percentage points (e.g. `99001`, `49999`, etc).\n- `ecuSpeedMph`: The speed of the engine in miles per hour according to the ECU.\n- `engineCoolantTemperatureMilliC`: The engine coolant temperature reading in millidegree Celsius.\n- `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 <a href=\"https://developers.samsara.com/reference/getengineimmobilizerstates\" target=\"_blank\">Get engine immobilizer states</a> to get states for both Engine Immobilizer Hardware versions (incl. HW-EI21).\n- `engineLoadPercent`: The engine load in percentage points (e.g. `99`, `50`, etc).\n- `engineOilPressureKPa`: The engine oil pressure reading in kilopascals.\n- `engineRpm`: The revolutions per minute of the engine.\n- `engineStates`: The state of the engine (`Off`, `On`, `Idle`).\n- `faultCodes`: The diagnostic fault codes for the vehicle.\n- `fuelPercents`: The engine fuel level in percentage points (e.g. `99`, `50`, etc).\n- `gps`: GPS data including lat/long, heading, speed, address book entry (if exists), and a reverse geocoded address.\n- `gpsDistanceMeters`: The distance the vehicle has traveled since the gateway was installed based on GPS calculations.\n- `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}](ref:updatevehicle) endpoint or through the <a href=\"https://kb.samsara.com/hc/en-us/articles/115005273667-Editing-Odometer-Reading\" target=\"_blank\">cloud dasbhoard</a>. Odometer readings that are manually set will update as GPS trip data is gathered. Try combining with `obdOdometerMeters`.\n- `intakeManifoldTemperatureMilliC`: The intake manifold temperature reading in millidegree Celsius.\n- `nfcCardScans`: ID card scans.\n- `obdEngineSeconds`: The cumulative number of seconds the engine has run according to onboard diagnostics.\n- `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. Try combining with `gpsOdometerMeters`. \n- `syntheticEngineSeconds`: Data for the synthetic engine seconds for the vehicle.\n- `evStateOfChargeMilliPercent`: Milli percent State of Charge for electric and hybrid vehicles. Not all EV and HEVs may report this field.\n- `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.\n- `evChargingEnergyMicroWh`: Charging energy for electric and hybrid vehicles in microwatt hours. Not all EV and HEVs may report this field.\n- `evChargingVoltageMilliVolt`: Charging voltage for electric and hybrid vehicles in milli volts. Not all EV and HEVs may report this field.\n- `evChargingCurrentMilliAmp`: Charging current for electric and hybrid vehicles in milli amps. Not all EV and HEVs may report this field.\n- `evConsumedEnergyMicroWh`: Consumed energy (including regenerated) for electric and hybrid vehicles in microwatt hours. Not all EV and HEVs may report this field.\n- `evRegeneratedEnergyMicroWh`: Regenerated energy for electric and hybrid vehicles in microwatt hours. Not all EV and HEVs may report this field.\n- `evBatteryVoltageMilliVolt`: Battery voltage for electric and hybrid vehicles in milli volts. Not all EV and HEVs may report this field.\n- `evBatteryCurrentMilliAmp`: Battery current for electric and hybrid vehicles in milli amps. Not all EV and HEVs may report this field.\n- `evBatteryStateOfHealthMilliPercent`: Milli percent battery state of health for electric and hybrid vehicles. Not all EV and HEVs may report this field.\n- `evAverageBatteryTemperatureMilliCelsius`: Battery temperature for electric and hybrid vehicles in milli celsius. Not all EV and HEVs may report this field.\n- `evDistanceDrivenMeters`: Electric distance driven for electric and hybrid vehicles in meters. Not all EV and HEVs may report this field.\n- `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.\n- `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.\n- `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.\n- `spreaderAirTemp`: Air (ambient) temperature in milli celsius reading from material spreader.\n- `spreaderRoadTemp`: Road temperature reading in milli celsius from material spreader.\n- `spreaderOnState`: Whether vehicle spreader is enabled.\n- `spreaderActive`: Whether vehicle is actively spreading any material.\n- `spreaderBlastState`: Whether vehicle is actively spreading material in blast mode.\n- `spreaderGranularName`: Name of most recent type of granular material spread, read from the material spreader.\n- `spreaderPrewetName`: Name of most recent type of prewet material spread, read from the material spreader.\n- `spreaderLiquidName`: Name of most recent type of liquid material spread, read from the material spreader.\n- `spreaderPlowStatus`: Snow plow status (`Up` or `Down`), as read from the material spreader. Note: this is separate from plow status defined via auxInput.\n- `seatbeltDriver`: Seatbelt Driver Status as read from the vehicle. `Buckled` or `Unbuckled`. (Beta only)"
explode: false
in: query
name: types
required: true
schema:
items:
enum:
- ambientAirTemperatureMilliC
- auxInput1
- auxInput2
- auxInput3
- auxInput4
- auxInput5
- auxInput6
- auxInput7
- auxInput8
- auxInput9
- auxInput10
- auxInput11
- auxInput12
- auxInput13
- barometricPressurePa
- batteryMilliVolts
- defLevelMilliPercent
- ecuSpeedMph
- engineCoolantTemperatureMilliC
- engineImmobilizer
- engineLoadPercent
- engineOilPressureKPa
- engineRpm
- engineStates
- faultCodes
- fuelPercents
- gps
- gpsDistanceMeters
- gpsOdometerMeters
- intakeManifoldTemperatureMilliC
- nfcCardScans
- obdEngineSeconds
- obdOdometerMeters
- syntheticEngineSeconds
- evStateOfChargeMilliPercent
- evChargingStatus
- evChargingEnergyMicroWh
- evChargingVoltageMilliVolt
- evChargingCurrentMilliAmp
- evConsumedEnergyMicroWh
- evRegeneratedEnergyMicroWh
- evBatteryVoltageMilliVolt
- evBatteryCurrentMilliAmp
- evBatteryStateOfHealthMilliPercent
- evAverageBatteryTemperatureMilliCelsius
- evDistanceDrivenMeters
- spreaderLiquidRate
- spreaderGranularRate
- spreaderPrewetRate
- spreaderAirTemp
- spreaderRoadTemp
- spreaderOnState
- spreaderActive
- spreaderBlastState
- spreaderGranularName
- spreaderPrewetName
- spreaderLiquidName
- spreaderPlowStatus
- seatbeltDriver
type: string
type: array
style: form
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/VehicleStatsResponse'
description: Vehicle stats snapshot
default:
content:
application/json:
schema:
$ref: '#/components/schemas/standardErrorResponse'
description: Error response
summary: Stats Snapshot
tags:
- Vehicle Stats
components:
schemas:
VehicleStatsResponse_spreaderPlowStatus:
description: 'Snow plow status (`Up` or `Down`), as read from the material spreader. Note: this is separate from plow status defined via auxInput.'
properties:
time:
description: 'UTC timestamp in RFC 3339 format. Example: `2020-01-27T07:06:25Z`.'
example: '2020-01-27T07:06:25Z'
type: string
value:
description: Snow plow status, as read from the material spreader
enum:
- Up
- Down
example: Down
type: string
required:
- time
- value
type: object
VehicleStatsResponse_spreaderBlastState:
description: Whether vehicle is actively spreading material in blast mode.
properties:
time:
description: 'UTC timestamp in RFC 3339 format. Example: `2020-01-27T07:06:25Z`.'
example: '2020-01-27T07:06:25Z'
type: string
value:
description: Whether vehicle is actively spreading material in blast mode.
enum:
- 'On'
- 'Off'
example: 'Off'
type: string
required:
- time
- value
type: object
VehicleStatsEngineState:
description: Vehicle engine state event.
properties:
time:
$ref: '#/components/schemas/time'
value:
$ref: '#/components/schemas/VehicleStatsEngineStateSetting'
required:
- time
- value
type: object
VehicleStatsResponse_evDistanceDrivenMeters:
description: Electric distance driven for electric and hybrid vehicles in meters. Not all EV and HEVs may report this field.
properties:
time:
description: 'UTC timestamp in RFC 3339 format. Example: `2020-01-27T07:06:25Z`.'
example: '2020-01-27T07:06:25Z'
type: string
value:
description: Electric distance driven for electric and hybrid vehicles in meters.
example: 1000
format: int64
type: integer
required:
- time
- value
type: object
time:
description: 'UTC timestamp in RFC 3339 format. Example: `2020-01-27T07:06:25Z`.'
example: '2020-01-27T07:06:25Z'
type: string
VehicleStatsAuxInputValue:
description: Boolean indicating the state of the auxiliary equipment.
example: true
type: boolean
VehicleStatsDecorations_ecuSpeedMph:
properties:
value:
$ref: '#/components/schemas/VehicleStatsEcuSpeedMphValue'
required:
- value
type: object
VehicleStatsEvDistanceDrivenMeters:
description: Electric distance driven for electric and hybrid vehicles in meters. Not all EV and HEVs may report this field.
properties:
time:
$ref: '#/components/schemas/time'
value:
description: Electric distance driven for electric and hybrid vehicles in meters.
example: 1000
format: int64
type: integer
required:
- time
- value
type: object
VehicleStatsEcuSpeedMphValue:
description: The speed of the vehicle in miles per hour, as reported by the ECU.
example: 58.3
format: double
type: number
VehicleStatsEvRegeneratedEnergyMicroWh:
description: Regenerated energy for electric and hybrid vehicles in microwatt hours. Not all EV and HEVs may report this field.
properties:
time:
$ref: '#/components/schemas/time'
value:
description: Regenerated energy for electric and hybrid vehicles in microwatt hours.
example: 1000
format: int64
type: integer
required:
- time
- value
type: object
VehicleStatsResponse_evChargingEnergyMicroWh:
description: Charging energy for electric and hybrid vehicles in microwatt hours. Not all EV and HEVs may report this field.
properties:
time:
description: 'UTC timestamp in RFC 3339 format. Example: `2020-01-27T07:06:25Z`.'
example: '2020-01-27T07:06:25Z'
type: string
value:
description: Charging energy for electric and hybrid vehicles in microwatt hours.
example: 1000
format: int64
type: integer
required:
- time
- value
type: object
standardErrorResponse:
description: Error response
properties:
message:
description: The message of the error.
example: An error has occurred.
type: string
requestId:
description: The ID of the request.
example: 8916e1c1
type: string
type: object
VehicleStatsFuelPercentValue:
description: The engine fuel level in percentage points (e.g. `99`, `50`, etc).
example: 54
format: int64
type: integer
VehicleStatsFaultCodesOemTroubleCode:
description: Proprietary diagnostic trouble code for some OEM vehicles.
properties:
codeDescription:
description: The OEM code description.
example: KVGT Servo Error
type: string
codeIdentifier:
description: The OEM code identifier.
example: CA2387
type: string
codeSeverity:
description: The OEM code severity.
example: L03
type: string
codeSource:
description: The OEM code source.
example: ENG/M
type: string
type: object
VehicleAuxInputName:
description: 'The type of <a href="https://kb.samsara.com/hc/en-us/articles/360043040512-Auxiliary-Inputs" target="_blank">auxiliary input</a> configured for this Vehicle. Once configured, these inputs will generate dynamic, time-series data that will be available to view in the Samsara Dashboard. **By default**: empty. This can be set or updated through the Samsara Dashboard or the API at any time. Inputs 3-13 are only available on gateways with an attached aux expander. The value returned will match what is configured in the dashboard per vehicle.'
example: Boom
type: string
VehicleStatsFaultCodesJ1939TroubleCode:
description: Diagnostic trouble code for J1939 vehicles.
properties:
fmiDescription:
description: A short description of the FMI identifier, if available.
example: Voltage Below Normal
type: string
fmiId:
description: The FMI identifier.
example: 9
format: int32
type: integer
milStatus:
description: The MIL status, indicating a check engine light.
example: 1
format: int32
type: integer
occurrenceCount:
description: The number of times this fault has triggered.
example: 1
format: int32
type: integer
sourceAddressName:
description: The source address name corresponding to the txId
example: 'Engine #1'
type: string
spnDescription:
description: A short description of the SPN identifier, if available.
example: 'System Diagnostic Code #1'
type: string
spnId:
description: The SPN identifier.
example: 3031
format: int32
type: integer
txId:
$ref: '#/components/schemas/VehicleStatsFaultCodesTxId'
vendorSpecificFields:
$ref: '#/components/schemas/VehicleStatsFaultCodesVendorSpecificFields'
required:
- fmiId
- milStatus
- occurrenceCount
- spnId
- txId
type: object
VehicleStatsSpreaderPrewetName:
description: Name of most recent type of prewet material spread, read from the material spreader.
properties:
time:
$ref: '#/components/schemas/time'
value:
description: Name of most recent type of prewet material spread, read from the material spreader.
example: PWT1
type: string
required:
- time
- value
type: object
VehicleStatsFaultCodesJ1939TroubleCodes:
description: Diagnostic trouble codes for J1939 vehicles.
items:
$ref: '#/components/schemas/VehicleStatsFaultCodesJ1939TroubleCode'
type: array
VehicleStatsFaultCodesPassengerMonitorStatus:
description: Readings from engine sensors
properties:
catalyst:
$ref: '#/components/schemas/VehicleStatsFaultCodesPassengerMonitorStatusValue'
comprehensive:
$ref: '#/components/schemas/VehicleStatsFaultCodesPassengerMonitorStatusValue'
egr:
$ref: '#/components/schemas/VehicleStatsFaultCodesPassengerMonitorStatusValue'
evapSystem:
$ref: '#/components/schemas/VehicleStatsFaultCodesPassengerMonitorStatusValue'
fuel:
$ref: '#/components/schemas/VehicleStatsFaultCodesPassengerMonitorStatusValue'
heatedCatalyst:
$ref: '#/components/schemas/VehicleStatsFaultCodesPassengerMonitorStatusValue'
heatedO2Sensor:
$ref: '#/components/schemas/VehicleStatsFaultCodesPassengerMonitorStatusValue'
isoSaeReserved:
$ref: '#/components/schemas/VehicleStatsFaultCodesPassengerMonitorStatusValue'
misfire:
$ref: '#/components/schemas/VehicleStatsFaultCodesPassengerMonitorStatusValue'
notReadyCount:
description: 'Count of the number of sensors reporting N: Not Complete'
type: integer
o2Sensor:
$ref: '#/components/schemas/VehicleStatsFaultCodesPassengerMonitorStatusValue'
secondaryAir:
$ref: '#/components/schemas/VehicleStatsFaultCodesPassengerMonitorStatusValue'
type: object
VehicleStatsDecorations_gpsDistanceMeters:
properties:
value:
$ref: '#/components/schemas/VehicleStatsGpsDistanceMetersValue'
required:
- value
type: object
VehicleStatsGpsDistanceMetersValue:
description: Number of meters the vehicle has traveled since the gateway was installed, based on GPS calculations.
example: 81029.591434899
format: double
type: number
VehicleId:
description: The unique Samsara ID of the Vehicle. This is automatically generated when the Vehicle object is created. It cannot be changed.
example: '112'
type: string
VehicleStatsDecorations_engineStates:
properties:
value:
description: The state of the engine.
enum:
- 'Off'
- 'On'
- Idle
example: 'On'
type: string
required:
- value
type: object
VehicleStatsResponse_evAverageBatteryTemperatureMilliCelsius:
description: Battery temperature for electric and hybrid vehicles in milli celsius. Not all EV and HEVs may report this field.
properties:
time:
description: 'UTC timestamp in RFC 3339 format. Example: `2020-01-27T07:06:25Z`.'
example: '2020-01-27T07:06:25Z'
type: string
value:
description: Battery temperature for electric and hybrid vehicles in milli celsius.
example: 1000
format: int64
type: integer
required:
- time
- value
type: object
VehicleStatsEvChargingStatus:
description: Charging status for electric and hybrid vehicles. Not all EV and HEVs may report this field.
properties:
time:
$ref: '#/components/schemas/time'
value:
description: "Charging status for electric and hybrid vehicles. Statuses:\n unknown - 0,\n not charging - 1,\n charging - 2."
enum:
- 0
- 1
- 2
- 3
- 4
format: int64
type: integer
required:
- time
- value
type: object
vehicleStatsAuxInputTime:
description: 'UTC timestamp in RFC 3339 format. Example: `2020-01-27T07:06:25Z`.'
example: '2020-01-27T07:06:25Z'
type: string
x-go-gen-location: models
VehicleStatsIntakeManifoldTempMilliC:
description: Vehicle intake manifold temperature reading.
properties:
time:
$ref: '#/components/schemas/time'
value:
description: The intake manifold temperature reading in millidegree Celsius.
example: 88000
format: int64
type: integer
required:
- time
- value
type: object
VehicleStatsFaultCodesValue_obdii_monitorStatus:
description: Readings from engine sensors
properties:
catalyst:
description: 'Enum of monitor status:
-U: Unsupported
-N: Not Complete
-R: Complete
'
enum:
- N
- R
- U
type: string
comprehensive:
description: 'Enum of monitor status:
-U: Unsupported
-N: Not Complete
-R: Complete
'
enum:
- N
- R
- U
type: string
egr:
description: 'Enum of monitor status:
-U: Unsupported
-N: Not Complete
-R: Complete
'
enum:
- N
- R
- U
type: string
evapSystem:
description: 'Enum of monitor status:
-U: Unsupported
-N: Not Complete
-R: Complete
'
enum:
- N
- R
- U
type: string
fuel:
description: 'Enum of monitor status:
-U: Unsupported
-N: Not Complete
-R: Complete
'
enum:
- N
- R
- U
type: string
heatedCatalyst:
description: 'Enum of monitor status:
-U: Unsupported
-N: Not Complete
-R: Complete
'
enum:
- N
- R
- U
type: string
heatedO2Sensor:
description: 'Enum of monitor status:
-U: Unsupported
-N: Not Complete
-R: Complete
'
enum:
- N
- R
- U
type: string
isoSaeReserved:
description: 'Enum of monitor status:
-U: Unsupported
-N: Not Complete
-R: Complete
'
enum:
- N
- R
- U
type: string
misfire:
description: 'Enum of monitor status:
-U: Unsupported
-N: Not Complete
-R: Complete
'
enum:
- N
- R
- U
type: string
notReadyCount:
description: 'Count of the number of sensors reporting N: Not Complete'
type: integer
o2Sensor:
description: 'Enum of monitor status:
-U: Unsupported
-N: Not Complete
-R: Complete
'
enum:
- N
- R
- U
type: string
secondaryAir:
description: 'Enum of monitor status:
-U: Unsupported
-N: Not Complete
-R: Complete
'
enum:
- N
- R
- U
type: string
type: object
VehicleStatsNfcCardScan_card:
description: The card that was scanned.
properties:
id:
description: The id code of the card that was scanned.
example: '835063'
type: string
type: object
VehicleStatsResponse_spreaderRoadTemp:
description: Road temperature reading in milli celsius from material spreader.
properties:
time:
description: 'UTC timestamp in RFC 3339 format. Example: `2020-01-27T07:06:25Z`.'
example: '2020-01-27T07:06:25Z'
type: string
value:
description: Road temperature reading in milli celsius from material spreader.
example: 1000
format: int64
type: integer
required:
- time
- value
type: object
paginationResponse:
description: Pagination parameters.
properties:
endCursor:
description: Cursor identifier representing the last element in the response. This value should be used in conjunction with a subsequent request's 'after' query parameter. This may be an empty string if there are no more pages left to view.
example: MjkY
format: string
type: string
hasNextPage:
description: True if there are more pages of results immediately available after this endCursor.
example: true
type: boolean
required:
- endCursor
- hasNextPage
type: object
VehicleStatsEngineLoadPercentValue:
description: The engine load in percentage points (e.g. `99`, `50`, etc).
example: 54
format: int64
type: integer
VehicleStatsEngineRpmValue:
description: The revolutions per minute of the engine.
example: 1000
format: int64
type: integer
VehicleStatsSeatbeltDriver:
description: Seatbelt Driver Status as read from the vehicle. `Buckled` or `Unbuckled`.
properties:
time:
$ref: '#/components/schemas/time'
value:
description: Seatbelt Driver Status as read from the vehicle. `Buckled` or `Unbuckled`.
enum:
- Buckled
- Unbuckled
example: Buckled
type: string
required:
- time
- value
type: object
VehicleStatsSpreaderGranularName:
description: Name of most recent type of granular material spread, read from the material spreader.
properties:
time:
$ref: '#/components/schemas/time'
value:
description: Name of most recent type of granular material spread, read from the material spreader.
example: SALT
type: string
required:
- time
- value
type: object
VehicleStatsResponse_evConsumedEnergyMicroWh:
description: Consumed energy (including regenerated) for electric and hybrid vehicles in microwatt hours. Not all EV and HEVs may report this field.
properties:
time:
description: 'UTC timestamp in RFC 3339 format. Example: `2020-01-27T07:06:25Z`.'
example: '2020-01-27T07:06:25Z'
type: string
value:
description: Consumed energy (including regenerated) for electric and hybrid vehicles in microwatt hours.
example: 1000
format: int64
type: integer
required:
- time
- value
type: object
VehicleStatsResponse_spreaderGranularRate:
description: 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. Unfiltered live stats are supplied as-read from the Material Spreader unit. Readings do not consider total spread rate(s) over time or distance.
properties:
time:
description: 'UTC timestamp in RFC 3339 format. Example: `2020-01-27T07:06:25Z`.'
example: '2020-01-27T07:06:25Z'
type: string
value:
description: 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. Unfiltered live stats are supplied as-read from the Material Spreader unit. Readings do not consider total spread rate(s) over time or distance.
example: 1000
format: int64
type: integer
required:
# --- truncated at 32 KB (97 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/samsara/refs/heads/main/openapi/samsara-vehicle-stats-api-openapi.yml