/** * Samsara API * # Overview Something new! Welcome Samsara\'s new and improved API. Check out our FAQ [here](https://developers.samsara.com/docs/introducing-our-next-generation-api) to see what\'s changed and learn how to get started.

Want to access the legacy API docs? You can find them [here](https://www.samsara.com/api-legacy).

*Note: Because this is a new set of APIs, we have not transitioned all endpoints over to this standard. Endpoints that still use the legacy standards are indicated in the reference documentation. If you can\'t find an API that you\'re looking for, we encourage you to look for it in our [legacy API docs](https://www.samsara.com/api-legacy) as we continue to transition all endpoints over. Check back here for updates!*

Submit your feedback [here](https://forms.gle/r4bs6HQshQAvBuwv6)! Samsara provides API endpoints so that you can build powerful applications and custom solutions with sensor data. Samsara has endpoints available to track and analyze sensors, vehicles, and entire fleets. The Samsara API is a [RESTful API](https://en.wikipedia.org/wiki/Representational_state_transfer). It uses standard [HTTP](https://en.wikipedia.org/wiki/Hypertext_Transfer_Protocol) authentication, verbs, and response codes, and it returns [JSON](http://www.json.org/) response bodies. If you\'re familiar with what you can build with a REST API, then this will be your go-to API reference. Visit [developers.samsara.com](https://developers.samsara.com) to find getting started guides and an API overview. If you have any questions, please visit https://samsara.com/help. ## Endpoints All our APIs can be accessed through HTTP requests to URLs like: ``` https://api.samsara.com/ ``` For EU customers, this URL will be: ``` https://api.eu.samsara.com/ ``` Note Legacy endpoints will have the URL: `https://api.samsara.com/v1/` or `https://api.eu.samsara.com/v1/` ## Authentication To authenticate your API request you will need to include your secret token. You can manage your API tokens in the [Dashboard](https://cloud.samsara.com). They are visible under `Settings->Organization->API Tokens`. Your API tokens carry many privileges, so be sure to keep them secure. Do not share your secret API tokens in publicly accessible areas such as GitHub, client-side code, and so on. Authentication to the API is performed via Bearer Token in the HTTP Authorization header. Provide your API token as the `access_token` value in an `Authorization: Bearer` header. You do not need to provide a password: ```curl Authorization: Bearer {access_token} ``` All API requests must be made over [HTTPS](https://en.wikipedia.org/wiki/HTTPS). Calls made over plain HTTP or without authentication will fail. ### OAuth2 If building an application for our marketplace, our API is accessible via. OAuth2 as well. | Type | Value | | ------------- |:-------------:| | Security scheme | OAuth2 | | OAuth2 Flow | accessCode | | Authorization URL | https://api.samsara.com/oauth2/authorize | | Token URL | https://api.samsara.com/oauth2/token | ## Common Patterns You can find more info about request methods, response codes, error codes, versioning, pagination, timestamps, and mini-objects [here](https://developers.samsara.com/docs/common-structures). * * The version of the OpenAPI document: 2024-11-18 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. */ import type { Configuration } from '../configuration'; import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios'; import { RequestArgs, BaseAPI } from '../base'; import { VehicleStatsListResponse } from '../samsara-models'; import { VehicleStatsResponse } from '../samsara-models'; /** * VehicleStatsApi - axios parameter creator * @export */ export declare const VehicleStatsApiAxiosParamCreator: (configuration?: Configuration) => { /** * Returns the last known stats of all vehicles at the given `time`. If no `time` is specified, the current time is used. Related guide: Telematics. **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our API feedback form. If you encountered an issue or noticed inaccuracies in the API documentation, please submit a case to our support team. To use this endpoint, select **Read Vehicle Statistics** under the Vehicles category when creating or editing an API token. Learn More. * @summary Stats snapshot * @param {Array} types 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. 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 <a href=\"https://kb.samsara.com/hc/en-us/articles/360043040512-Auxiliary-Inputs\" target=\"_blank\">auxiliary inputs</a> 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 <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). - `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). - `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}](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`. - `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. - `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`. - `syntheticEngineSeconds`: Data for the synthetic engine seconds for the vehicle. - `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) * @param {string} [after] 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. * @param {string} [time] 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`). * @param {Array} [parentTagIds] 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` * @param {Array} [tagIds] A filter on the data based on this comma-separated list of tag IDs. Example: `tagIds=1234,5678` * @param {Array} [vehicleIds] A filter on the data based on this comma-separated list of vehicle IDs. Example: `vehicleIds=1234,5678` * @param {*} [options] Override http request option. * @throws {RequiredError} */ getVehicleStats: (types: Array, after?: string, time?: string, parentTagIds?: Array, tagIds?: Array, vehicleIds?: Array, options?: RawAxiosRequestConfig) => Promise; /** * Follow a feed of vehicle stats. Your first call to this endpoint will provide you with the most recent stats for each vehicle and an `endCursor`. You can the provide the `endCursor` value to the `after` query parameter to get all updates since the last call you made. If `hasNextPage` is `false`, no new data is immediately available. You should wait a minimum of 5 seconds making a subsequent request. Related guide: Telematics. **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our API feedback form. If you encountered an issue or noticed inaccuracies in the API documentation, please submit a case to our support team. To use this endpoint, select **Read Vehicle Statistics** under the Vehicles category when creating or editing an API token. Learn More. * @summary Stats feed * @param {Array} types 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. 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 <a href=\"https://kb.samsara.com/hc/en-us/articles/360043040512-Auxiliary-Inputs\" target=\"_blank\">auxiliary inputs</a> 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 <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). - `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). - `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}](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`. - `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. - `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`. - `syntheticEngineSeconds`: Data for the synthetic engine seconds for the vehicle. - `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) * @param {string} [after] 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. * @param {Array} [parentTagIds] 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` * @param {Array} [tagIds] A filter on the data based on this comma-separated list of tag IDs. Example: `tagIds=1234,5678` * @param {Array} [vehicleIds] A filter on the data based on this comma-separated list of vehicle IDs. Example: `vehicleIds=1234,5678` * @param {Array} [decorations] 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 <a href=\"/docs/telematics#query-parameters\" target=\"_blank\">Telematics</a> 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 <a href=\"https://kb.samsara.com/hc/en-us/articles/360043040512-Auxiliary-Inputs\" target=\"_blank\">auxiliary inputs</a> 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 <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). - `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). - `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. - `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. - `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`: Data for the synthetic engine seconds for the vehicle. - `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) * @param {*} [options] Override http request option. * @throws {RequiredError} */ getVehicleStatsFeed: (types: Array, after?: string, parentTagIds?: Array, tagIds?: Array, vehicleIds?: Array, decorations?: Array, options?: RawAxiosRequestConfig) => Promise; /** * Returns vehicle stats during the given time range for all vehicles. This can be optionally filtered by tags or specific vehicle IDs. Related guide: Telematics. **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our API feedback form. If you encountered an issue or noticed inaccuracies in the API documentation, please submit a case to our support team. To use this endpoint, select **Read Vehicle Statistics** under the Vehicles category when creating or editing an API token. Learn More. * @summary Historical stats * @param {string} startTime A start time in RFC 3339 format. Millisecond precision and timezones are supported. (Examples: 2019-06-13T19:08:25Z, 2019-06-13T19:08:25.455Z, OR 2015-09-15T14:00:12-04:00). * @param {string} endTime An end time in RFC 3339 format. Millisecond precision and timezones are supported. (Examples: 2019-06-13T19:08:25Z, 2019-06-13T19:08:25.455Z, OR 2015-09-15T14:00:12-04:00). * @param {Array} types 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. 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 <a href=\"https://kb.samsara.com/hc/en-us/articles/360043040512-Auxiliary-Inputs\" target=\"_blank\">auxiliary inputs</a> 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 <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). - `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). - `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}](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`. - `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. - `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`. - `syntheticEngineSeconds`: Data for the synthetic engine seconds for the vehicle. - `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) * @param {string} [after] 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. * @param {Array} [parentTagIds] 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` * @param {Array} [tagIds] A filter on the data based on this comma-separated list of tag IDs. Example: `tagIds=1234,5678` * @param {Array} [vehicleIds] A filter on the data based on this comma-separated list of vehicle IDs. Example: `vehicleIds=1234,5678` * @param {Array} [decorations] 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 <a href=\"/docs/telematics#query-parameters\" target=\"_blank\">Telematics</a> 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 <a href=\"https://kb.samsara.com/hc/en-us/articles/360043040512-Auxiliary-Inputs\" target=\"_blank\">auxiliary inputs</a> 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 <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). - `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). - `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. - `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. - `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`: Data for the synthetic engine seconds for the vehicle. - `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) * @param {*} [options] Override http request option. * @throws {RequiredError} */ getVehicleStatsHistory: (startTime: string, endTime: string, types: Array, after?: string, parentTagIds?: Array, tagIds?: Array, vehicleIds?: Array, decorations?: Array, options?: RawAxiosRequestConfig) => Promise; }; /** * VehicleStatsApi - functional programming interface * @export */ export declare const VehicleStatsApiFp: (configuration?: Configuration) => { /** * Returns the last known stats of all vehicles at the given `time`. If no `time` is specified, the current time is used. Related guide: Telematics. **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our API feedback form. If you encountered an issue or noticed inaccuracies in the API documentation, please submit a case to our support team. To use this endpoint, select **Read Vehicle Statistics** under the Vehicles category when creating or editing an API token. Learn More. * @summary Stats snapshot * @param {Array} types 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. 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 <a href=\"https://kb.samsara.com/hc/en-us/articles/360043040512-Auxiliary-Inputs\" target=\"_blank\">auxiliary inputs</a> 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 <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). - `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). - `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}](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`. - `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. - `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`. - `syntheticEngineSeconds`: Data for the synthetic engine seconds for the vehicle. - `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) * @param {string} [after] 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. * @param {string} [time] 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`). * @param {Array} [parentTagIds] 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` * @param {Array} [tagIds] A filter on the data based on this comma-separated list of tag IDs. Example: `tagIds=1234,5678` * @param {Array} [vehicleIds] A filter on the data based on this comma-separated list of vehicle IDs. Example: `vehicleIds=1234,5678` * @param {*} [options] Override http request option. * @throws {RequiredError} */ getVehicleStats(types: Array, after?: string, time?: string, parentTagIds?: Array, tagIds?: Array, vehicleIds?: Array, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Follow a feed of vehicle stats. Your first call to this endpoint will provide you with the most recent stats for each vehicle and an `endCursor`. You can the provide the `endCursor` value to the `after` query parameter to get all updates since the last call you made. If `hasNextPage` is `false`, no new data is immediately available. You should wait a minimum of 5 seconds making a subsequent request. Related guide: Telematics. **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our API feedback form. If you encountered an issue or noticed inaccuracies in the API documentation, please submit a case to our support team. To use this endpoint, select **Read Vehicle Statistics** under the Vehicles category when creating or editing an API token. Learn More. * @summary Stats feed * @param {Array} types 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. 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 <a href=\"https://kb.samsara.com/hc/en-us/articles/360043040512-Auxiliary-Inputs\" target=\"_blank\">auxiliary inputs</a> 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 <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). - `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). - `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}](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`. - `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. - `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`. - `syntheticEngineSeconds`: Data for the synthetic engine seconds for the vehicle. - `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) * @param {string} [after] 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. * @param {Array} [parentTagIds] 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` * @param {Array} [tagIds] A filter on the data based on this comma-separated list of tag IDs. Example: `tagIds=1234,5678` * @param {Array} [vehicleIds] A filter on the data based on this comma-separated list of vehicle IDs. Example: `vehicleIds=1234,5678` * @param {Array} [decorations] 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 <a href=\"/docs/telematics#query-parameters\" target=\"_blank\">Telematics</a> 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 <a href=\"https://kb.samsara.com/hc/en-us/articles/360043040512-Auxiliary-Inputs\" target=\"_blank\">auxiliary inputs</a> 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 <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). - `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). - `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. - `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. - `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`: Data for the synthetic engine seconds for the vehicle. - `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) * @param {*} [options] Override http request option. * @throws {RequiredError} */ getVehicleStatsFeed(types: Array, after?: string, parentTagIds?: Array, tagIds?: Array, vehicleIds?: Array, decorations?: Array, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Returns vehicle stats during the given time range for all vehicles. This can be optionally filtered by tags or specific vehicle IDs. Related guide: Telematics. **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our API feedback form. If you encountered an issue or noticed inaccuracies in the API documentation, please submit a case to our support team. To use this endpoint, select **Read Vehicle Statistics** under the Vehicles category when creating or editing an API token. Learn More. * @summary Historical stats * @param {string} startTime A start time in RFC 3339 format. Millisecond precision and timezones are supported. (Examples: 2019-06-13T19:08:25Z, 2019-06-13T19:08:25.455Z, OR 2015-09-15T14:00:12-04:00). * @param {string} endTime An end time in RFC 3339 format. Millisecond precision and timezones are supported. (Examples: 2019-06-13T19:08:25Z, 2019-06-13T19:08:25.455Z, OR 2015-09-15T14:00:12-04:00). * @param {Array} types 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. 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 <a href=\"https://kb.samsara.com/hc/en-us/articles/360043040512-Auxiliary-Inputs\" target=\"_blank\">auxiliary inputs</a> 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 <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). - `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). - `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}](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`. - `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. - `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`. - `syntheticEngineSeconds`: Data for the synthetic engine seconds for the vehicle. - `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) * @param {string} [after] 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. * @param {Array} [parentTagIds] 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` * @param {Array} [tagIds] A filter on the data based on this comma-separated list of tag IDs. Example: `tagIds=1234,5678` * @param {Array} [vehicleIds] A filter on the data based on this comma-separated list of vehicle IDs. Example: `vehicleIds=1234,5678` * @param {Array} [decorations] 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 <a href=\"/docs/telematics#query-parameters\" target=\"_blank\">Telematics</a> 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 <a href=\"https://kb.samsara.com/hc/en-us/articles/360043040512-Auxiliary-Inputs\" target=\"_blank\">auxiliary inputs</a> 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 <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). - `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). - `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. - `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. - `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`: Data for the synthetic engine seconds for the vehicle. - `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) * @param {*} [options] Override http request option. * @throws {RequiredError} */ getVehicleStatsHistory(startTime: string, endTime: string, types: Array, after?: string, parentTagIds?: Array, tagIds?: Array, vehicleIds?: Array, decorations?: Array, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * VehicleStatsApi - factory interface * @export */ export declare const VehicleStatsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * Returns the last known stats of all vehicles at the given `time`. If no `time` is specified, the current time is used. Related guide: Telematics. **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our API feedback form. If you encountered an issue or noticed inaccuracies in the API documentation, please submit a case to our support team. To use this endpoint, select **Read Vehicle Statistics** under the Vehicles category when creating or editing an API token. Learn More. * @summary Stats snapshot * @param {VehicleStatsApiGetVehicleStatsRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getVehicleStats(requestParameters: VehicleStatsApiGetVehicleStatsRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Follow a feed of vehicle stats. Your first call to this endpoint will provide you with the most recent stats for each vehicle and an `endCursor`. You can the provide the `endCursor` value to the `after` query parameter to get all updates since the last call you made. If `hasNextPage` is `false`, no new data is immediately available. You should wait a minimum of 5 seconds making a subsequent request. Related guide: Telematics. **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our API feedback form. If you encountered an issue or noticed inaccuracies in the API documentation, please submit a case to our support team. To use this endpoint, select **Read Vehicle Statistics** under the Vehicles category when creating or editing an API token. Learn More. * @summary Stats feed * @param {VehicleStatsApiGetVehicleStatsFeedRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getVehicleStatsFeed(requestParameters: VehicleStatsApiGetVehicleStatsFeedRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Returns vehicle stats during the given time range for all vehicles. This can be optionally filtered by tags or specific vehicle IDs. Related guide: Telematics. **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our API feedback form. If you encountered an issue or noticed inaccuracies in the API documentation, please submit a case to our support team. To use this endpoint, select **Read Vehicle Statistics** under the Vehicles category when creating or editing an API token. Learn More. * @summary Historical stats * @param {VehicleStatsApiGetVehicleStatsHistoryRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getVehicleStatsHistory(requestParameters: VehicleStatsApiGetVehicleStatsHistoryRequest, options?: RawAxiosRequestConfig): AxiosPromise; }; /** * Request parameters for getVehicleStats operation in VehicleStatsApi. * @export * @interface VehicleStatsApiGetVehicleStatsRequest */ export interface VehicleStatsApiGetVehicleStatsRequest { /** * 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. 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 <a href=\"https://kb.samsara.com/hc/en-us/articles/360043040512-Auxiliary-Inputs\" target=\"_blank\">auxiliary inputs</a> 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 <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). - `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). - `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}](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`. - `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. - `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`. - `syntheticEngineSeconds`: Data for the synthetic engine seconds for the vehicle. - `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) * @type {Array<'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'>} * @memberof VehicleStatsApiGetVehicleStats */ readonly types: Array; /** * 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. * @type {string} * @memberof VehicleStatsApiGetVehicleStats */ readonly after?: string; /** * 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`). * @type {string} * @memberof VehicleStatsApiGetVehicleStats */ readonly time?: string; /** * 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` * @type {Array} * @memberof VehicleStatsApiGetVehicleStats */ readonly parentTagIds?: Array; /** * A filter on the data based on this comma-separated list of tag IDs. Example: `tagIds=1234,5678` * @type {Array} * @memberof VehicleStatsApiGetVehicleStats */ readonly tagIds?: Array; /** * A filter on the data based on this comma-separated list of vehicle IDs. Example: `vehicleIds=1234,5678` * @type {Array} * @memberof VehicleStatsApiGetVehicleStats */ readonly vehicleIds?: Array; } /** * Request parameters for getVehicleStatsFeed operation in VehicleStatsApi. * @export * @interface VehicleStatsApiGetVehicleStatsFeedRequest */ export interface VehicleStatsApiGetVehicleStatsFeedRequest { /** * 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. 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 <a href=\"https://kb.samsara.com/hc/en-us/articles/360043040512-Auxiliary-Inputs\" target=\"_blank\">auxiliary inputs</a> 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 <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). - `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). - `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}](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`. - `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. - `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`. - `syntheticEngineSeconds`: Data for the synthetic engine seconds for the vehicle. - `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) * @type {Array<'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'>} * @memberof VehicleStatsApiGetVehicleStatsFeed */ readonly types: Array; /** * 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. * @type {string} * @memberof VehicleStatsApiGetVehicleStatsFeed */ readonly after?: string; /** * 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` * @type {Array} * @memberof VehicleStatsApiGetVehicleStatsFeed */ readonly parentTagIds?: Array; /** * A filter on the data based on this comma-separated list of tag IDs. Example: `tagIds=1234,5678` * @type {Array} * @memberof VehicleStatsApiGetVehicleStatsFeed */ readonly tagIds?: Array; /** * A filter on the data based on this comma-separated list of vehicle IDs. Example: `vehicleIds=1234,5678` * @type {Array} * @memberof VehicleStatsApiGetVehicleStatsFeed */ readonly vehicleIds?: Array; /** * 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 <a href=\"/docs/telematics#query-parameters\" target=\"_blank\">Telematics</a> 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 <a href=\"https://kb.samsara.com/hc/en-us/articles/360043040512-Auxiliary-Inputs\" target=\"_blank\">auxiliary inputs</a> 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 <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). - `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). - `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. - `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. - `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`: Data for the synthetic engine seconds for the vehicle. - `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) * @type {Array<'ambientAirTemperatureMilliC' | 'auxInput1' | 'auxInput2' | 'auxInput3' | 'auxInput4' | 'auxInput5' | 'auxInput6' | 'auxInput7' | 'auxInput8' | 'auxInput9' | 'auxInput10' | 'auxInput11' | 'auxInput12' | 'auxInput13' | 'batteryMilliVolts' | 'barometricPressurePa' | 'defLevelMilliPercent' | 'ecuSpeedMph' | 'engineCoolantTemperatureMilliC' | 'engineImmobilizer' | 'engineLoadPercent' | 'engineOilPressureKPa' | 'engineRpm' | 'engineStates' | 'faultCodes' | 'fuelPercents' | 'gps' | 'gpsDistanceMeters' | 'intakeManifoldTemperatureMilliC' | 'nfcCardScans' | 'obdEngineSeconds' | 'obdOdometerMeters' | 'spreaderLiquidRate' | 'spreaderGranularRate' | 'spreaderPrewetRate' | 'spreaderAirTemp' | 'spreaderRoadTemp' | 'spreaderOnState' | 'spreaderActive' | 'spreaderBlastState' | 'spreaderGranularName' | 'spreaderPrewetName' | 'spreaderLiquidName' | 'spreaderPlowStatus' | 'seatbeltDriver'>} * @memberof VehicleStatsApiGetVehicleStatsFeed */ readonly decorations?: Array; } /** * Request parameters for getVehicleStatsHistory operation in VehicleStatsApi. * @export * @interface VehicleStatsApiGetVehicleStatsHistoryRequest */ export interface VehicleStatsApiGetVehicleStatsHistoryRequest { /** * A start time in RFC 3339 format. Millisecond precision and timezones are supported. (Examples: 2019-06-13T19:08:25Z, 2019-06-13T19:08:25.455Z, OR 2015-09-15T14:00:12-04:00). * @type {string} * @memberof VehicleStatsApiGetVehicleStatsHistory */ readonly startTime: string; /** * An end time in RFC 3339 format. Millisecond precision and timezones are supported. (Examples: 2019-06-13T19:08:25Z, 2019-06-13T19:08:25.455Z, OR 2015-09-15T14:00:12-04:00). * @type {string} * @memberof VehicleStatsApiGetVehicleStatsHistory */ readonly endTime: string; /** * 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. 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 <a href=\"https://kb.samsara.com/hc/en-us/articles/360043040512-Auxiliary-Inputs\" target=\"_blank\">auxiliary inputs</a> 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 <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). - `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). - `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}](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`. - `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. - `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`. - `syntheticEngineSeconds`: Data for the synthetic engine seconds for the vehicle. - `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) * @type {Array<'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'>} * @memberof VehicleStatsApiGetVehicleStatsHistory */ readonly types: Array; /** * 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. * @type {string} * @memberof VehicleStatsApiGetVehicleStatsHistory */ readonly after?: string; /** * 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` * @type {Array} * @memberof VehicleStatsApiGetVehicleStatsHistory */ readonly parentTagIds?: Array; /** * A filter on the data based on this comma-separated list of tag IDs. Example: `tagIds=1234,5678` * @type {Array} * @memberof VehicleStatsApiGetVehicleStatsHistory */ readonly tagIds?: Array; /** * A filter on the data based on this comma-separated list of vehicle IDs. Example: `vehicleIds=1234,5678` * @type {Array} * @memberof VehicleStatsApiGetVehicleStatsHistory */ readonly vehicleIds?: Array; /** * 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 <a href=\"/docs/telematics#query-parameters\" target=\"_blank\">Telematics</a> 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 <a href=\"https://kb.samsara.com/hc/en-us/articles/360043040512-Auxiliary-Inputs\" target=\"_blank\">auxiliary inputs</a> 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 <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). - `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). - `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. - `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. - `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`: Data for the synthetic engine seconds for the vehicle. - `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) * @type {Array<'ambientAirTemperatureMilliC' | 'auxInput1' | 'auxInput2' | 'auxInput3' | 'auxInput4' | 'auxInput5' | 'auxInput6' | 'auxInput7' | 'auxInput8' | 'auxInput9' | 'auxInput10' | 'auxInput11' | 'auxInput12' | 'auxInput13' | 'batteryMilliVolts' | 'barometricPressurePa' | 'defLevelMilliPercent' | 'ecuSpeedMph' | 'engineCoolantTemperatureMilliC' | 'engineImmobilizer' | 'engineLoadPercent' | 'engineOilPressureKPa' | 'engineRpm' | 'engineStates' | 'faultCodes' | 'fuelPercents' | 'gps' | 'gpsDistanceMeters' | 'intakeManifoldTemperatureMilliC' | 'nfcCardScans' | 'obdEngineSeconds' | 'obdOdometerMeters' | 'spreaderLiquidRate' | 'spreaderGranularRate' | 'spreaderPrewetRate' | 'spreaderAirTemp' | 'spreaderRoadTemp' | 'spreaderOnState' | 'spreaderActive' | 'spreaderBlastState' | 'spreaderGranularName' | 'spreaderPrewetName' | 'spreaderLiquidName' | 'spreaderPlowStatus' | 'seatbeltDriver'>} * @memberof VehicleStatsApiGetVehicleStatsHistory */ readonly decorations?: Array; } /** * VehicleStatsApi - object-oriented interface * @export * @class VehicleStatsApi * @extends {BaseAPI} */ export declare class VehicleStatsApi extends BaseAPI { /** * Returns the last known stats of all vehicles at the given `time`. If no `time` is specified, the current time is used. Related guide: Telematics. **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our API feedback form. If you encountered an issue or noticed inaccuracies in the API documentation, please submit a case to our support team. To use this endpoint, select **Read Vehicle Statistics** under the Vehicles category when creating or editing an API token. Learn More. * @summary Stats snapshot * @param {VehicleStatsApiGetVehicleStatsRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof VehicleStatsApi */ getVehicleStats(requestParameters: VehicleStatsApiGetVehicleStatsRequest, options?: RawAxiosRequestConfig): Promise>; /** * Follow a feed of vehicle stats. Your first call to this endpoint will provide you with the most recent stats for each vehicle and an `endCursor`. You can the provide the `endCursor` value to the `after` query parameter to get all updates since the last call you made. If `hasNextPage` is `false`, no new data is immediately available. You should wait a minimum of 5 seconds making a subsequent request. Related guide: Telematics. **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our API feedback form. If you encountered an issue or noticed inaccuracies in the API documentation, please submit a case to our support team. To use this endpoint, select **Read Vehicle Statistics** under the Vehicles category when creating or editing an API token. Learn More. * @summary Stats feed * @param {VehicleStatsApiGetVehicleStatsFeedRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof VehicleStatsApi */ getVehicleStatsFeed(requestParameters: VehicleStatsApiGetVehicleStatsFeedRequest, options?: RawAxiosRequestConfig): Promise>; /** * Returns vehicle stats during the given time range for all vehicles. This can be optionally filtered by tags or specific vehicle IDs. Related guide: Telematics. **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our API feedback form. If you encountered an issue or noticed inaccuracies in the API documentation, please submit a case to our support team. To use this endpoint, select **Read Vehicle Statistics** under the Vehicles category when creating or editing an API token. Learn More. * @summary Historical stats * @param {VehicleStatsApiGetVehicleStatsHistoryRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof VehicleStatsApi */ getVehicleStatsHistory(requestParameters: VehicleStatsApiGetVehicleStatsHistoryRequest, options?: RawAxiosRequestConfig): Promise>; } /** * @export */ export declare const GetVehicleStatsTypesEnum: { readonly AmbientAirTemperatureMilliC: "ambientAirTemperatureMilliC"; readonly AuxInput1: "auxInput1"; readonly AuxInput2: "auxInput2"; readonly AuxInput3: "auxInput3"; readonly AuxInput4: "auxInput4"; readonly AuxInput5: "auxInput5"; readonly AuxInput6: "auxInput6"; readonly AuxInput7: "auxInput7"; readonly AuxInput8: "auxInput8"; readonly AuxInput9: "auxInput9"; readonly AuxInput10: "auxInput10"; readonly AuxInput11: "auxInput11"; readonly AuxInput12: "auxInput12"; readonly AuxInput13: "auxInput13"; readonly BarometricPressurePa: "barometricPressurePa"; readonly BatteryMilliVolts: "batteryMilliVolts"; readonly DefLevelMilliPercent: "defLevelMilliPercent"; readonly EcuSpeedMph: "ecuSpeedMph"; readonly EngineCoolantTemperatureMilliC: "engineCoolantTemperatureMilliC"; readonly EngineImmobilizer: "engineImmobilizer"; readonly EngineLoadPercent: "engineLoadPercent"; readonly EngineOilPressureKpa: "engineOilPressureKPa"; readonly EngineRpm: "engineRpm"; readonly EngineStates: "engineStates"; readonly FaultCodes: "faultCodes"; readonly FuelPercents: "fuelPercents"; readonly Gps: "gps"; readonly GpsDistanceMeters: "gpsDistanceMeters"; readonly GpsOdometerMeters: "gpsOdometerMeters"; readonly IntakeManifoldTemperatureMilliC: "intakeManifoldTemperatureMilliC"; readonly NfcCardScans: "nfcCardScans"; readonly ObdEngineSeconds: "obdEngineSeconds"; readonly ObdOdometerMeters: "obdOdometerMeters"; readonly SyntheticEngineSeconds: "syntheticEngineSeconds"; readonly EvStateOfChargeMilliPercent: "evStateOfChargeMilliPercent"; readonly EvChargingStatus: "evChargingStatus"; readonly EvChargingEnergyMicroWh: "evChargingEnergyMicroWh"; readonly EvChargingVoltageMilliVolt: "evChargingVoltageMilliVolt"; readonly EvChargingCurrentMilliAmp: "evChargingCurrentMilliAmp"; readonly EvConsumedEnergyMicroWh: "evConsumedEnergyMicroWh"; readonly EvRegeneratedEnergyMicroWh: "evRegeneratedEnergyMicroWh"; readonly EvBatteryVoltageMilliVolt: "evBatteryVoltageMilliVolt"; readonly EvBatteryCurrentMilliAmp: "evBatteryCurrentMilliAmp"; readonly EvBatteryStateOfHealthMilliPercent: "evBatteryStateOfHealthMilliPercent"; readonly EvAverageBatteryTemperatureMilliCelsius: "evAverageBatteryTemperatureMilliCelsius"; readonly EvDistanceDrivenMeters: "evDistanceDrivenMeters"; readonly SpreaderLiquidRate: "spreaderLiquidRate"; readonly SpreaderGranularRate: "spreaderGranularRate"; readonly SpreaderPrewetRate: "spreaderPrewetRate"; readonly SpreaderAirTemp: "spreaderAirTemp"; readonly SpreaderRoadTemp: "spreaderRoadTemp"; readonly SpreaderOnState: "spreaderOnState"; readonly SpreaderActive: "spreaderActive"; readonly SpreaderBlastState: "spreaderBlastState"; readonly SpreaderGranularName: "spreaderGranularName"; readonly SpreaderPrewetName: "spreaderPrewetName"; readonly SpreaderLiquidName: "spreaderLiquidName"; readonly SpreaderPlowStatus: "spreaderPlowStatus"; readonly SeatbeltDriver: "seatbeltDriver"; }; export type GetVehicleStatsTypesEnum = typeof GetVehicleStatsTypesEnum[keyof typeof GetVehicleStatsTypesEnum]; /** * @export */ export declare const GetVehicleStatsFeedTypesEnum: { readonly AmbientAirTemperatureMilliC: "ambientAirTemperatureMilliC"; readonly AuxInput1: "auxInput1"; readonly AuxInput2: "auxInput2"; readonly AuxInput3: "auxInput3"; readonly AuxInput4: "auxInput4"; readonly AuxInput5: "auxInput5"; readonly AuxInput6: "auxInput6"; readonly AuxInput7: "auxInput7"; readonly AuxInput8: "auxInput8"; readonly AuxInput9: "auxInput9"; readonly AuxInput10: "auxInput10"; readonly AuxInput11: "auxInput11"; readonly AuxInput12: "auxInput12"; readonly AuxInput13: "auxInput13"; readonly BarometricPressurePa: "barometricPressurePa"; readonly BatteryMilliVolts: "batteryMilliVolts"; readonly DefLevelMilliPercent: "defLevelMilliPercent"; readonly EcuSpeedMph: "ecuSpeedMph"; readonly EngineCoolantTemperatureMilliC: "engineCoolantTemperatureMilliC"; readonly EngineImmobilizer: "engineImmobilizer"; readonly EngineLoadPercent: "engineLoadPercent"; readonly EngineOilPressureKpa: "engineOilPressureKPa"; readonly EngineRpm: "engineRpm"; readonly EngineStates: "engineStates"; readonly FaultCodes: "faultCodes"; readonly FuelPercents: "fuelPercents"; readonly Gps: "gps"; readonly GpsDistanceMeters: "gpsDistanceMeters"; readonly GpsOdometerMeters: "gpsOdometerMeters"; readonly IntakeManifoldTemperatureMilliC: "intakeManifoldTemperatureMilliC"; readonly NfcCardScans: "nfcCardScans"; readonly ObdEngineSeconds: "obdEngineSeconds"; readonly ObdOdometerMeters: "obdOdometerMeters"; readonly SyntheticEngineSeconds: "syntheticEngineSeconds"; readonly EvStateOfChargeMilliPercent: "evStateOfChargeMilliPercent"; readonly EvChargingStatus: "evChargingStatus"; readonly EvChargingEnergyMicroWh: "evChargingEnergyMicroWh"; readonly EvChargingVoltageMilliVolt: "evChargingVoltageMilliVolt"; readonly EvChargingCurrentMilliAmp: "evChargingCurrentMilliAmp"; readonly EvConsumedEnergyMicroWh: "evConsumedEnergyMicroWh"; readonly EvRegeneratedEnergyMicroWh: "evRegeneratedEnergyMicroWh"; readonly EvBatteryVoltageMilliVolt: "evBatteryVoltageMilliVolt"; readonly EvBatteryCurrentMilliAmp: "evBatteryCurrentMilliAmp"; readonly EvBatteryStateOfHealthMilliPercent: "evBatteryStateOfHealthMilliPercent"; readonly EvAverageBatteryTemperatureMilliCelsius: "evAverageBatteryTemperatureMilliCelsius"; readonly EvDistanceDrivenMeters: "evDistanceDrivenMeters"; readonly SpreaderLiquidRate: "spreaderLiquidRate"; readonly SpreaderGranularRate: "spreaderGranularRate"; readonly SpreaderPrewetRate: "spreaderPrewetRate"; readonly SpreaderAirTemp: "spreaderAirTemp"; readonly SpreaderRoadTemp: "spreaderRoadTemp"; readonly SpreaderOnState: "spreaderOnState"; readonly SpreaderActive: "spreaderActive"; readonly SpreaderBlastState: "spreaderBlastState"; readonly SpreaderGranularName: "spreaderGranularName"; readonly SpreaderPrewetName: "spreaderPrewetName"; readonly SpreaderLiquidName: "spreaderLiquidName"; readonly SpreaderPlowStatus: "spreaderPlowStatus"; readonly SeatbeltDriver: "seatbeltDriver"; }; export type GetVehicleStatsFeedTypesEnum = typeof GetVehicleStatsFeedTypesEnum[keyof typeof GetVehicleStatsFeedTypesEnum]; /** * @export */ export declare const GetVehicleStatsFeedDecorationsEnum: { readonly AmbientAirTemperatureMilliC: "ambientAirTemperatureMilliC"; readonly AuxInput1: "auxInput1"; readonly AuxInput2: "auxInput2"; readonly AuxInput3: "auxInput3"; readonly AuxInput4: "auxInput4"; readonly AuxInput5: "auxInput5"; readonly AuxInput6: "auxInput6"; readonly AuxInput7: "auxInput7"; readonly AuxInput8: "auxInput8"; readonly AuxInput9: "auxInput9"; readonly AuxInput10: "auxInput10"; readonly AuxInput11: "auxInput11"; readonly AuxInput12: "auxInput12"; readonly AuxInput13: "auxInput13"; readonly BatteryMilliVolts: "batteryMilliVolts"; readonly BarometricPressurePa: "barometricPressurePa"; readonly DefLevelMilliPercent: "defLevelMilliPercent"; readonly EcuSpeedMph: "ecuSpeedMph"; readonly EngineCoolantTemperatureMilliC: "engineCoolantTemperatureMilliC"; readonly EngineImmobilizer: "engineImmobilizer"; readonly EngineLoadPercent: "engineLoadPercent"; readonly EngineOilPressureKpa: "engineOilPressureKPa"; readonly EngineRpm: "engineRpm"; readonly EngineStates: "engineStates"; readonly FaultCodes: "faultCodes"; readonly FuelPercents: "fuelPercents"; readonly Gps: "gps"; readonly GpsDistanceMeters: "gpsDistanceMeters"; readonly IntakeManifoldTemperatureMilliC: "intakeManifoldTemperatureMilliC"; readonly NfcCardScans: "nfcCardScans"; readonly ObdEngineSeconds: "obdEngineSeconds"; readonly ObdOdometerMeters: "obdOdometerMeters"; readonly SpreaderLiquidRate: "spreaderLiquidRate"; readonly SpreaderGranularRate: "spreaderGranularRate"; readonly SpreaderPrewetRate: "spreaderPrewetRate"; readonly SpreaderAirTemp: "spreaderAirTemp"; readonly SpreaderRoadTemp: "spreaderRoadTemp"; readonly SpreaderOnState: "spreaderOnState"; readonly SpreaderActive: "spreaderActive"; readonly SpreaderBlastState: "spreaderBlastState"; readonly SpreaderGranularName: "spreaderGranularName"; readonly SpreaderPrewetName: "spreaderPrewetName"; readonly SpreaderLiquidName: "spreaderLiquidName"; readonly SpreaderPlowStatus: "spreaderPlowStatus"; readonly SeatbeltDriver: "seatbeltDriver"; }; export type GetVehicleStatsFeedDecorationsEnum = typeof GetVehicleStatsFeedDecorationsEnum[keyof typeof GetVehicleStatsFeedDecorationsEnum]; /** * @export */ export declare const GetVehicleStatsHistoryTypesEnum: { readonly AmbientAirTemperatureMilliC: "ambientAirTemperatureMilliC"; readonly AuxInput1: "auxInput1"; readonly AuxInput2: "auxInput2"; readonly AuxInput3: "auxInput3"; readonly AuxInput4: "auxInput4"; readonly AuxInput5: "auxInput5"; readonly AuxInput6: "auxInput6"; readonly AuxInput7: "auxInput7"; readonly AuxInput8: "auxInput8"; readonly AuxInput9: "auxInput9"; readonly AuxInput10: "auxInput10"; readonly AuxInput11: "auxInput11"; readonly AuxInput12: "auxInput12"; readonly AuxInput13: "auxInput13"; readonly BarometricPressurePa: "barometricPressurePa"; readonly BatteryMilliVolts: "batteryMilliVolts"; readonly DefLevelMilliPercent: "defLevelMilliPercent"; readonly EcuSpeedMph: "ecuSpeedMph"; readonly EngineCoolantTemperatureMilliC: "engineCoolantTemperatureMilliC"; readonly EngineImmobilizer: "engineImmobilizer"; readonly EngineLoadPercent: "engineLoadPercent"; readonly EngineOilPressureKpa: "engineOilPressureKPa"; readonly EngineRpm: "engineRpm"; readonly EngineStates: "engineStates"; readonly FaultCodes: "faultCodes"; readonly FuelPercents: "fuelPercents"; readonly Gps: "gps"; readonly GpsDistanceMeters: "gpsDistanceMeters"; readonly GpsOdometerMeters: "gpsOdometerMeters"; readonly IntakeManifoldTemperatureMilliC: "intakeManifoldTemperatureMilliC"; readonly NfcCardScans: "nfcCardScans"; readonly ObdEngineSeconds: "obdEngineSeconds"; readonly ObdOdometerMeters: "obdOdometerMeters"; readonly SyntheticEngineSeconds: "syntheticEngineSeconds"; readonly EvStateOfChargeMilliPercent: "evStateOfChargeMilliPercent"; readonly EvChargingStatus: "evChargingStatus"; readonly EvChargingEnergyMicroWh: "evChargingEnergyMicroWh"; readonly EvChargingVoltageMilliVolt: "evChargingVoltageMilliVolt"; readonly EvChargingCurrentMilliAmp: "evChargingCurrentMilliAmp"; readonly EvConsumedEnergyMicroWh: "evConsumedEnergyMicroWh"; readonly EvRegeneratedEnergyMicroWh: "evRegeneratedEnergyMicroWh"; readonly EvBatteryVoltageMilliVolt: "evBatteryVoltageMilliVolt"; readonly EvBatteryCurrentMilliAmp: "evBatteryCurrentMilliAmp"; readonly EvBatteryStateOfHealthMilliPercent: "evBatteryStateOfHealthMilliPercent"; readonly EvAverageBatteryTemperatureMilliCelsius: "evAverageBatteryTemperatureMilliCelsius"; readonly EvDistanceDrivenMeters: "evDistanceDrivenMeters"; readonly SpreaderLiquidRate: "spreaderLiquidRate"; readonly SpreaderGranularRate: "spreaderGranularRate"; readonly SpreaderPrewetRate: "spreaderPrewetRate"; readonly SpreaderAirTemp: "spreaderAirTemp"; readonly SpreaderRoadTemp: "spreaderRoadTemp"; readonly SpreaderOnState: "spreaderOnState"; readonly SpreaderActive: "spreaderActive"; readonly SpreaderBlastState: "spreaderBlastState"; readonly SpreaderGranularName: "spreaderGranularName"; readonly SpreaderPrewetName: "spreaderPrewetName"; readonly SpreaderLiquidName: "spreaderLiquidName"; readonly SpreaderPlowStatus: "spreaderPlowStatus"; readonly SeatbeltDriver: "seatbeltDriver"; }; export type GetVehicleStatsHistoryTypesEnum = typeof GetVehicleStatsHistoryTypesEnum[keyof typeof GetVehicleStatsHistoryTypesEnum]; /** * @export */ export declare const GetVehicleStatsHistoryDecorationsEnum: { readonly AmbientAirTemperatureMilliC: "ambientAirTemperatureMilliC"; readonly AuxInput1: "auxInput1"; readonly AuxInput2: "auxInput2"; readonly AuxInput3: "auxInput3"; readonly AuxInput4: "auxInput4"; readonly AuxInput5: "auxInput5"; readonly AuxInput6: "auxInput6"; readonly AuxInput7: "auxInput7"; readonly AuxInput8: "auxInput8"; readonly AuxInput9: "auxInput9"; readonly AuxInput10: "auxInput10"; readonly AuxInput11: "auxInput11"; readonly AuxInput12: "auxInput12"; readonly AuxInput13: "auxInput13"; readonly BatteryMilliVolts: "batteryMilliVolts"; readonly BarometricPressurePa: "barometricPressurePa"; readonly DefLevelMilliPercent: "defLevelMilliPercent"; readonly EcuSpeedMph: "ecuSpeedMph"; readonly EngineCoolantTemperatureMilliC: "engineCoolantTemperatureMilliC"; readonly EngineImmobilizer: "engineImmobilizer"; readonly EngineLoadPercent: "engineLoadPercent"; readonly EngineOilPressureKpa: "engineOilPressureKPa"; readonly EngineRpm: "engineRpm"; readonly EngineStates: "engineStates"; readonly FaultCodes: "faultCodes"; readonly FuelPercents: "fuelPercents"; readonly Gps: "gps"; readonly GpsDistanceMeters: "gpsDistanceMeters"; readonly IntakeManifoldTemperatureMilliC: "intakeManifoldTemperatureMilliC"; readonly NfcCardScans: "nfcCardScans"; readonly ObdEngineSeconds: "obdEngineSeconds"; readonly ObdOdometerMeters: "obdOdometerMeters"; readonly SpreaderLiquidRate: "spreaderLiquidRate"; readonly SpreaderGranularRate: "spreaderGranularRate"; readonly SpreaderPrewetRate: "spreaderPrewetRate"; readonly SpreaderAirTemp: "spreaderAirTemp"; readonly SpreaderRoadTemp: "spreaderRoadTemp"; readonly SpreaderOnState: "spreaderOnState"; readonly SpreaderActive: "spreaderActive"; readonly SpreaderBlastState: "spreaderBlastState"; readonly SpreaderGranularName: "spreaderGranularName"; readonly SpreaderPrewetName: "spreaderPrewetName"; readonly SpreaderLiquidName: "spreaderLiquidName"; readonly SpreaderPlowStatus: "spreaderPlowStatus"; readonly SeatbeltDriver: "seatbeltDriver"; }; export type GetVehicleStatsHistoryDecorationsEnum = typeof GetVehicleStatsHistoryDecorationsEnum[keyof typeof GetVehicleStatsHistoryDecorationsEnum];