openapi: 3.0.1
info:
  description: Gain greater visibility by connecting your fleets, equipment, sites, and people.
  title: Samsara Vehicles API
  version: '2024-11-18'
servers:
- url: https://api.samsara.com/
- url: https://api.eu.samsara.com/
security:
- AccessTokenHeader: []
tags:
- name: Vehicles
paths:
  /fleet/vehicles:
    get:
      description: "Returns a list of all vehicles.\n\n <b>Rate limit:</b> 25 requests/sec (learn more about rate limits <a href=\"https://developers.samsara.com/docs/rate-limits\" target=\"_blank\">here</a>).\n\nTo use this endpoint, select **Read Vehicles** under the Vehicles category when creating or editing an API token. <a href=\"https://developers.samsara.com/docs/authentication#scopes-for-api-tokens\" target=\"_blank\">Learn More.</a>\n \n\n **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our <a href=\"https://forms.gle/zkD4NCH7HjKb7mm69\" target=\"_blank\">API feedback form</a>. If you encountered an issue or noticed inaccuracies in the API documentation, please <a href=\"https://www.samsara.com/help\" target=\"_blank\">submit a case</a> to our support team."
      operationId: listVehicles
      parameters:
      - description: The limit for how many objects will be in the response. Default and max for this value is 512 objects.
        in: query
        name: limit
        schema:
          default: 512
          maximum: 512
          minimum: 1
          type: integer
      - description: ' If specified, this should be the endCursor value from the previous page of results. When present, this request will return the next page of results that occur immediately after the previous page of results.'
        in: query
        name: after
        schema:
          type: string
      - description: ' A filter on the data 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`'
        in: query
        name: parentTagIds
        schema:
          type: string
      - description: ' A filter on the data based on this comma-separated list of tag IDs. Example: `tagIds=1234,5678`'
        in: query
        name: tagIds
        schema:
          type: string
      - description: 'A filter on the data based on this comma-separated list of attribute value IDs. Only entities associated with ALL of the referenced values will be returned (i.e. the intersection of the sets of entities with each value). Example: `attributeValueIds=076efac2-83b5-47aa-ba36-18428436dcac,6707b3f0-23b9-4fe3-b7be-11be34aea544`'
        in: query
        name: attributeValueIds
        schema:
          type: string
      - description: ' A filter on data to have an updated at time after or equal to this specified 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).'
        in: query
        name: updatedAfterTime
        schema:
          type: string
      - description: ' A filter on data to have a created at time after or equal to this specified 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).'
        in: query
        name: createdAfterTime
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VehiclesListVehiclesResponseBody'
          description: OK response.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VehiclesListVehiclesUnauthorizedErrorResponseBody'
          description: Unauthorized response.
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VehiclesListVehiclesNotFoundErrorResponseBody'
          description: Not Found response.
        '405':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VehiclesListVehiclesMethodNotAllowedErrorResponseBody'
          description: Method Not Allowed response.
        '429':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VehiclesListVehiclesTooManyRequestsErrorResponseBody'
          description: Too Many Requests response.
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VehiclesListVehiclesInternalServerErrorResponseBody'
          description: Internal Server Error response.
        '501':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VehiclesListVehiclesNotImplementedErrorResponseBody'
          description: Not Implemented response.
        '502':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VehiclesListVehiclesBadGatewayErrorResponseBody'
          description: Bad Gateway response.
        '503':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VehiclesListVehiclesServiceUnavailableErrorResponseBody'
          description: Service Unavailable response.
        '504':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VehiclesListVehiclesGatewayTimeoutErrorResponseBody'
          description: Gateway Timeout response.
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VehiclesListVehiclesBadRequestErrorResponseBody'
          description: Bad Request response.
      summary: List All Vehicles.
      tags:
      - Vehicles
  /fleet/vehicles/driver-assignments:
    get:
      description: "**Note: This is a legacy endpoint, consider using [this endpoint](https://developers.samsara.com/reference/getdrivervehicleassignments) instead. The endpoint will continue to function as documented.** Get all driver assignments for the requested vehicles in the requested time range. The only type of assignment supported right now are assignments created through the driver app.\n\n <b>Rate limit:</b> 5 requests/sec (learn more about rate limits <a href=\"https://developers.samsara.com/docs/rate-limits\" target=\"_blank\">here</a>).\n\nTo use this endpoint, select **Read Assignments** under the Assignments category when creating or editing an API token. <a href=\"https://developers.samsara.com/docs/authentication#scopes-for-api-tokens\" target=\"_blank\">Learn More.</a>\n \n\n **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our <a href=\"https://forms.gle/zkD4NCH7HjKb7mm69\" target=\"_blank\">API feedback form</a>. If you encountered an issue or noticed inaccuracies in the API documentation, please <a href=\"https://www.samsara.com/help\" target=\"_blank\">submit a case</a> to our support team."
      operationId: getVehiclesDriverAssignments
      parameters:
      - description: ' A start time in RFC 3339 format. Defaults to now if not provided. 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). The maximum allowed startTime-endTime range is 7 days.'
        in: query
        name: startTime
        schema:
          type: string
      - description: ' An end time in RFC 3339 format. Defaults to now if not provided. 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). The maximum allowed startTime-endTime range is 7 days.'
        in: query
        name: endTime
        schema:
          type: string
      - description: ' A filter on the data based on this comma-separated list of vehicle IDs and externalIds. Example: `vehicleIds=1234,5678,samsara.vin:1HGBH41JXMN109186`'
        in: query
        name: vehicleIds
        schema:
          type: string
      - description: ' A filter on the data based on this comma-separated list of tag IDs. Example: `tagIds=1234,5678`'
        in: query
        name: tagIds
        schema:
          type: string
      - description: ' A filter on the data based on this comma-separated list of parent tag IDs, for use by orgs with tag hierarchies. Specifying a parent tag will implicitly include all descendent tags of the parent tag. Example: `parentTagIds=345,678`'
        in: query
        name: parentTagIds
        schema:
          type: string
      - description: ' If specified, this should be the endCursor value from the previous page of results. When present, this request will return the next page of results that occur immediately after the previous page of results.'
        in: query
        name: after
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VehiclesDriverAssignmentsGetVehiclesDriverAssignmentsResponseBody'
          description: OK response.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VehiclesDriverAssignmentsGetVehiclesDriverAssignmentsUnauthorizedErrorResponseBody'
          description: Unauthorized response.
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VehiclesDriverAssignmentsGetVehiclesDriverAssignmentsNotFoundErrorResponseBody'
          description: Not Found response.
        '405':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VehiclesDriverAssignmentsGetVehiclesDriverAssignmentsMethodNotAllowedErrorResponseBody'
          description: Method Not Allowed response.
        '429':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VehiclesDriverAssignmentsGetVehiclesDriverAssignmentsTooManyRequestsErrorResponseBody'
          description: Too Many Requests response.
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VehiclesDriverAssignmentsGetVehiclesDriverAssignmentsInternalServerErrorResponseBody'
          description: Internal Server Error response.
        '501':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VehiclesDriverAssignmentsGetVehiclesDriverAssignmentsNotImplementedErrorResponseBody'
          description: Not Implemented response.
        '502':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VehiclesDriverAssignmentsGetVehiclesDriverAssignmentsBadGatewayErrorResponseBody'
          description: Bad Gateway response.
        '503':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VehiclesDriverAssignmentsGetVehiclesDriverAssignmentsServiceUnavailableErrorResponseBody'
          description: Service Unavailable response.
        '504':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VehiclesDriverAssignmentsGetVehiclesDriverAssignmentsGatewayTimeoutErrorResponseBody'
          description: Gateway Timeout response.
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VehiclesDriverAssignmentsGetVehiclesDriverAssignmentsBadRequestErrorResponseBody'
          description: Bad Request response.
      summary: '[legacy] Get All Drivers Assigned to a Set of Vehicles'
      tags:
      - Vehicles
  /fleet/vehicles/immobilizer/stream:
    get:
      description: "Get the engine immobilizer states of the queried vehicles. If a vehicle has never had an engine immobilizer connected, there won't be any state returned for that vehicle.\n\n <b>Rate limit:</b> 5 requests/sec (learn more about rate limits <a href=\"https://developers.samsara.com/docs/rate-limits\" target=\"_blank\">here</a>).\n\nTo use this endpoint, select **Read Vehicle Immobilization** under the Vehicles category when creating or editing an API token. <a href=\"https://developers.samsara.com/docs/authentication#scopes-for-api-tokens\" target=\"_blank\">Learn More.</a>\n \n\n **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our <a href=\"https://forms.gle/zkD4NCH7HjKb7mm69\" target=\"_blank\">API feedback form</a>. If you encountered an issue or noticed inaccuracies in the API documentation, please <a href=\"https://www.samsara.com/help\" target=\"_blank\">submit a case</a> to our support team."
      operationId: getEngineImmobilizerStates
      parameters:
      - description: ' A filter on the data based on this comma-separated list of vehicle IDs and externalIds. Example: `vehicleIds=1234,5678,samsara.vin:1HGBH41JXMN109186`'
        in: query
        name: vehicleIds
        required: true
        schema:
          type: string
      - description: '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).'
        in: query
        name: startTime
        required: true
        schema:
          type: string
      - description: ' An end time in RFC 3339 format. Defaults to now if not provided. 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).'
        in: query
        name: endTime
        schema:
          type: string
      - description: ' If specified, this should be the endCursor value from the previous page of results. When present, this request will return the next page of results that occur immediately after the previous page of results.'
        in: query
        name: after
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EngineImmobilizerGetEngineImmobilizerStatesResponseBody'
          description: OK response.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EngineImmobilizerGetEngineImmobilizerStatesUnauthorizedErrorResponseBody'
          description: Unauthorized response.
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EngineImmobilizerGetEngineImmobilizerStatesNotFoundErrorResponseBody'
          description: Not Found response.
        '405':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EngineImmobilizerGetEngineImmobilizerStatesMethodNotAllowedErrorResponseBody'
          description: Method Not Allowed response.
        '429':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EngineImmobilizerGetEngineImmobilizerStatesTooManyRequestsErrorResponseBody'
          description: Too Many Requests response.
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EngineImmobilizerGetEngineImmobilizerStatesInternalServerErrorResponseBody'
          description: Internal Server Error response.
        '501':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EngineImmobilizerGetEngineImmobilizerStatesNotImplementedErrorResponseBody'
          description: Not Implemented response.
        '502':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EngineImmobilizerGetEngineImmobilizerStatesBadGatewayErrorResponseBody'
          description: Bad Gateway response.
        '503':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EngineImmobilizerGetEngineImmobilizerStatesServiceUnavailableErrorResponseBody'
          description: Service Unavailable response.
        '504':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EngineImmobilizerGetEngineImmobilizerStatesGatewayTimeoutErrorResponseBody'
          description: Gateway Timeout response.
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EngineImmobilizerGetEngineImmobilizerStatesBadRequestErrorResponseBody'
          description: Bad Request response.
      summary: '[beta] Get Engine Immobilizer States'
      tags:
      - Vehicles
  /fleet/vehicles/locations:
    get:
      description: "***NOTE: The Vehicle Locations API is an older API that does not combine GPS data with onboard diagnostics. Try our new [Vehicle Stats API](ref:getvehiclestats) instead.***\n\nReturns the last known location of all vehicles at the given `time`. If no `time` is specified, the current time is used. This can be optionally filtered by tags or specific vehicle IDs.\n\nRelated guide: <a href=\"/docs/vehicle-locations-1\" target=\"_blank\">Vehicle Locations</a>. \n\n **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our <a href=\"https://forms.gle/zkD4NCH7HjKb7mm69\" target=\"_blank\">API feedback form</a>. If you encountered an issue or noticed inaccuracies in the API documentation, please <a href=\"https://www.samsara.com/help\" target=\"_blank\">submit a case</a> to our support team.\n\nTo use this endpoint, select **Read Vehicle Statistics** under the Vehicles category when creating or editing an API token. <a href=\"https://developers.samsara.com/docs/authentication#scopes-for-api-tokens\" target=\"_blank\">Learn More.</a>"
      operationId: getVehicleLocations
      parameters:
      - description: If specified, this should be the endCursor value from the previous page of results. When present, this request will return the next page of results that occur immediately after the previous page of results.
        in: query
        name: after
        schema:
          type: string
      - description: 'A filter on the data that returns the last known data points with timestamps less than or equal to this value. Defaults to now if not provided. Must be a string in RFC 3339 format. Millisecond precision and timezones are supported. (Example: `2020-01-27T07:06:25Z`).'
        in: query
        name: time
        schema:
          type: string
      - description: 'A filter on the data based on this comma-separated list of parent tag IDs, for use by orgs with tag hierarchies. Specifying a parent tag will implicitly include all descendent tags of the parent tag. Example: `parentTagIds=345,678`'
        explode: false
        in: query
        name: parentTagIds
        schema:
          items:
            type: string
          type: array
        style: form
      - description: 'A filter on the data based on this comma-separated list of tag IDs. Example: `tagIds=1234,5678`'
        explode: false
        in: query
        name: tagIds
        schema:
          items:
            type: string
          type: array
        style: form
      - description: 'A filter on the data based on this comma-separated list of vehicle IDs. Example: `vehicleIds=1234,5678`'
        explode: false
        in: query
        name: vehicleIds
        schema:
          items:
            type: string
          type: array
        style: form
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VehicleLocationsResponse'
          description: List of the most recent locations for the specified vehicles.
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/standardErrorResponse'
          description: Error response
      summary: Locations Snapshot
      tags:
      - Vehicles
  /fleet/vehicles/locations/feed:
    get:
      description: "***NOTE: The Vehicle Locations API is an older API that does not combine GPS data with onboard diagnostics. Try our new [Vehicle Stats API](ref:getvehiclestatsfeed) instead.***\n\nFollow a continuous feed of all vehicle locations from Samsara Vehicle Gateways.\n\nYour first call to this endpoint will provide you with the most recent location for each vehicle and a `pagination` object that contains an `endCursor`.\n\nYou can provide the `endCursor` to the `after` parameter of this endpoint to get location updates since that `endCursor`. \n\nIf `hasNextPage` is `false`, no updates are readily available yet. We'd suggest waiting a minimum of 5 seconds before requesting updates.\n\nRelated guide: <a href=\"/docs/vehicle-locations-1\" target=\"_blank\">Vehicle Locations</a>. \n\n **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our <a href=\"https://forms.gle/zkD4NCH7HjKb7mm69\" target=\"_blank\">API feedback form</a>. If you encountered an issue or noticed inaccuracies in the API documentation, please <a href=\"https://www.samsara.com/help\" target=\"_blank\">submit a case</a> to our support team.\n\nTo use this endpoint, select **Read Vehicle Statistics** under the Vehicle category when creating or editing an API token. <a href=\"https://developers.samsara.com/docs/authentication#scopes-for-api-tokens\" target=\"_blank\">Learn More.</a>"
      operationId: getVehicleLocationsFeed
      parameters:
      - description: If specified, this should be the endCursor value from the previous page of results. When present, this request will return the next page of results that occur immediately after the previous page of results.
        in: query
        name: after
        schema:
          type: string
      - description: 'A filter on the data based on this comma-separated list of parent tag IDs, for use by orgs with tag hierarchies. Specifying a parent tag will implicitly include all descendent tags of the parent tag. Example: `parentTagIds=345,678`'
        explode: false
        in: query
        name: parentTagIds
        schema:
          items:
            type: string
          type: array
        style: form
      - description: 'A filter on the data based on this comma-separated list of tag IDs. Example: `tagIds=1234,5678`'
        explode: false
        in: query
        name: tagIds
        schema:
          items:
            type: string
          type: array
        style: form
      - description: 'A filter on the data based on this comma-separated list of vehicle IDs. Example: `vehicleIds=1234,5678`'
        explode: false
        in: query
        name: vehicleIds
        schema:
          items:
            type: string
          type: array
        style: form
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VehicleLocationsListResponse'
          description: List of locations events for the specified vehicles.
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/standardErrorResponse'
          description: Error response
      summary: Locations Feed
      tags:
      - Vehicles
  /fleet/vehicles/locations/history:
    get:
      description: "***NOTE: The Vehicle Locations API is an older API that does not combine GPS data with onboard diagnostics. Try our new [Vehicle Stats API](ref:getvehiclestatshistory) instead.***\n\nReturns all known vehicle locations during the given time range. This can be optionally filtered by tags or specific vehicle IDs.\n\nRelated guide: <a href=\"/docs/vehicle-locations-1\" target=\"_blank\">Vehicle Locations</a>. \n\n **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our <a href=\"https://forms.gle/zkD4NCH7HjKb7mm69\" target=\"_blank\">API feedback form</a>. If you encountered an issue or noticed inaccuracies in the API documentation, please <a href=\"https://www.samsara.com/help\" target=\"_blank\">submit a case</a> to our support team.\n\nTo use this endpoint, select **Read Vehicle Statistics** under the Vehicle category when creating or editing an API token. <a href=\"https://developers.samsara.com/docs/authentication#scopes-for-api-tokens\" target=\"_blank\">Learn More.</a>"
      operationId: getVehicleLocationsHistory
      parameters:
      - description: If specified, this should be the endCursor value from the previous page of results. When present, this request will return the next page of results that occur immediately after the previous page of results.
        in: query
        name: after
        schema:
          type: string
      - description: 'A 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).'
        in: query
        name: startTime
        required: true
        schema:
          type: string
      - description: '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).'
        in: query
        name: endTime
        required: true
        schema:
          type: string
      - description: 'A filter on the data based on this comma-separated list of parent tag IDs, for use by orgs with tag hierarchies. Specifying a parent tag will implicitly include all descendent tags of the parent tag. Example: `parentTagIds=345,678`'
        explode: false
        in: query
        name: parentTagIds
        schema:
          items:
            type: string
          type: array
        style: form
      - description: 'A filter on the data based on this comma-separated list of tag IDs. Example: `tagIds=1234,5678`'
        explode: false
        in: query
        name: tagIds
        schema:
          items:
            type: string
          type: array
        style: form
      - description: 'A filter on the data based on this comma-separated list of vehicle IDs. Example: `vehicleIds=1234,5678`'
        explode: false
        in: query
        name: vehicleIds
        schema:
          items:
            type: string
          type: array
        style: form
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VehicleLocationsListResponse'
          description: List of all locations for the specified vehicles and time range.
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/standardErrorResponse'
          description: Error response
      summary: Historical Locations
      tags:
      - Vehicles
  /fleet/vehicles/stats:
    get:
      description: "Returns the last known stats of all vehicles at the given `time`. If no `time` is specified, the current time is used.\n\nRelated guide: <a href=\"/docs/telematics\" target=\"_blank\">Telematics</a>. \n\n **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our <a href=\"https://forms.gle/zkD4NCH7HjKb7mm69\" target=\"_blank\">API feedback form</a>. If you encountered an issue or noticed inaccuracies in the API documentation, please <a href=\"https://www.samsara.com/help\" target=\"_blank\">submit a case</a> to our support team.\n\nTo use this endpoint, select **Read Vehicle Statistics** under the Vehicles category when creating or editing an API token. <a href=\"https://developers.samsara.com/docs/authentication#scopes-for-api-tokens\" target=\"_blank\">Learn More.</a>"
      operationId: getVehicleStats
      parameters:
      - description: If specified, this should be the endCursor value from the previous page of results. When present, this request will return the next page of results that occur immediately after the previous page of results.
        in: query
        name: after
        schema:
          type: string
      - description: 'A filter on the data that returns the last known data points with timestamps less than or equal to this value. Defaults to now if not provided. Must be a string in RFC 3339 format. Millisecond precision and timezones are supported. (Example: `2020-01-27T07:06:25Z`).'
        in: query
        name: time
        schema:
          type: string
      - description: 'A filter on the data based on this comma-separated list of parent tag IDs, for use by orgs with tag hierarchies. Specifying a parent tag will implicitly include all descendent tags of the parent tag. Example: `parentTagIds=345,678`'
        explode: false
        in: query
        name: parentTagIds
        schema:
          items:
            type: string
          type: array
        style: form
      - description: 'A filter on the data based on this comma-separated list of tag IDs. Example: `tagIds=1234,5678`'
        explode: false
        in: query
        name: tagIds
        schema:
          items:
            type: string
          type: array
        style: form
      - description: 'A filter on the data based on this comma-separated list of vehicle IDs. Example: `vehicleIds=1234,5678`'
        explode: false
        in: query
        name: vehicleIds
        schema:
          items:
            type: string
          type: array
        style: form
      - description: "The stat types you want this endpoint to return information on. See also the <a href=\"/docs/telematics#query-parameters\" target=\"_blank\">Telematics</a> guide for more details.\n\nYou may list ***up to 3*** types using comma-separated format. For example: `types=gps,engineStates,obdOdometerMeters`.\n\n*Note:* `auxInput3`-`auxInput10` count as a single type against the limit of 3. For example, you could list `types=engineStates,obdOdometerMeters,auxInput3,auxInput4` because `auxInput3` and `auxInput4` count as a single stat type. `auxInput1` and `auxInput2` still count as their own individual types.\n\n- `ambientAirTemperatureMilliC`: The ambient air temperature reading in millidegree Celsius.\n- `auxInput1`-`auxInput13`: Stat events from the <a href=\"https://kb.samsara.com/hc/en-us/articles/360043040512-Auxiliary-Inputs\" target=\"_blank\">auxiliary inputs</a> for the vehicle.\n- `barometricPressurePa`: The barometric pressure reading in pascals.\n- `batteryMilliVolts`: The vehicle battery voltage reading.\n- `defLevelMilliPercent`: The Diesel Exhaust Fluid (DEF) level in milli percentage points (e.g. `99001`, `49999`, etc).\n- `ecuSpeedMph`: The speed of the engine in miles per hour according to the ECU.\n- `engineCoolantTemperatureMilliC`: The engine coolant temperature reading in millidegree Celsius.\n- `engineImmobilizer`: The state of the engine immobilizer - Valid values: `ignition_disabled`, `ignition_enabled`. This stat type will only return states of our first Engine Immobilizer Hardware (ACC-EI). Please use <a href=\"https://developers.samsara.com/reference/getengineimmobilizerstates\" target=\"_blank\">Get engine immobilizer states</a> to get states for both Engine Immobilizer Hardware versions (incl. HW-EI21).\n- `engineLoadPercent`: The engine load in percentage points (e.g. `99`, `50`, etc).\n- `engineOilPressureKPa`: The engine oil pressure reading in kilopascals.\n- `engineRpm`: The revolutions per minute of the engine.\n- `engineStates`: The state of the engine (`Off`, `On`, `Idle`).\n- `faultCodes`: The diagnostic fault codes for the vehicle.\n- `fuelPercents`: The engine fuel level in percentage points (e.g. `99`, `50`, etc).\n- `gps`: GPS data including lat/long, heading, speed, address book entry (if exists), and a reverse geocoded address.\n- `gpsDistanceMeters`: The distance the vehicle has traveled since the gateway was installed based on GPS calculations.\n- `gpsOdometerMeters`: Odometer reading provided by GPS calculations when OBD odometer cannot be pulled automatically. You must provide a manual odometer reading before this value is updated. Manual odometer readings can be provided via the [PATCH /fleet/vehicles/{id}](ref:updatevehicle) endpoint or through the <a href=\"https://kb.samsara.com/hc/en-us/articles/115005273667-Editing-Odometer-Reading\" target=\"_blank\">cloud dasbhoard</a>. Odometer readings that are manually set will update as GPS trip data is gathered. Try combining with `obdOdometerMeters`.\n- `intakeManifoldTemperatureMilliC`: The intake manifold temperature reading in millidegree Celsius.\n- `nfcCardScans`: ID card scans.\n- `obdEngineSeconds`: The cumulative number of seconds the engine has run according to onboard diagnostics.\n- `obdOdometerMeters`: The odometer reading according to onboard diagnostics. If Samsara does not have diagnostic coverage for a particular vehicle, the value for this stat type will be omitted. Try combining with `gpsOdometerMeters`. \n- `syntheticEngineSeconds`: Data for the synthetic engine seconds for the vehicle.\n- `evStateOfChargeMilliPercent`: Milli percent State of Charge for electric and hybrid vehicles. Not all EV and HEVs may report this field.\n- `evChargingStatus`: Charging status for electric and hybrid vehicles. Not all EV and HEVs may report this field. Statuses:  unknown - 0, not charging - 1, charging - 2.\n- `evChargingEnergyMicroWh`: Charging energy for electric and hybrid vehicles in microwatt hours. Not all EV and HEVs may report this field.\n- `evChargingVoltageMilliVolt`: Charging voltage for electric and hybrid vehicles in milli volts. Not all EV and HEVs may report this field.\n- `evChargingCurrentMilliAmp`: Charging current for electric and hybrid vehicles in milli amps. Not all EV and HEVs may report this field.\n- `evConsumedEnergyMicroWh`: Consumed energy (including regenerated) for electric and hybrid vehicles in microwatt hours. Not all EV and HEVs may report this field.\n- `evRegeneratedEnergyMicroWh`: Regenerated energy for electric and hybrid vehicles in microwatt hours. Not all EV and HEVs may report this field.\n- `evBatteryVoltageMilliVolt`: Battery voltage for electric and hybrid vehicles in milli volts. Not all EV and HEVs may report this field.\n- `evBatteryCurrentMilliAmp`: Battery current for electric and hybrid vehicles in milli amps. Not all EV and HEVs may report this field.\n- `evBatteryStateOfHealthMilliPercent`: Milli percent battery state of health for electric and hybrid vehicles. Not all EV and HEVs may report this field.\n- `evAverageBatteryTemperatureMilliCelsius`: Battery temperature for electric and hybrid vehicles in milli celsius. Not all EV and HEVs may report this field.\n- `evDistanceDrivenMeters`: Electric distance driven for electric and hybrid vehicles in meters. Not all EV and HEVs may report this field.\n- `spreaderLiquidRate`: Liquid spread rate reading in milliliters per meter, read from the material spreader. Unfiltered live stats are supplied as-read from the Material Spreader unit. Readings do not consider total spread rate(s) over time or distance.\n- `spreaderGranularRate`: Granular spread rate reading in milliliters per meter, read from the material spreader. Unfiltered live stats are supplied as-read from the Material Spreader unit. Readings do not consider total spread rate(s) over time or distance.\n- `spreaderPrewetRate`: Prewet spread rate reading in milliliters per meter, read from the material spreader. Unfiltered live stats are supplied as-read from the Material Spreader unit. Readings do not consider total spread rate(s) over time or distance.\n- `spreaderAirTemp`: Air (ambient) temperature in milli celsius reading from material spreader.\n- `spreaderRoadTemp`: Road temperature reading in milli celsius from material spreader.\n- `spreaderOnState`: Whether vehicle spreader is enabled.\n- `spreaderActive`: Whether vehicle is actively spreading any material.\n- `spreaderBlastState`: Whether vehicle is actively spreading material in blast mode.\n- `spreaderGranularName`: Name of most recent type of granular material spread, read from the material spreader.\n- `spreaderPrewetName`: Name of most recent type of prewet material spread, read from the material spreader.\n- `spreaderLiquidName`: Name of most recent type of liquid material spread, read from the material spreader.\n- `spreaderPlowStatus`: Snow plow status (`Up` or `Down`), as read from the material spreader. Note: this is separate from plow status defined via auxInput.\n- `seatbeltDriver`: Seatbelt Driver Status as read from the vehicle. `Buckled` or `Unbuckled`. (Beta only)"
        explode: false
        in: query
        name: types
        required: true
        schema:
          items:
            enum:
            - ambientAirTemperatureMilliC
            - auxInput1
            - auxInput2
            - auxInput3
            - auxInput4
            - auxInput5
            - auxInput6
            - auxInput7
            - auxInput8
            - auxInput9
            - auxInput10
            - auxInput11
            - auxInput12
            - auxInput13
            - barometricPressurePa
            - batteryMilliVolts
            - defLevelMilliPercent
            - ecuSpeedMph
            - engineCoolantTemperatureMilliC
            - engineImmobilizer
            - engineLoadPercent
            - engineOilPressureKPa
            - engineRpm
            - engineStates
            - faultCodes
            - fuelPercents
            - gps
            - gpsDistanceMeters
            - gpsOdometerMeters
            - intakeManifoldTemperatureMilliC
            - nfcCardScans
            - obdEngineSeconds
            - obdOdometerMeters
            - syntheticEngineSeconds
            - evStateOfChargeMilliPercent
            - evChargingStatus
            - evChargingEnergyMicroWh
            - evChargingVoltageMilliVolt
            - evChargingCurrentMilliAmp
            - evConsumedEnergyMicroWh
            - evRegeneratedEnergyMicroWh
            - evBatteryVoltageMilliVolt
            - evBatteryCurrentMilliAmp
            - evBatteryStateOfHealthMilliPercent
            - evAverageBatteryTemperatureMilliCelsius
            - evDistanceDrivenMeters
            - spreaderLiquidRate
            - spreaderGranularRate
            - spreaderPrewetRate
            - spreaderAirTemp
            - spreaderRoadTemp
            - spreaderOnState
            - spreaderActive
            - spreaderBlastState
            - spreaderGranularName
            - spreaderPrewetName
            - spreaderLiquidName
            - spreaderPlowStatus
            - seatbeltDriver
            type: string
          type: array
        style: form
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VehicleStatsResponse'
          description: Vehicle stats snapshot
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/standardErrorResponse'
          description: Error response
      summary: Stats Snapshot
      tags:
      - Vehicles
  /fleet/vehicles/stats/feed:
    get:
      description: "Follow a feed of vehicle stats. \n\nYour first call to this endpoint will provide you with the most recent stats for each vehicle and an `endCursor`.\n\nYou can the provide the `endCursor` value to the `after` query parameter to get all updates since the last call you made.\n\nIf `hasNextPage` is `false`, no new data is immediately available. You should wait a minimum of 5 seconds making a subsequent request.\n\nRelated guide: <a href=\"/docs/telematics\" target=\"_blank\">Telematics</a>. \n\n **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our <a href=\"https://forms.gle/zkD4NCH7HjKb7mm69\" target=\"_blank\">API feedback form</a>. If you encountered an issue or noticed inaccuracies in the API documentation, please <a href=\"https://www.samsara.com/help\" target=\"_blank\">submit a case</a> to our support team.\n\nTo use this endpoint, select **Read Vehicle Statistics** under the Vehicles category when creating or editing an API token. <a href=\"https://developers.samsara.com/docs/authentication#scopes-for-api-tokens\" target=\"_blank\">Learn More.</a>"
      operationId: getVehicleStatsFeed
      parameters:
      - description: If specified, this should be the endCursor value from the previous page of results. When present, this request will return the next page of results that occur immediately after the previous page of results.
        in: query
        name: after
        schema:
          type: string
      - description: 'A filter on the data based on this comma-separated list of parent tag IDs, for use by orgs with tag hierarchies. Specifying a parent tag will implicitly include all descendent tags of the parent tag. Example: `parentTagIds=345,678`'
        explode: false
        in: query
        name: parentTagIds
        schema:
          items:
            type: string
          type: array
        style: form
      - description: 'A filter on the data based on this comma-separated list of tag IDs. Example: `tagIds=1234,5678`'
        explode: false
        in: query
        name: tagIds
        schema:
          items:
            type: string
          type: array
        style: form
      - description: 'A filter on the data based on this comma-separated list of vehicle IDs. Example: `vehicleIds=1234,5678`'
        explode: false
        in: query
        name: vehicleIds
        schema:
          items:
            type: string
          type: array
        style: form
      - description: "The stat types you want this endpoint to return information on. See also the <a href=\"/docs/telematics#query-parameters\" target=\"_blank\">Telematics</a> guide for more details.\n\nYou may list ***up to 3*** types using comma-separated format. For example: `types=gps,engineStates,obdOdometerMeters`.\n\n*Note:* `auxInput3`-`auxInput10` count as a single type against the limit of 3. For example, you could list `types=engineStates,obdOdometerMeters,auxInput3,auxInput4` because `auxInput3` and `auxInput4` count as a single stat type. `auxInput1` and `auxInput2` still count as their own individual types.\n\n- `ambientAirTemperatureMilliC`: The ambient air temperature reading in millidegree Celsius.\n- `auxInput1`-`auxInput13`: Stat events from the <a href=\"https://kb.samsara.com/hc/en-us/articles/360043040512-Auxiliary-Inputs\" target=\"_blank\">auxiliary inputs</a> for the vehicle.\n- `barometricPressurePa`: The barometric pressure reading in pascals.\n- `batteryMilliVolts`: The vehicle battery voltage reading.\n- `defLevelMilliPercent`: The Diesel Exhaust Fluid (DEF) level in milli percentage points (e.g. `99001`, `49999`, etc).\n- `ecuSpeedMph`: The speed of the engine in miles per hour according to the ECU.\n- `engineCoolantTemperatureMilliC`: The engine coolant temperature reading in millidegree Celsius.\n- `engineImmobilizer`: The state of the engine immobilizer - Valid values: `ignition_disabled`, `ignition_enabled`. This stat type will only return states of our first Engine Immobilizer Hardware (ACC-EI). Please use <a href=\"https://developers.samsara.com/reference/getengineimmobilizerstates\" target=\"_blank\">Get engine immobilizer states</a> to get states for both Engine Immobilizer Hardware versions (incl. HW-EI21).\n- `engineLoadPercent`: The engine load in percentage points (e.g. `99`, `50`, etc).\n- `engineOilPressureKPa`: The engine oil pressure reading in kilopascals.\n- `engineRpm`: The revolutions per minute of the engine.\n- `engineStates`: The state of the engine (`Off`, `On`, `Idle`).\n- `faultCodes`: The diagnostic fault codes for the vehicle.\n- `fuelPercents`: The engine fuel level in percentage points (e.g. `99`, `50`, etc).\n- `gps`: GPS data including lat/long, heading, speed, address book entry (if exists), and a reverse geocoded address.\n- `gpsDistanceMeters`: The distance the vehicle has traveled since the gateway was installed based on GPS calculations.\n- `gpsOdometerMeters`: Odometer reading provided by GPS calculations when OBD odometer cannot be pulled automatically. You must provide a manual odometer reading before this value is updated. Manual odometer readings can be provided via the [PATCH /fleet/vehicles/{id}](ref:updatevehicle) endpoint or through the <a href=\"https://kb.samsara.com/hc/en-us/articles/115005273667-Editing-Odometer-Reading\" target=\"_blank\">cloud dasbhoard</a>. Odometer readings that are manually set will update as GPS trip data is gathered. Try combining with `obdOdometerMeters`.\n- `intakeManifoldTemperatureMilliC`: The intake manifold temperature reading in millidegree Celsius.\n- `nfcCardScans`: ID card scans.\n- `obdEngineSeconds`: The cumulative number of seconds the engine has run according to onboard diagnostics.\n- `obdOdometerMeters`: The odometer reading according to onboard diagnostics. If Samsara does not have diagnostic coverage for a particular vehicle, the value for this stat type will be omitted. Try combining with `gpsOdometerMeters`. \n- `syntheticEngineSeconds`: Data for the synthetic engine seconds for the vehicle.\n- `evStateOfChargeMilliPercent`: Milli percent State of Charge for electric and hybrid vehicles. Not all EV and HEVs may report this field.\n- `evChargingStatus`: Charging status for electric and hybrid vehicles. Not all EV and HEVs may report this field. Statuses:  unknown - 0, not charging - 1, charging - 2.\n- `evChargingEnergyMicroWh`: Charging energy for electric and hybrid vehicles in microwatt hours. Not all EV and HEVs may report this field.\n- `evChargingVoltageMilliVolt`: Charging voltage for electric and hybrid vehicles in milli volts. Not all EV and HEVs may report this field.\n- `evChargingCurrentMilliAmp`: Charging current for electric and hybrid vehicles in milli amps. Not all EV and HEVs may report this field.\n- `evConsumedEnergyMicroWh`: Consumed energy (including regenerated) for electric and hybrid vehicles in microwatt hours. Not all EV and HEVs may report this field.\n- `evRegeneratedEnergyMicroWh`: Regenerated energy for electric and hybrid vehicles in microwatt hours. Not all EV and HEVs may report this field.\n- `evBatteryVoltageMilliVolt`: Battery voltage for electric and hybrid vehicles in milli volts. Not all EV and HEVs may report this field.\n- `evBatteryCurrentMilliAmp`: Battery current for electric and hybrid vehicles in milli amps. Not all EV and HEVs may report this field.\n- `evBatteryStateOfHealthMilliPercent`: Milli percent battery state of health for electric and hybrid vehicles. Not all EV and HEVs may report this field.\n- `evAverageBatteryTemperatureMilliCelsius`: Battery temperature for electric and hybrid vehicles in milli celsius. Not all EV and HEVs may report this field.\n- `evDistanceDrivenMeters`: Electric distance driven for electric and hybrid vehicles in meters. Not all EV and HEVs may report this field.\n- `spreaderLiquidRate`: Liquid spread rate reading in milliliters per meter, read from the material spreader. Unfiltered live stats are supplied as-read from the Material Spreader unit. Readings do not consider total spread rate(s) over time or distance.\n- `spreaderGranularRate`: Granular spread rate reading in milliliters per meter, read from the material spreader. Unfiltered live stats are supplied as-read from the Material Spreader unit. Readings do not consider total spread rate(s) over time or distance.\n- `spreaderPrewetRate`: Prewet spread rate reading in milliliters per meter, read from the material spreader. Unfiltered live stats are supplied as-read from the Material Spreader unit. Readings do not consider total spread rate(s) over time or distance.\n- `spreaderAirTemp`: Air (ambient) temperature in milli celsius reading from material spreader.\n- `spreaderRoadTemp`: Road temperature reading in milli celsius from material spreader.\n- `spreaderOnState`: Whether vehicle spreader is enabled.\n- `spreaderActive`: Whether vehicle is actively spreading any material.\n- `spreaderBlastState`: Whether vehicle is actively spreading material in blast mode.\n- `spreaderGranularName`: Name of most recent type of granular material spread, read from the material spreader.\n- `spreaderPrewetName`: Name of most recent type of prewet material spread, read from the material spreader.\n- `spreaderLiquidName`: Name of most recent type of liquid material spread, read from the material spreader.\n- `spreaderPlowStatus`: Snow plow status (`Up` or `Down`), as read from the material spreader. Note: this is separate from plow status defined via auxInput.\n- `seatbeltDriver`: Seatbelt Driver Status as read from the vehicle. `Buckled` or `Unbuckled`. (Beta only)"
        explode: false
        in: query
        name: types
        required: true
        schema:
          items:
            enum:
            - ambientAirTemperatureMilliC
            - auxInput1
            - auxInput2
            - auxInput3
            - auxInput4
            - auxInput5
            - auxInput6
            - auxInput7
            - auxInput8
            - auxInput9
            - auxInput10
            - auxInput11
            - auxInput12
            - auxInput13
            - barometricPressurePa
            - batteryMilliVolts
            - defLevelMilliPercent
            - ecuSpeedMph
            - engineCoolantTemperatureMilliC
            - engineImmobilizer
            - engineLoadPercent
            - engineOilPressureKPa
            - engineRpm
            - engineStates
            - faultCodes
            - fuelPercents
            - gps
            - gpsDistanceMeters
            - gpsOdometerMeters
            - intakeManifoldTemperatureMilliC
            - nfcCardScans
            - obdEngineSeconds
            - obdOdometerMeters
            - syntheticEngineSeconds
            - evStateOfChargeMilliPercent
            - evChargingStatus
            - evChargingEnergyMicroWh
            - evChargingVoltageMilliVolt
            - evChargingCurrentMilliAmp
            - evConsumedEnergyMicroWh
            - evRegeneratedEnergyMicroWh
            - evBatteryVoltageMilliVolt
            - evBatteryCurrentMilliAmp
            - evBatteryStateOfHealthMilliPercent
            - evAverageBatteryTemperatureMilliCelsius
            - evDistanceDrivenMeters
            - spreaderLiquidRate
            - spreaderGranularRate
            - spreaderPrewetRate
            - spreaderAirTemp
            - spreaderRoadTemp
            - spreaderOnState
            - spreaderActive
            - spreaderBlastState
            - spreaderGranularName
            - spreaderPrewetName
            - spreaderLiquidName
            - spreaderPlowStatus
            - seatbeltDriver
            type: string
          type: array
        style: form
      - description: '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)'
        explode: false
        in: query
        name: decorations
        schema:
          items:
            enum:
            - 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
            type: string
          type: array
        style: form
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VehicleStatsListResponse'
          description: List of stat events for the specified vehicles and stat types.
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/standardErrorResponse'
          description: Error response
      summary: Stats Feed
      tags:
      - Vehicles
  /fleet/vehicles/stats/history:
    get:
      description: "Returns vehicle stats during the given time range for all vehicles. This can be optionally filtered by tags or specific vehicle IDs.\n\nRelated guide: <a href=\"/docs/telematics\" target=\"_blank\">Telematics</a>. \n\n **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our <a href=\"https://forms.gle/zkD4NCH7HjKb7mm69\" target=\"_blank\">API feedback form</a>. If you encountered an issue or noticed inaccuracies in the API documentation, please <a href=\"https://www.samsara.com/help\" target=\"_blank\">submit a case</a> to our support team.\n\nTo use this endpoint, select **Read Vehicle Statistics** under the Vehicles category when creating or editing an API token. <a href=\"https://developers.samsara.com/docs/authentication#scopes-for-api-tokens\" target=\"_blank\">Learn More.</a>"
      operationId: getVehicleStatsHistory
      parameters:
      - description: If specified, this should be the endCursor value from the previous page of results. When present, this request will return the next page of results that occur immediately after the previous page of results.
        in: query
        name: after
        schema:
          type: string
      - description: 'A 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).'
        in: query
        name: startTime
        required: true
        schema:
          type: string
      - description: '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).'
        in: query
        name: endTime
        required: true
        schema:
          type: string
      - description: 'A filter on the data based on this comma-separated list of parent tag IDs, for use by orgs with tag hierarchies. Specifying a parent tag will implicitly include all descendent tags of the parent tag. Example: `parentTagIds=345,678`'
        explode: false
        in: query
        name: parentTagIds
        schema:
          items:
            type: string
          type: array
        style: form
      - description: 'A filter on the data based on this comma-separated list of tag IDs. Example: `tagIds=1234,5678`'
        explode: false
        in: query
        name: tagIds
        schema:
          items:
            type: string
          type: array
        style: form
      - description: 'A filter on the data based on this comma-separated list of vehicle IDs. Example: `vehicleIds=1234,5678`'
        explode: false
        in: query
        name: vehicleIds
        schema:
          items:
            type: string
          type: array
        style: form
      - description: "The stat types you want this endpoint to return information on. See also the <a href=\"/docs/telematics#query-parameters\" target=\"_blank\">Telematics</a> guide for more details.\n\nYou may list ***up to 3*** types using comma-separated format. For example: `types=gps,engineStates,obdOdometerMeters`.\n\n*Note:* `auxInput3`-`auxInput10` count as a single type against the limit of 3. For example, you could list `types=engineStates,obdOdometerMeters,auxInput3,auxInput4` because `auxInput3` and `auxInput4` count as a single stat type. `auxInput1` and `auxInput2` still count as their own individual types.\n\n- `ambientAirTemperatureMilliC`: The ambient air temperature reading in millidegree Celsius.\n- `auxInput1`-`auxInput13`: Stat events from the <a href=\"https://kb.samsara.com/hc/en-us/articles/360043040512-Auxiliary-Inputs\" target=\"_blank\">auxiliary inputs</a> for the vehicle.\n- `barometricPressurePa`: The barometric pressure reading in pascals.\n- `batteryMilliVolts`: The vehicle battery voltage reading.\n- `defLevelMilliPercent`: The Diesel Exhaust Fluid (DEF) level in milli percentage points (e.g. `99001`, `49999`, etc).\n- `ecuSpeedMph`: The speed of the engine in miles per hour according to the ECU.\n- `engineCoolantTemperatureMilliC`: The engine coolant temperature reading in millidegree Celsius.\n- `engineImmobilizer`: The state of the engine immobilizer - Valid values: `ignition_disabled`, `ignition_enabled`. This stat type will only return states of our first Engine Immobilizer Hardware (ACC-EI). Please use <a href=\"https://developers.samsara.com/reference/getengineimmobilizerstates\" target=\"_blank\">Get engine immobilizer states</a> to get states for both Engine Immobilizer Hardware versions (incl. HW-EI21).\n- `engineLoadPercent`: The engine load in percentage points (e.g. `99`, `50`, etc).\n- `engineOilPressureKPa`: The engine oil pressure reading in kilopascals.\n- `engineRpm`: The revolutions per minute of the engine.\n- `engineStates`: The state of the engine (`Off`, `On`, `Idle`).\n- `faultCodes`: The diagnostic fault codes for the vehicle.\n- `fuelPercents`: The engine fuel level in percentage points (e.g. `99`, `50`, etc).\n- `gps`: GPS data including lat/long, heading, speed, address book entry (if exists), and a reverse geocoded address.\n- `gpsDistanceMeters`: The distance the vehicle has traveled since the gateway was installed based on GPS calculations.\n- `gpsOdometerMeters`: Odometer reading provided by GPS calculations when OBD odometer cannot be pulled automatically. You must provide a manual odometer reading before this value is updated. Manual odometer readings can be provided via the [PATCH /fleet/vehicles/{id}](ref:updatevehicle) endpoint or through the <a href=\"https://kb.samsara.com/hc/en-us/articles/115005273667-Editing-Odometer-Reading\" target=\"_blank\">cloud dasbhoard</a>. Odometer readings that are manually set will update as GPS trip data is gathered. Try combining with `obdOdometerMeters`.\n- `intakeManifoldTemperatureMilliC`: The intake manifold temperature reading in millidegree Celsius.\n- `nfcCardScans`: ID card scans.\n- `obdEngineSeconds`: The cumulative number of seconds the engine has run according to onboard diagnostics.\n- `obdOdometerMeters`: The odometer reading according to onboard diagnostics. If Samsara does not have diagnostic coverage for a particular vehicle, the value for this stat type will be omitted. Try combining with `gpsOdometerMeters`. \n- `syntheticEngineSeconds`: Data for the synthetic engine seconds for the vehicle.\n- `evStateOfChargeMilliPercent`: Milli percent State of Charge for electric and hybrid vehicles. Not all EV and HEVs may report this field.\n- `evChargingStatus`: Charging status for electric and hybrid vehicles. Not all EV and HEVs may report this field. Statuses:  unknown - 0, not charging - 1, charging - 2.\n- `evChargingEnergyMicroWh`: Charging energy for electric and hybrid vehicles in microwatt hours. Not all EV and HEVs may report this field.\n- `evChargingVoltageMilliVolt`: Charging voltage for electric and hybrid vehicles in milli volts. Not all EV and HEVs may report this field.\n- `evChargingCurrentMilliAmp`: Charging current for electric and hybrid vehicles in milli amps. Not all EV and HEVs may report this field.\n- `evConsumedEnergyMicroWh`: Consumed energy (including regenerated) for electric and hybrid vehicles in microwatt hours. Not all EV and HEVs may report this field.\n- `evRegeneratedEnergyMicroWh`: Regenerated energy for electric and hybrid vehicles in microwatt hours. Not all EV and HEVs may report this field.\n- `evBatteryVoltageMilliVolt`: Battery voltage for electric and hybrid vehicles in milli volts. Not all EV and HEVs may report this field.\n- `evBatteryCurrentMilliAmp`: Battery current for electric and hybrid vehicles in milli amps. Not all EV and HEVs may report this field.\n- `evBatteryStateOfHealthMilliPercent`: Milli percent battery state of health for electric and hybrid vehicles. Not all EV and HEVs may report this field.\n- `evAverageBatteryTemperatureMilliCelsius`: Battery temperature for electric and hybrid vehicles in milli celsius. Not all EV and HEVs may report this field.\n- `evDistanceDrivenMeters`: Electric distance driven for electric and hybrid vehicles in meters. Not all EV and HEVs may report this field.\n- `spreaderLiquidRate`: Liquid spread rate reading in milliliters per meter, read from the material spreader. Unfiltered live stats are supplied as-read from the Material Spreader unit. Readings do not consider total spread rate(s) over time or distance.\n- `spreaderGranularRate`: Granular spread rate reading in milliliters per meter, read from the material spreader. Unfiltered live stats are supplied as-read from the Material Spreader unit. Readings do not consider total spread rate(s) over time or distance.\n- `spreaderPrewetRate`: Prewet spread rate reading in milliliters per meter, read from the material spreader. Unfiltered live stats are supplied as-read from the Material Spreader unit. Readings do not consider total spread rate(s) over time or distance.\n- `spreaderAirTemp`: Air (ambient) temperature in milli celsius reading from material spreader.\n- `spreaderRoadTemp`: Road temperature reading in milli celsius from material spreader.\n- `spreaderOnState`: Whether vehicle spreader is enabled.\n- `spreaderActive`: Whether vehicle is actively spreading any material.\n- `spreaderBlastState`: Whether vehicle is actively spreading material in blast mode.\n- `spreaderGranularName`: Name of most recent type of granular material spread, read from the material spreader.\n- `spreaderPrewetName`: Name of most recent type of prewet material spread, read from the material spreader.\n- `spreaderLiquidName`: Name of most recent type of liquid material spread, read from the material spreader.\n- `spreaderPlowStatus`: Snow plow status (`Up` or `Down`), as read from the material spreader. Note: this is separate from plow status defined via auxInput.\n- `seatbeltDriver`: Seatbelt Driver Status as read from the vehicle. `Buckled` or `Unbuckled`. (Beta only)"
        explode: false
        in: query
        name: types
        required: true
        schema:
          items:
            enum:
            - ambientAirTemperatureMilliC
            - auxInput1
            - auxInput2
            - auxInput3
            - auxInput4
            - auxInput5
            - auxInput6
            - auxInput7
            - auxInput8
            - auxInput9
            - auxInput10
            - auxInput11
            - auxInput12
            - auxInput13
            - barometricPressurePa
            - batteryMilliVolts
            - defLevelMilliPercent
            - ecuSpeedMph
            - engineCoolantTemperatureMilliC
            - engineImmobilizer
            - engineLoadPercent
            - engineOilPressureKPa
            - engineRpm
            - engineStates
            - faultCodes
            - fuelPercents
            - gps
            - gpsDistanceMeters
            - gpsOdometerMeters
            - intakeManifoldTemperatureMilliC
            - nfcCardScans
            - obdEngineSeconds
            - obdOdometerMeters
            - syntheticEngineSeconds
            - evStateOfChargeMilliPercent
            - evChargingStatus
            - evChargingEnergyMicroWh
            - evChargingVoltageMilliVolt
            - evChargingCurrentMilliAmp
            - evConsumedEnergyMicroWh
            - evRegeneratedEnergyMicroWh
            - evBatteryVoltageMilliVolt
            - evBatteryCurrentMilliAmp
            - evBatteryStateOfHealthMilliPercent
            - evAverageBatteryTemperatureMilliCelsius
            - evDistanceDrivenMeters
            - spreaderLiquidRate
            - spreaderGranularRate
            - spreaderPrewetRate
            - spreaderAirTemp
            - spreaderRoadTemp
            - spreaderOnState
            - spreaderActive
            - spreaderBlastState
            - spreaderGranularName
            - spreaderPrewetName
            - spreaderLiquidName
            - spreaderPlowStatus
            - seatbeltDriver
            type: string
          type: array
        style: form
      - description: '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)'
        explode: false
        in: query
        name: decorations
        schema:
          items:
            enum:
            - 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
            type: string
          type: array
        style: form
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VehicleStatsListResponse'
          description: List of vehicle stats for the specified vehicles, stat type, and time range.
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/standardErrorResponse'
          description: Error response
      summary: Historical Stats
      tags:
      - Vehicles
  /fleet/vehicles/tachograph-files/history:
    get:
      description: "Returns all known tachograph files for all specified vehicles in the time range. \n\n <b>Rate limit:</b> 150 requests/sec (learn more about rate limits <a href=\"https://developers.samsara.com/docs/rate-limits\" target=\"_blank\">here</a>). \n\n **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our <a href=\"https://forms.gle/zkD4NCH7HjKb7mm69\" target=\"_blank\">API feedback form</a>. If you encountered an issue or noticed inaccuracies in the API documentation, please <a href=\"https://www.samsara.com/help\" target=\"_blank\">submit a case</a> to our support team.\n\nTo use this endpoint, select **Read Tachograph (EU)** under the Compliance category when creating or editing an API token. <a href=\"https://developers.samsara.com/docs/authentication#scopes-for-api-tokens\" target=\"_blank\">Learn More.</a>"
      operationId: getVehicleTachographFiles
      parameters:
      - description: If specified, this should be the endCursor value from the previous page of results. When present, this request will return the next page of results that occur immediately after the previous page of results.
        in: query
        name: after
        schema:
          type: string
      - description: 'A 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).'
        in: query
        name: startTime
        required: true
        schema:
          type: string
      - description: '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).'
        in: query
        name: endTime
        required: true
        schema:
          type: string
      - description: 'A filter on the data based on this comma-separated list of vehicle IDs. Example: `vehicleIds=1234,5678`'
        explode: false
        in: query
        name: vehicleIds
        schema:
          items:
            type: string
          type: array
        style: form
      - description: 'A filter on the data based on this comma-separated list of parent tag IDs, for use by orgs with tag hierarchies. Specifying a parent tag will implicitly include all descendent tags of the parent tag. Example: `parentTagIds=345,678`'
        explode: false
        in: query
        name: parentTagIds
        schema:
          items:
            type: string
          type: array
        style: form
      - description: 'A filter on the data based on this comma-separated list of tag IDs. Example: `tagIds=1234,5678`'
        explode: false
        in: query
        name: tagIds
        schema:
          items:
            type: string
          type: array
        style: form
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TachographVehicleFilesResponse'
          description: List of all vehicle tachograph files in a specified time range.
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/standardErrorResponse'
          description: Error response
      summary: Get Tachograph Vehicle Files
      tags:
      - Vehicles
  /fleet/vehicles/{id}:
    get:
      description: "Get information about a specific vehicle. \n\n **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our <a href=\"https://forms.gle/zkD4NCH7HjKb7mm69\" target=\"_blank\">API feedback form</a>. If you encountered an issue or noticed inaccuracies in the API documentation, please <a href=\"https://www.samsara.com/help\" target=\"_blank\">submit a case</a> to our support team.\n\nTo use this endpoint, select **Read Vehicles** under the Vehicles category when creating or editing an API token. <a href=\"https://developers.samsara.com/docs/authentication#scopes-for-api-tokens\" target=\"_blank\">Learn More.</a>"
      operationId: getVehicle
      parameters:
      - description: 'ID of the vehicle. This can either be the Samsara-specified ID, or an external ID. External IDs are customer specified key-value pairs created in the POST or PATCH requests of this resource, or automatically populated by fields on the vehicle. To specify an external ID as part of a path parameter, use the following format: `key:value`. For example, `maintenanceId:250020`. Automatically populated external IDs are prefixed with `samsara.`. For example, `samsara.vin:1HGBH41JXMN109186`.'
        in: path
        name: id
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VehicleResponse'
          description: Returns the specified vehicle object.
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/standardErrorResponse'
          description: Error response
      summary: Retrieve a Vehicle
      tags:
      - Vehicles
    patch:
      description: "Updates the given Vehicle object.\n\n**Note:** Vehicle objects are automatically created when Samsara Vehicle Gateways are installed. You cannot create a Vehicle object via API.\n\nYou are able to *update* many of the fields of a Vehicle.\n\n**Note**: There are no required fields in the request body, and you only need to provide the fields you wish to update. \n\n **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our <a href=\"https://forms.gle/zkD4NCH7HjKb7mm69\" target=\"_blank\">API feedback form</a>. If you encountered an issue or noticed inaccuracies in the API documentation, please <a href=\"https://www.samsara.com/help\" target=\"_blank\">submit a case</a> to our support team.\n\nTo use this endpoint, select **Write Vehicles** under the Vehicles category when creating or editing an API token. <a href=\"https://developers.samsara.com/docs/authentication#scopes-for-api-tokens\" target=\"_blank\">Learn More.</a>"
      operationId: updateVehicle
      parameters:
      - description: 'ID of the vehicle. This can either be the Samsara-specified ID, or an external ID. External IDs are customer specified key-value pairs created in the POST or PATCH requests of this resource, or automatically populated by fields on the vehicle. To specify an external ID as part of a path parameter, use the following format: `key:value`. For example, `maintenanceId:250020`. Automatically populated external IDs are prefixed with `samsara.`. For example, `samsara.vin:1HGBH41JXMN109186`.'
        in: path
        name: id
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateVehicleRequest'
        description: Fields that can be patched on a vehicle.
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VehicleResponse'
          description: Returns the specified vehicle object.
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/standardErrorResponse'
          description: Error response
      summary: Update a Vehicle
      tags:
      - Vehicles
      x-codegen-request-body-name: vehicle
  /preview/driver-efficiency/vehicles:
    get:
      description: "This endpoint will return driver efficiency data that has been collected for your organization and grouped by vehicle drivers used based on the time parameters passed in. Results are paginated.\n\n <b>Rate limit:</b> 5 requests/sec (learn more about rate limits <a href=\"https://developers.samsara.com/docs/rate-limits\" target=\"_blank\">here</a>).\n\nTo use this endpoint, select **Read Driver Efficiency** under the Closed Beta category when creating or editing an API token. <a href=\"https://developers.samsara.com/docs/authentication#scopes-for-api-tokens\" target=\"_blank\">Learn More.</a>\n\nEndpoints in this section are in Preview. These APIs are not functional and are instead for soliciting feedback from our API users on the intended design of this API. Additionally, it is not guaranteed that we will be releasing an endpoint included in this section to production. This means that developers should **NOT** rely on these APIs to build business critical applications\n\n- Samsara may change the structure of a preview API's interface without versioning or any notice to API users.\n\n- When an endpoint becomes generally available, it will be announced in the API [changelog](https://developers.samsara.com/changelog).\n \n\n **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our <a href=\"https://forms.gle/zkD4NCH7HjKb7mm69\" target=\"_blank\">API feedback form</a>. If you encountered an issue or noticed inaccuracies in the API documentation, please <a href=\"https://www.samsara.com/help\" target=\"_blank\">submit a case</a> to our support team."
      operationId: getDriverEfficiencyByVehicles
      parameters:
      - description: 'A start time in RFC 3339 format. Must be in multiple of hours and at least 1 day before endTime. Timezones are supported. Note that the most recent 72 hours of data may still be processing and is subject to change and latency, so it is not recommended to request data for the most recent 72 hours. (Examples: 2019-06-11T19:00:00Z, 2015-09-12T14:00:00-04:00).'
        in: query
        name: startTime
        required: true
        schema:
          type: string
      - description: 'An end time in RFC 3339 format. Must be in multiple of hours and no later than 3 hours before the current time. Timezones are supported. Note that the most recent 72 hours of data may still be processing and is subject to change and latency, so it is not recommended to request data for the most recent 72 hours. (Examples: 2019-06-13T19:00:00Z, 2015-09-15T14:00:00-04:00).'
        in: query
        name: endTime
        required: true
        schema:
          type: string
      - description: ' A filter on the data based on this comma-separated list of vehicle IDs and externalIds. Example: `vehicleIds=1234,5678,samsara.vin:1HGBH41JXMN109186`'
        in: query
        name: vehicleIds
        schema:
          type: string
      - description: 'A comma-separated list of data formats you want to fetch. Valid values: `score`, `raw` and `percentage`. The default data format is `score`. Example: `dataFormats=raw,score`'
        explode: false
        in: query
        name: dataFormats
        schema:
          items:
            type: string
          type: array
        style: form
      - description: ' A filter on the data based on this comma-separated list of tag IDs. Example: `tagIds=1234,5678`'
        in: query
        name: tagIds
        schema:
          type: string
      - description: ' A filter on the data based on this comma-separated list of parent tag IDs, for use by orgs with tag hierarchies. Specifying a parent tag will implicitly include all descendent tags of the parent tag. Example: `parentTagIds=345,678`'
        in: query
        name: parentTagIds
        schema:
          type: string
      - description: ' If specified, this should be the endCursor value from the previous page of results. When present, this request will return the next page of results that occur immediately after the previous page of results.'
        in: query
        name: after
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DriverEfficiencyGetDriverEfficiencyByVehiclesResponseBody'
          description: OK response.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DriverEfficiencyGetDriverEfficiencyByVehiclesUnauthorizedErrorResponseBody'
          description: Unauthorized response.
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DriverEfficiencyGetDriverEfficiencyByVehiclesNotFoundErrorResponseBody'
          description: Not Found response.
        '405':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DriverEfficiencyGetDriverEfficiencyByVehiclesMethodNotAllowedErrorResponseBody'
          description: Method Not Allowed response.
        '429':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DriverEfficiencyGetDriverEfficiencyByVehiclesTooManyRequestsErrorResponseBody'
          description: Too Many Requests response.
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DriverEfficiencyGetDriverEfficiencyByVehiclesInternalServerErrorResponseBody'
          description: Internal Server Error response.
        '501':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DriverEfficiencyGetDriverEfficiencyByVehiclesNotImplementedErrorResponseBody'
          description: Not Implemented response.
        '502':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DriverEfficiencyGetDriverEfficiencyByVehiclesBadGatewayErrorResponseBody'
          description: Bad Gateway response.
        '503':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DriverEfficiencyGetDriverEfficiencyByVehiclesServiceUnavailableErrorResponseBody'
          description: Service Unavailable response.
        '504':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DriverEfficiencyGetDriverEfficiencyByVehiclesGatewayTimeoutErrorResponseBody'
          description: Gateway Timeout response.
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DriverEfficiencyGetDriverEfficiencyByVehiclesBadRequestErrorResponseBody'
          description: Bad Request response.
      summary: '[preview] Get Driver Efficiency Data Grouped by Vehicles.'
      tags:
      - Vehicles
  /v1/fleet/vehicles/{vehicleId}/safety/harsh_event:
    get:
      description: "<n class=\"warning\">\n<nh>\n<i class=\"fa fa-exclamation-circle\"></i>\nThis endpoint is still on our legacy API.\n</nh>\n</n>\n\nFetch harsh event details for a vehicle. \n\n **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our <a href=\"https://forms.gle/zkD4NCH7HjKb7mm69\" target=\"_blank\">API feedback form</a>. If you encountered an issue or noticed inaccuracies in the API documentation, please <a href=\"https://www.samsara.com/help\" target=\"_blank\">submit a case</a> to our support team.\n\nTo use this endpoint, select **Read Safety Events & Scores** under the Safety & Cameras category when creating or editing an API token. <a href=\"https://developers.samsara.com/docs/authentication#scopes-for-api-tokens\" target=\"_blank\">Learn More.</a>"
      operationId: V1getVehicleHarshEvent
      parameters:
      - description: ID of the vehicle. Must contain only digits 0-9.
        in: path
        name: vehicleId
        required: true
        schema:
          format: int64
          type: integer
      - description: Timestamp in milliseconds representing the timestamp of a harsh event.
        in: query
        name: timestamp
        required: true
        schema:
          format: int64
          type: integer
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V1VehicleHarshEventResponse'
          description: Harsh event details.
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V1ErrorResponse'
          description: Unexpected error.
      summary: Fetch Harsh Events
      tags:
      - Vehicles
  /v1/fleet/vehicles/{vehicleId}/safety/score:
    get:
      description: "<n class=\"warning\">\n<nh>\n<i class=\"fa fa-exclamation-circle\"></i>\nThis endpoint is still on our legacy API.\n</nh>\n</n>\n\nFetch the safety score for the vehicle. \n\n <b>Rate limit:</b> 5 requests/sec (learn more about rate limits <a href=\"https://developers.samsara.com/docs/rate-limits\" target=\"_blank\">here</a>). \n\n **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our <a href=\"https://forms.gle/zkD4NCH7HjKb7mm69\" target=\"_blank\">API feedback form</a>. If you encountered an issue or noticed inaccuracies in the API documentation, please <a href=\"https://www.samsara.com/help\" target=\"_blank\">submit a case</a> to our support team.\n\nTo use this endpoint, select **Read Safety Events & Scores** under the Safety & Cameras category when creating or editing an API token. <a href=\"https://developers.samsara.com/docs/authentication#scopes-for-api-tokens\" target=\"_blank\">Learn More.</a>"
      operationId: V1getVehicleSafetyScore
      parameters:
      - description: ID of the vehicle. Must contain only digits 0-9.
        in: path
        name: vehicleId
        required: true
        schema:
          format: int64
          type: integer
      - description: Timestamp in milliseconds representing the start of the period to fetch, inclusive. Used in combination with endMs. Total duration (endMs - startMs) must be greater than or equal to 1 hour.
        in: query
        name: startMs
        required: true
        schema:
          format: int64
          type: integer
      - description: Timestamp in milliseconds representing the end of the period to fetch, inclusive. Used in combination with startMs. Total duration (endMs - startMs) must be greater than or equal to 1 hour.
        in: query
        name: endMs
        required: true
        schema:
          format: int64
          type: integer
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V1VehicleSafetyScoreResponse'
          description: Safety score details.
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V1ErrorResponse'
          description: Unexpected error.
      summary: Fetch Vehicle Safety Scores
      tags:
      - Vehicles
components:
  schemas:
    VehicleStatsEngineLoadPercentWithDecoration:
      description: The engine load percentage reading.
      properties:
        decorations:
          $ref: '#/components/schemas/VehicleStatsDecorations'
        time:
          $ref: '#/components/schemas/time'
        value:
          description: The engine load in percentage points (e.g. `99`, `50`, etc).
          example: 54
          format: int64
          type: integer
      required:
      - time
      - value
      type: object
    VehicleStatsResponse_spreaderPlowStatus:
      description: 'Snow plow status (`Up` or `Down`), as read from the material spreader. Note: this is separate from plow status defined via auxInput.'
      properties:
        time:
          description: 'UTC timestamp in RFC 3339 format. Example: `2020-01-27T07:06:25Z`.'
          example: '2020-01-27T07:06:25Z'
          type: string
        value:
          description: Snow plow status, as read from the material spreader
          enum:
          - Up
          - Down
          example: Down
          type: string
      required:
      - time
      - value
      type: object
    VehicleStatsResponse_spreaderBlastState:
      description: Whether vehicle is actively spreading material in blast mode.
      properties:
        time:
          description: 'UTC timestamp in RFC 3339 format. Example: `2020-01-27T07:06:25Z`.'
          example: '2020-01-27T07:06:25Z'
          type: string
        value:
          description: Whether vehicle is actively spreading material in blast mode.
          enum:
          - 'On'
          - 'Off'
          example: 'Off'
          type: string
      required:
      - time
      - value
      type: object
    V1ErrorResponse:
      description: Error message describing why the request failed.
      type: string
    VehicleStatsEngineState:
      description: Vehicle engine state event.
      properties:
        time:
          $ref: '#/components/schemas/time'
        value:
          $ref: '#/components/schemas/VehicleStatsEngineStateSetting'
      required:
      - time
      - value
      type: object
    VehicleStatsResponse_evDistanceDrivenMeters:
      description: Electric distance driven for electric and hybrid vehicles in meters. Not all EV and HEVs may report this field.
      properties:
        time:
          description: 'UTC timestamp in RFC 3339 format. Example: `2020-01-27T07:06:25Z`.'
          example: '2020-01-27T07:06:25Z'
          type: string
        value:
          description: Electric distance driven for electric and hybrid vehicles in meters.
          example: 1000
          format: int64
          type: integer
      required:
      - time
      - value
      type: object
    DriverEfficiencyGetDriverEfficiencyByVehiclesNotImplementedErrorResponseBody:
      description: Requested endpoint is not yet implemented
      properties:
        message:
          description: Message of error
          example: Not implemented.
          type: string
        requestId:
          description: The request ID; used when reaching out to support for issues with requests.
          example: 8916e1c1
          type: string
      required:
      - message
      - requestId
      type: object
    time:
      description: 'UTC timestamp in RFC 3339 format. Example: `2020-01-27T07:06:25Z`.'
      example: '2020-01-27T07:06:25Z'
      type: string
    VehicleStatsAuxInputValue:
      description: Boolean indicating the state of the auxiliary equipment.
      example: true
      type: boolean
    VehicleStatsDecorations_ecuSpeedMph:
      properties:
        value:
          $ref: '#/components/schemas/VehicleStatsEcuSpeedMphValue'
      required:
      - value
      type: object
    VehicleStatsEvDistanceDrivenMeters:
      description: Electric distance driven for electric and hybrid vehicles in meters. Not all EV and HEVs may report this field.
      properties:
        time:
          $ref: '#/components/schemas/time'
        value:
          description: Electric distance driven for electric and hybrid vehicles in meters.
          example: 1000
          format: int64
          type: integer
      required:
      - time
      - value
      type: object
    VehicleStatsEcuSpeedMphValue:
      description: The speed of the vehicle in miles per hour, as reported by the ECU.
      example: 58.3
      format: double
      type: number
    VehicleStatsEvRegeneratedEnergyMicroWh:
      description: Regenerated energy for electric and hybrid vehicles in microwatt hours. Not all EV and HEVs may report this field.
      properties:
        time:
          $ref: '#/components/schemas/time'
        value:
          description: Regenerated energy for electric and hybrid vehicles in microwatt hours.
          example: 1000
          format: int64
          type: integer
      required:
      - time
      - value
      type: object
    DriverEfficiencyRawDataObjectResponseBody:
      description: Driver Efficiency raw data. This object is returned when the raw format is specified in dataFormats.
      properties:
        anticipationBrakeEventCount:
          description: Total number of quick braking events (less than one second after accelerating).
          example: 17
          format: int64
          type: integer
        averageVehicleWeightKg:
          description: Average vehicle weight in kilograms.
          example: 14500
          format: int64
          type: integer
        coastingDurationMs:
          description: Time spent without engaging the accelerator or brake in milliseconds.
          example: 1900800
          format: int64
          type: integer
        cruiseControlDurationMs:
          description: Time spent in cruise control in milliseconds.
          example: 3283200
          format: int64
          type: integer
        driveTimeDurationMs:
          description: Total driving time in milliseconds.
          example: 7200000
          format: int64
          type: integer
        engineOnDurationMs:
          description: Total engine-on time in milliseconds.
          example: 7500000
          format: int64
          type: integer
        greenBandDurationMs:
          description: Time spent driving within the configurable green band in milliseconds.
          example: 5683200
          format: int64
          type: integer
        highGradeRoadDrivingDurationMs:
          description: Time spent driving on high-grade roads in milliseconds.
          example: 1108800
          format: int64
          type: integer
        highTorqueDurationMs:
          description: 'Time the vehicle engine torque is greater than 90% in milliseconds. '
          example: 1684800
          format: int64
          type: integer
        idlingDurationMs:
          description: Time spent idling in milliseconds.
          example: 921600
          format: int64
          type: integer
        overSpeedDurationMs:
          description: Time spent over-speeding in milliseconds.
          example: 403200
          format: int64
          type: integer
        totalBrakeDurationMs:
          description: Total breaking time in milliseconds.
          example: 1022400
          format: int64
          type: integer
        totalBrakeEventCount:
          description: Total number of brake events.
          example: 85
          format: int64
          type: integer
        wearFreeBrakeDurationMs:
          description: Time spent ware-free breaking in milliseconds.
          example: 6340800
          format: int64
          type: integer
      required:
      - driveTimeDurationMs
      - engineOnDurationMs
      - idlingDurationMs
      - totalBrakeDurationMs
      type: object
    DriverEfficiencyGetDriverEfficiencyByVehiclesServiceUnavailableErrorResponseBody:
      description: Service unavailable
      properties:
        message:
          description: Message of error
          example: context deadline exceeded
          type: string
        requestId:
          description: The request ID; used when reaching out to support for issues with requests.
          example: 8916e1c1
          type: string
      required:
      - message
      - requestId
      type: object
    VehicleStatsResponse_evChargingEnergyMicroWh:
      description: Charging energy for electric and hybrid vehicles in microwatt hours. Not all EV and HEVs may report this field.
      properties:
        time:
          description: 'UTC timestamp in RFC 3339 format. Example: `2020-01-27T07:06:25Z`.'
          example: '2020-01-27T07:06:25Z'
          type: string
        value:
          description: Charging energy for electric and hybrid vehicles in microwatt hours.
          example: 1000
          format: int64
          type: integer
      required:
      - time
      - value
      type: object
    standardErrorResponse:
      description: Error response
      properties:
        message:
          description: The message of the error.
          example: An error has occurred.
          type: string
        requestId:
          description: The ID of the request.
          example: 8916e1c1
          type: string
      type: object
    VehicleStatsFuelPercentValue:
      description: The engine fuel level in percentage points (e.g. `99`, `50`, etc).
      example: 54
      format: int64
      type: integer
    VehicleStatsFaultCodesOemTroubleCode:
      description: Proprietary diagnostic trouble code for some OEM vehicles.
      properties:
        codeDescription:
          description: The OEM code description.
          example: KVGT Servo Error
          type: string
        codeIdentifier:
          description: The OEM code identifier.
          example: CA2387
          type: string
        codeSeverity:
          description: The OEM code severity.
          example: L03
          type: string
        codeSource:
          description: The OEM code source.
          example: ENG/M
          type: string
      type: object
    DriverEfficiencyGetDriverEfficiencyByVehiclesInternalServerErrorResponseBody:
      description: An internal server error occurred
      properties:
        message:
          description: Message of error
          example: Failed to execute GraphQL query.
          type: string
        requestId:
          description: The request ID; used when reaching out to support for issues with requests.
          example: 8916e1c1
          type: string
      required:
      - message
      - requestId
      type: object
    VehicleAuxInputName:
      description: 'The type of <a href="https://kb.samsara.com/hc/en-us/articles/360043040512-Auxiliary-Inputs" target="_blank">auxiliary input</a> configured for this Vehicle. Once configured, these inputs will generate dynamic, time-series data that will be available to view in the Samsara Dashboard. **By default**: empty. This can be set or updated through the Samsara Dashboard or the API at any time. Inputs 3-13 are only available on gateways with an attached aux expander. The value returned will match what is configured in the dashboard per vehicle.'
      example: Boom
      type: string
    VehicleStatsFaultCodesJ1939TroubleCode:
      description: Diagnostic trouble code for J1939 vehicles.
      properties:
        fmiDescription:
          description: A short description of the FMI identifier, if available.
          example: Voltage Below Normal
          type: string
        fmiId:
          description: The FMI identifier.
          example: 9
          format: int32
          type: integer
        milStatus:
          description: The MIL status, indicating a check engine light.
          example: 1
          format: int32
          type: integer
        occurrenceCount:
          description: The number of times this fault has triggered.
          example: 1
          format: int32
          type: integer
        sourceAddressName:
          description: The source address name corresponding to the txId
          example: 'Engine #1'
          type: string
        spnDescription:
          description: A short description of the SPN identifier, if available.
          example: 'System Diagnostic Code #1'
          type: string
        spnId:
          description: The SPN identifier.
          example: 3031
          format: int32
          type: integer
        txId:
          $ref: '#/components/schemas/VehicleStatsFaultCodesTxId'
        vendorSpecificFields:
          $ref: '#/components/schemas/VehicleStatsFaultCodesVendorSpecificFields'
      required:
      - fmiId
      - milStatus
      - occurrenceCount
      - spnId
      - txId
      type: object
    VehicleStatsListGps:
      description: GPS location data for the vehicle.
      properties:
        address:
          $ref: '#/components/schemas/VehicleLocationAddress'
        decorations:
          $ref: '#/components/schemas/VehicleStatsDecorations'
        headingDegrees:
          $ref: '#/components/schemas/VehicleLocationHeading'
        isEcuSpeed:
          $ref: '#/components/schemas/VehicleLocationIsEcuSpeed'
        latitude:
          $ref: '#/components/schemas/VehicleLocationLatitude'
        longitude:
          $ref: '#/components/schemas/VehicleLocationLongitude'
        reverseGeo:
          $ref: '#/components/schemas/reverseGeo'
        speedMilesPerHour:
          $ref: '#/components/schemas/VehicleLocationSpeed'
        time:
          $ref: '#/components/schemas/time'
      required:
      - latitude
      - longitude
      - time
      type: object
    EngineImmobilizerGetEngineImmobilizerStatesBadRequestErrorResponseBody:
      description: Bad Request parameters
      properties:
        message:
          description: Message of error
          example: Invalid value for parameter.
          type: string
        requestId:
          description: The request ID; used when reaching out to support for issues with requests.
          example: 8916e1c1
          type: string
      required:
      - message
      - requestId
      type: object
    VehicleStatsSpreaderPrewetName:
      description: Name of most recent type of prewet material spread, read from the material spreader.
      properties:
        time:
          $ref: '#/components/schemas/time'
        value:
          description: Name of most recent type of prewet material spread, read from the material spreader.
          example: PWT1
          type: string
      required:
      - time
      - value
      type: object
    VehicleStatsFaultCodesJ1939TroubleCodes:
      description: Diagnostic trouble codes for J1939 vehicles.
      items:
        $ref: '#/components/schemas/VehicleStatsFaultCodesJ1939TroubleCode'
      type: array
    VehicleStatsFaultCodesPassengerMonitorStatus:
      description: Readings from engine sensors
      properties:
        catalyst:
          $ref: '#/components/schemas/VehicleStatsFaultCodesPassengerMonitorStatusValue'
        comprehensive:
          $ref: '#/components/schemas/VehicleStatsFaultCodesPassengerMonitorStatusValue'
        egr:
          $ref: '#/components/schemas/VehicleStatsFaultCodesPassengerMonitorStatusValue'
        evapSystem:
          $ref: '#/components/schemas/VehicleStatsFaultCodesPassengerMonitorStatusValue'
        fuel:
          $ref: '#/components/schemas/VehicleStatsFaultCodesPassengerMonitorStatusValue'
        heatedCatalyst:
          $ref: '#/components/schemas/VehicleStatsFaultCodesPassengerMonitorStatusValue'
        heatedO2Sensor:
          $ref: '#/components/schemas/VehicleStatsFaultCodesPassengerMonitorStatusValue'
        isoSaeReserved:
          $ref: '#/components/schemas/VehicleStatsFaultCodesPassengerMonitorStatusValue'
        misfire:
          $ref: '#/components/schemas/VehicleStatsFaultCodesPassengerMonitorStatusValue'
        notReadyCount:
          description: 'Count of the number of sensors reporting N: Not Complete'
          type: integer
        o2Sensor:
          $ref: '#/components/schemas/VehicleStatsFaultCodesPassengerMonitorStatusValue'
        secondaryAir:
          $ref: '#/components/schemas/VehicleStatsFaultCodesPassengerMonitorStatusValue'
      type: object
    VehicleStatsDefLevelMilliPercentWithDecoration:
      description: The Diesel Exhaust Fluid (DEF) milli percentage reading.
      properties:
        decorations:
          $ref: '#/components/schemas/VehicleStatsDecorations'
        time:
          $ref: '#/components/schemas/time'
        value:
          description: The Diesel Exhaust Fluid (DEF) level in milli percentage points (e.g. `99001`, `49999`, etc).
          example: 54200
          format: int64
          maximum: 99999
          minimum: 0
          type: integer
      required:
      - time
      - value
      type: object
    VehiclesListVehiclesBadRequestErrorResponseBody:
      description: Bad Request parameters
      properties:
        message:
          description: Message of error
          example: Invalid value for parameter.
          type: string
        requestId:
          description: The request ID; used when reaching out to support for issues with requests.
          example: 8916e1c1
          type: string
      required:
      - message
      - requestId
      type: object
    VehicleStatsAmbientAirTempMilliCWithDecoration:
      description: Vehicle ambient air temperature reading.
      properties:
        decorations:
          $ref: '#/components/schemas/VehicleStatsDecorations'
        time:
          $ref: '#/components/schemas/time'
        value:
          description: The ambient air temperature reading in millidegree Celsius.
          example: 31110
          format: int64
          type: integer
      required:
      - time
      - value
      type: object
    VehicleLocationsResponse_data:
      description: A vehicle and its most recent location.
      properties:
        id:
          $ref: '#/components/schemas/VehicleId'
        location:
          $ref: '#/components/schemas/VehicleLocation'
        name:
          $ref: '#/components/schemas/VehicleName'
      required:
      - id
      - location
      - name
      type: object
    UserIdentifierSerial:
      description: 'The serial number of the gateway. **By default**: empty. This can be set to a different gateway''s serial number to pair this vehicle with a different gateway.'
      example: ABCD-123-XYZ
      type: string
    VehicleModel:
      description: The Vehicles manufacturing model. Automatically read from the engine computer if available. Empty if not available. Cannot be manually set.
      example: F150
      maxLength: 255
      type: string
    VehicleStatsDecorations_gpsDistanceMeters:
      properties:
        value:
          $ref: '#/components/schemas/VehicleStatsGpsDistanceMetersValue'
      required:
      - value
      type: object
    VehicleStatsGpsDistanceMetersValue:
      description: Number of meters the vehicle has traveled since the gateway was installed, based on GPS calculations.
      example: 81029.591434899
      format: double
      type: number
    DriverEfficiencyGetDriverEfficiencyByVehiclesTooManyRequestsErrorResponseBody:
      description: Too many requests
      properties:
        message:
          description: Message of error
          example: Exceeded rate limit.
          type: string
        requestId:
          description: The request ID; used when reaching out to support for issues with requests.
          example: 8916e1c1
          type: string
      required:
      - message
      - requestId
      type: object
    GoaAttributeTinyResponseBody:
      description: Attribute properties.
      properties:
        id:
          description: Id of the attribute
          example: '494123'
          type: string
        name:
          description: Name of the attribute
          example: Compliance/ELD
          type: string
        numberValues:
          description: List of number values associated with the attribute
          example:
          - 867
          - 5309
          items:
            example: 0.7405685598633346
            format: double
            type: number
          type: array
        stringValues:
          description: List of string values associated with the attribute.
          example:
          - HQ
          - Leased
          items:
            example: Tempora dolorum placeat.
            type: string
          type: array
      type: object
    VehicleStatsEngineOilPressureKPaWithDecoration:
      description: Vehicle engine oil pressure reading.
      properties:
        decorations:
          $ref: '#/components/schemas/VehicleStatsDecorations'
        time:
          $ref: '#/components/schemas/time'
        value:
          description: The engine oil pressure reading in kilopascals.
          example: 100
          format: int64
          type: integer
      required:
      - time
      - value
      type: object
    VehicleId:
      description: The unique Samsara ID of the Vehicle. This is automatically generated when the Vehicle object is created. It cannot be changed.
      example: '112'
      type: string
    VehicleStatsDecorations_engineStates:
      properties:
        value:
          description: The state of the engine.
          enum:
          - 'Off'
          - 'On'
          - Idle
          example: 'On'
          type: string
      required:
      - value
      type: object
    VehiclesDriverAssignmentsGetVehiclesDriverAssignmentsResponseBody:
      properties:
        data:
          description: List of vehicles and their driver assignments.
          items:
            $ref: '#/components/schemas/VehiclesDriverAssignmentsObjectResponseBody'
          type: array
        pagination:
          $ref: '#/components/schemas/GoaPaginationResponseResponseBody'
      required:
      - data
      - pagination
      type: object
    VehicleStatsResponse_evAverageBatteryTemperatureMilliCelsius:
      description: Battery temperature for electric and hybrid vehicles in milli celsius. Not all EV and HEVs may report this field.
      properties:
        time:
          description: 'UTC timestamp in RFC 3339 format. Example: `2020-01-27T07:06:25Z`.'
          example: '2020-01-27T07:06:25Z'
          type: string
        value:
          description: Battery temperature for electric and hybrid vehicles in milli celsius.
          example: 1000
          format: int64
          type: integer
      required:
      - time
      - value
      type: object
    VehicleStatsFaultCodesWithDecoration:
      description: Engine fault codes read from J1939, OBDII, and OEM vehicles.
      properties:
        canBusType:
          $ref: '#/components/schemas/VehicleStatsFaultCodesCanBusType'
        decorations:
          $ref: '#/components/schemas/VehicleStatsDecorations'
        j1939:
          $ref: '#/components/schemas/VehicleStatsFaultCodesJ1939'
        obdii:
          $ref: '#/components/schemas/VehicleStatsFaultCodesOBDII'
        oem:
          $ref: '#/components/schemas/VehicleStatsFaultCodesOem'
        time:
          $ref: '#/components/schemas/time'
      required:
      - time
      type: object
    VehicleStatsEvChargingStatus:
      description: Charging status for electric and hybrid vehicles. Not all EV and HEVs may report this field.
      properties:
        time:
          $ref: '#/components/schemas/time'
        value:
          description: "Charging status for electric and hybrid vehicles. Statuses:\n unknown - 0,\n not charging - 1,\n charging - 2."
          enum:
          - 0
          - 1
          - 2
          - 3
          - 4
          format: int64
          type: integer
      required:
      - time
      - value
      type: object
    vehicleStatsAuxInputTime:
      description: 'UTC timestamp in RFC 3339 format. Example: `2020-01-27T07:06:25Z`.'
      example: '2020-01-27T07:06:25Z'
      type: string
      x-go-gen-location: models
    VehicleStatsFaultCodesValue_obdii_monitorStatus:
      description: Readings from engine sensors
      properties:
        catalyst:
          description: 'Enum of monitor status:

            -U: Unsupported

            -N: Not Complete

            -R: Complete

            '
          enum:
          - N
          - R
          - U
          type: string
        comprehensive:
          description: 'Enum of monitor status:

            -U: Unsupported

            -N: Not Complete

            -R: Complete

            '
          enum:
          - N
          - R
          - U
          type: string
        egr:
          description: 'Enum of monitor status:

            -U: Unsupported

            -N: Not Complete

            -R: Complete

            '
          enum:
          - N
          - R
          - U
          type: string
        evapSystem:
          description: 'Enum of monitor status:

            -U: Unsupported

            -N: Not Complete

            -R: Complete

            '
          enum:
          - N
          - R
          - U
          type: string
        fuel:
          description: 'Enum of monitor status:

            -U: Unsupported

            -N: Not Complete

            -R: Complete

            '
          enum:
          - N
          - R
          - U
          type: string
        heatedCatalyst:
          description: 'Enum of monitor status:

            -U: Unsupported

            -N: Not Complete

            -R: Complete

            '
          enum:
          - N
          - R
          - U
          type: string
        heatedO2Sensor:
          description: 'Enum of monitor status:

            -U: Unsupported

            -N: Not Complete

            -R: Complete

            '
          enum:
          - N
          - R
          - U
          type: string
        isoSaeReserved:
          description: 'Enum of monitor status:

            -U: Unsupported

            -N: Not Complete

            -R: Complete

            '
          enum:
          - N
          - R
          - U
          type: string
        misfire:
          description: 'Enum of monitor status:

            -U: Unsupported

            -N: Not Complete

            -R: Complete

            '
          enum:
          - N
          - R
          - U
          type: string
        notReadyCount:
          description: 'Count of the number of sensors reporting N: Not Complete'
          type: integer
        o2Sensor:
          description: 'Enum of monitor status:

            -U: Unsupported

            -N: Not Complete

            -R: Complete

            '
          enum:
          - N
          - R
          - U
          type: string
        secondaryAir:
          description: 'Enum of monitor status:

            -U: Unsupported

            -N: Not Complete

            -R: Complete

            '
          enum:
          - N
          - R
          - U
          type: string
      type: object
    VehicleStatsEngineImmobilizerWithDecoration:
      description: Data for the engine immobilizer
      properties:
        connected:
          description: Whether the engine immobilizer is connected or not
          example: false
          type: boolean
        decorations:
          $ref: '#/components/schemas/VehicleStatsDecorations'
        state:
          description: '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).'
          enum:
          - ignition_disabled
          - ignition_enabled
          example: ignition_disabled
          type: string
        time:
          $ref: '#/components/schemas/vehicleStatsAuxInputTime'
      required:
      - connected
      - state
      - time
      type: object
    VehicleStatsIntakeManifoldTempMilliC:
      description: Vehicle intake manifold temperature reading.
      properties:
        time:
          $ref: '#/components/schemas/time'
        value:
          description: The intake manifold temperature reading in millidegree Celsius.
          example: 88000
          format: int64
          type: integer
      required:
      - time
      - value
      type: object
    vehicleSensorConfigurationAreaResponseBody:
      description: A configured sensor area on the vehicle with its associated sensors
      properties:
        cargoSensors:
          items:
            $ref: '#/components/schemas/sensorResponseBody'
          type: array
        humiditySensors:
          items:
            $ref: '#/components/schemas/sensorResponseBody'
          type: array
        position:
          description: 'Position of the area on vehicle  Valid values: `back`, `front`, `middle`'
          enum:
          - back
          - front
          - middle
          example: back
          type: string
        temperatureSensors:
          items:
            $ref: '#/components/schemas/sensorResponseBody'
          type: array
      required:
      - position
      type: object
    VehicleYear:
      description: Year of the Vehicle.
      example: '2008'
      type: string
    VehicleStatsNfcCardScan_card:
      description: The card that was scanned.
      properties:
        id:
          description: The id code of the card that was scanned.
          example: '835063'
          type: string
      type: object
    EngineImmobilizerGetEngineImmobilizerStatesResponseBody:
      properties:
        data:
          description: A list of engine immobilizer states in ascending order of happenedAtTime.
          items:
            $ref: '#/components/schemas/EngineImmobilizerStateResponseBody'
          type: array
        pagination:
          $ref: '#/components/schemas/GoaPaginationResponseResponseBody'
      required:
      - data
      - pagination
      type: object
    TachographVehicleFile:
      description: Tachograph vehicle file
      properties:
        createdAtTime:
          description: Creation time of files in RFC 3339 format. This is either the download time from the tachograph itself (for files downloaded via Samsara VG) or upload time (for files manually uploaded via Samsara UI).
          example: 2020-01-02T15:04:05Z07:00
          type: string
        id:
          description: ID of the file.
          example: 4aff772c-a7bb-45e6-8e41-6a53e34feb83
          type: string
        url:
          description: A temporary URL which can be used to download the file. The link can be used multiple times and expires after an hour.
          example: https://samsara-tachograph-files.s3.us-west-2.amazonaws.com/123/456/789/4aff772c-a7bb-45e6-8e41-6a53e34feb83.ddd
          type: string
        vehicleIdentificationNumber:
          description: VIN associated with the vehicle file.
          example: '1000000492436002'
          type: string
      type: object
    VehiclesDriverAssignmentsObjectResponseBody:
      properties:
        driverAssignments:
          description: List of driver assignment objects.
          items:
            $ref: '#/components/schemas/DriverAssignmentObjectResponseBody'
          type: array
        externalIds:
          additionalProperties:
            type: string
          description: A map of external ids
          type: object
        id:
          description: ID of the vehicle.
          example: '494123'
          type: string
        name:
          description: Name of the vehicle.
          example: Bus-123
          type: string
      required:
      - driverAssignments
      - id
      type: object
    paginationResponse:
      description: Pagination parameters.
      properties:
        endCursor:
          description: Cursor identifier representing the last element in the response. This value should be used in conjunction with a subsequent request's 'after' query parameter. This may be an empty string if there are no more pages left to view.
          example: MjkY
          format: string
          type: string
        hasNextPage:
          description: True if there are more pages of results immediately available after this endCursor.
          example: true
          type: boolean
      required:
      - endCursor
      - hasNextPage
      type: object
    VehicleStatsEngineLoadPercentValue:
      description: The engine load in percentage points (e.g. `99`, `50`, etc).
      example: 54
      format: int64
      type: integer
    VehicleStatsEngineRpmValue:
      description: The revolutions per minute of the engine.
      example: 1000
      format: int64
      type: integer
    VehicleStatsSeatbeltDriver:
      description: Seatbelt Driver Status as read from the vehicle. `Buckled` or `Unbuckled`.
      properties:
        time:
          $ref: '#/components/schemas/time'
        value:
          description: Seatbelt Driver Status as read from the vehicle. `Buckled` or `Unbuckled`.
          enum:
          - Buckled
          - Unbuckled
          example: Buckled
          type: string
      required:
      - time
      - value
      type: object
    GoaDriverTinyResponseResponseBody:
      description: A minified driver object. This object is only returned if the route is assigned to the driver.
      properties:
        externalIds:
          additionalProperties:
            type: string
          description: A map of external ids
          type: object
        id:
          description: ID of the driver
          example: '45646'
          type: string
        name:
          description: Name of the driver
          example: Driver Bob
          type: string
      required:
      - id
      type: object
    VehicleStatsResponse_spreaderRoadTemp:
      description: Road temperature reading in milli celsius from material spreader.
      properties:
        time:
          description: 'UTC timestamp in RFC 3339 format. Example: `2020-01-27T07:06:25Z`.'
          example: '2020-01-27T07:06:25Z'
          type: string
        value:
          description: Road temperature reading in milli celsius from material spreader.
          example: 1000
          format: int64
          type: integer
      required:
      - time
      - value
      type: object
    VehicleStatsSpreaderGranularName:
      description: Name of most recent type of granular material spread, read from the material spreader.
      properties:
        time:
          $ref: '#/components/schemas/time'
        value:
          description: Name of most recent type of granular material spread, read from the material spreader.
          example: SALT
          type: string
      required:
      - time
      - value
      type: object
    VehiclesDriverAssignmentsGetVehiclesDriverAssignmentsGatewayTimeoutErrorResponseBody:
      description: Gateway timeout
      properties:
        message:
          description: Message of error
          example: context deadline exceeded
          type: string
        requestId:
          description: The request ID; used when reaching out to support for issues with requests.
          example: 8916e1c1
          type: string
      required:
      - message
      - requestId
      type: object
    CameraSerial:
      description: The serial number of the camera installed in the vehicle
      example: CNCK-VT8-XA8
      type: string
    VehicleStatsNfcCardScanWithDecoration:
      description: Data for the nfc card and the time that it was scanned.
      properties:
        card:
          $ref: '#/components/schemas/VehicleStatsNfcCardScan_card'
        decorations:
          $ref: '#/components/schemas/VehicleStatsDecorations'
        time:
          $ref: '#/components/schemas/vehicleStatsAuxInputTime'
      required:
      - card
      - time
      type: object
    VehicleStatsEngineStateWithDecoration:
      description: Vehicle engine state event.
      properties:
        decorations:
          $ref: '#/components/schemas/VehicleStatsDecorations'
        time:
          $ref: '#/components/schemas/time'
        value:
          $ref: '#/components/schemas/VehicleStatsEngineStateSetting'
      required:
      - time
      - value
      type: object
    EngineImmobilizerRelayStateResponseBody:
      description: An engine immobilizer relay state.
      properties:
        id:
          description: 'The ID of the relay  Valid values: `relay1`, `relay2`'
          enum:
          - relay1
          - relay2
          example: relay1
          type: string
        isOpen:
          description: Whether the relay is open.
          example: false
          type: boolean
      required:
      - id
      - isOpen
      type: object
    VehicleStatsResponse_evConsumedEnergyMicroWh:
      description: Consumed energy (including regenerated) for electric and hybrid vehicles in microwatt hours. Not all EV and HEVs may report this field.
      properties:
        time:
          description: 'UTC timestamp in RFC 3339 format. Example: `2020-01-27T07:06:25Z`.'
          example: '2020-01-27T07:06:25Z'
          type: string
        value:
          description: Consumed energy (including regenerated) for electric and hybrid vehicles in microwatt hours.
          example: 1000
          format: int64
          type: integer
      required:
      - time
      - value
      type: object
    VehicleStatsResponse_spreaderGranularRate:
      description: Granular spread rate reading in milliliters per meter, read from the material spreader. Unfiltered live stats are supplied as-read from the Material Spreader unit. Readings do not consider total spread rate(s) over time or distance. Unfiltered live stats are supplied as-read from the Material Spreader unit. Readings do not consider total spread rate(s) over time or distance.
      properties:
        time:
          description: 'UTC timestamp in RFC 3339 format. Example: `2020-01-27T07:06:25Z`.'
          example: '2020-01-27T07:06:25Z'
          type: string
        value:
          description: Granular spread rate reading in milliliters per meter, read from the material spreader. Unfiltered live stats are supplied as-read from the Material Spreader unit. Readings do not consider total spread rate(s) over time or distance. Unfiltered live stats are supplied as-read from the Material Spreader unit. Readings do not consider total spread rate(s) over time or distance.
          example: 1000
          format: int64
          type: integer
      required:
      - time
      - value
      type: object
    VehicleStatsEngineImmobilizer:
      description: Data for the engine immobilizer
      properties:
        connected:
          description: Whether the engine immobilizer is connected or not
          example: false
          type: boolean
        state:
          description: '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).'
          enum:
          - ignition_disabled
          - ignition_enabled
          example: ignition_disabled
          type: string
        time:
          $ref: '#/components/schemas/vehicleStatsAuxInputTime'
      required:
      - connected
      - state
      - time
      type: object
    VehicleLicensePlate:
      description: 'The license plate of the Vehicle. **By default**: empty. Can be set or updated through the Samsara Dashboard or the API at any time.'
      example: XHK1234
      maxLength: 12
      type: string
    VehicleStatsListResponse:
      description: List of vehicle stat events and pagination info.
      properties:
        data:
          description: A list of vehicles and an array of stat events for each vehicle.
          items:
            $ref: '#/components/schemas/VehicleStatsListResponse_data'
          type: array
        pagination:
          $ref: '#/components/schemas/paginationResponse'
      required:
      - data
      - pagination
      type: object
    VehicleStatsSpreaderGranularRate:
      description: Granular spread rate reading in milliliters per meter, read from the material spreader. Unfiltered live stats are supplied as-read from the Material Spreader unit. Readings do not consider total spread rate(s) over time or distance. Unfiltered live stats are supplied as-read from the Material Spreader unit. Readings do not consider total spread rate(s) over time or distance.
      properties:
        time:
          $ref: '#/components/schemas/time'
        value:
          description: Granular spread rate reading in milliliters per meter, read from the material spreader. Unfiltered live stats are supplied as-read from the Material Spreader unit. Readings do not consider total spread rate(s) over time or distance. Unfiltered live stats are supplied as-read from the Material Spreader unit. Readings do not consider total spread rate(s) over time or distance.
          example: 1000
          format: int64
          type: integer
      required:
      - time
      - value
      type: object
    VehicleStatsSpreaderLiquidRate:
      description: 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. Unfiltered live stats are supplied as-read from the Material Spreader unit. Readings do not consider total spread rate(s) over time or distance.
      properties:
        time:
          $ref: '#/components/schemas/time'
        value:
          description: 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. Unfiltered live stats are supplied as-read from the Material Spreader unit. Readings do not consider total spread rate(s) over time or distance.
          example: 1000
          format: int64
          type: integer
      required:
      - time
      - value
      type: object
    VehicleStatsResponse_spreaderLiquidRate:
      description: 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. Unfiltered live stats are supplied as-read from the Material Spreader unit. Readings do not consider total spread rate(s) over time or distance.
      properties:
        time:
          description: 'UTC timestamp in RFC 3339 format. Example: `2020-01-27T07:06:25Z`.'
          example: '2020-01-27T07:06:25Z'
          type: string
        value:
          description: 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. Unfiltered live stats are supplied as-read from the Material Spreader unit. Readings do not consider total spread rate(s) over time or distance.
          example: 1000
          format: int64
          type: integer
      required:
      - time
      - value
      type: object
    VehicleStatsResponse_spreaderActive:
      description: Whether vehicle is actively spreading any material.
      properties:
        time:
          description: 'UTC timestamp in RFC 3339 format. Example: `2020-01-27T07:06:25Z`.'
          example: '2020-01-27T07:06:25Z'
          type: string
        value:
          description: Whether vehicle is actively spreading any material.
          enum:
          - 'Off'
          - 'On'
          example: 'On'
          type: string
      required:
      - time
      - value
      type: object
    V1VehicleSafetyScoreResponse:
      description: Safety score details for a vehicle
      properties:
        crashCount:
          description: Crash event count
          example: 0
          type: integer
        harshAccelCount:
          description: Harsh acceleration event count
          example: 1
          type: integer
        harshBrakingCount:
          description: Harsh braking event count
          example: 2
          type: integer
        harshEvents:
          items:
            $ref: '#/components/schemas/V1SafetyReportHarshEvent'
          type: array
        harshTurningCount:
          description: Harsh turning event count
          example: 0
          type: integer
        safetyScore:
          description: The vehicles Safety Score for the requested period. Note that if the vehicle has zero drive time in this period, the Safety Score will be returned as 100.
          example: 97
          type: integer
        safetyScoreRank:
          description: Safety Score Rank
          example: '26'
          type: string
        timeOverSpeedLimitMs:
          description: Amount of time driven over the speed limit in milliseconds
          example: 3769
          type: integer
        totalDistanceDrivenMeters:
          description: Total distance driven in meters
          example: 291836
          type: integer
        totalHarshEventCount:
          description: Total harsh event count
          example: 3
          type: integer
        totalTimeDrivenMs:
          description: Amount of time driven in milliseconds
          example: 19708293
          type: integer
        vehicleId:
          description: Vehicle ID
          example: 4321
          type: integer
      type: object
    VehicleStatsFaultCodesOemTroubleCodes:
      description: Proprietary diagnostic trouble codes for OEM vehicles.
      items:
        $ref: '#/components/schemas/VehicleStatsFaultCodesOemTroubleCode'
      type: array
    VehicleStatsResponse_spreaderGranularName:
      description: Name of most recent type of granular material spread, read from the material spreader.
      properties:
        time:
          description: 'UTC timestamp in RFC 3339 format. Example: `2020-01-27T07:06:25Z`.'
          example: '2020-01-27T07:06:25Z'
          type: string
        value:
          description: Name of most recent type of granular material spread, read from the material spreader.
          example: SALT
          type: string
      required:
      - time
      - value
      type: object
    VehicleStatsResponse_evBatteryCurrentMilliAmp:
      description: Battery current for electric and hybrid vehicles in milli amps. Not all EV and HEVs may report this field.
      properties:
        time:
          description: 'UTC timestamp in RFC 3339 format. Example: `2020-01-27T07:06:25Z`.'
          example: '2020-01-27T07:06:25Z'
          type: string
        value:
          description: Battery current for electric and hybrid vehicles in milli amps.
          example: 1000
          format: int64
          type: integer
      required:
      - time
      - value
      type: object
    TachographVehicleFileData:
      items:
        $ref: '#/components/schemas/TachographVehicleFileListWrapper'
      type: array
    VehicleStatsDecorations_engineRpm:
      properties:
        value:
          $ref: '#/components/schemas/VehicleStatsEngineRpmValue'
      required:
      - value
      type: object
    VehicleStatsDefLevelMilliPercent:
      description: The Diesel Exhaust Fluid (DEF) milli percentage reading.
      properties:
        time:
          $ref: '#/components/schemas/time'
        value:
          description: The Diesel Exhaust Fluid (DEF) level in milli percentage points (e.g. `99001`, `49999`, etc).
          example: 54200
          format: int64
          maximum: 99999
          minimum: 0
          type: integer
      required:
      - time
      - value
      type: object
    EngineImmobilizerGetEngineImmobilizerStatesNotImplementedErrorResponseBody:
      description: Requested endpoint is not yet implemented
      properties:
        message:
          description: Message of error
          example: Not implemented.
          type: string
        requestId:
          description: The request ID; used when reaching out to support for issues with requests.
          example: 8916e1c1
          type: string
      required:
      - message
      - requestId
      type: object
    VehicleLocationsResponse:
      description: Most recent vehicle locations and pagination info.
      properties:
        data:
          description: List of the most recent locations for the specified vehicles.
          items:
            $ref: '#/components/schemas/VehicleLocationsResponse_data'
          type: array
        pagination:
          $ref: '#/components/schemas/paginationResponse'
      required:
      - data
      - pagination
      type: object
    VehiclesDriverAssignmentsGetVehiclesDriverAssignmentsInternalServerErrorResponseBody:
      description: An internal server error occurred
      properties:
        message:
          description: Message of error
          example: Failed to execute GraphQL query.
          type: string
        requestId:
          description: The request ID; used when reaching out to support for issues with requests.
          example: 8916e1c1
          type: string
      required:
      - message
      - requestId
      type: object
    VehicleStatsGpsOdometerMetersValue:
      description: Number of meters the vehicle has traveled according to the GPS calculations and the manually-specified odometer reading.
      example: 14010293
      format: int64
      type: integer
    VehicleStatsResponse_spreaderPrewetName:
      description: Name of most recent type of prewet material spread, read from the material spreader.
      properties:
        time:
          description: 'UTC timestamp in RFC 3339 format. Example: `2020-01-27T07:06:25Z`.'
          example: '2020-01-27T07:06:25Z'
          type: string
        value:
          description: Name of most recent type of prewet material spread, read from the material spreader.
          example: PWT1
          type: string
      required:
      - time
      - value
      type: object
    GrossVehicleWeight:
      description: The gross weight of the vehicle in either pounds (lb) or kilograms (kg). Only returned for customers with commercial speed limits (CSL) enabled.
      properties:
        unit:
          description: The unit of weight for the vehicle.
          enum:
          - lb
          - kg
          example: lb
          type: string
        weight:
          description: The weight value of the vehicle.
          example: 1000
          format: int64
          type: integer
      type: object
    VehicleHarshAccelerationSettingType:
      description: 'The harsh acceleration setting type. This setting influences the acceleration sensitivity from which a <a href="https://kb.samsara.com/hc/en-us/articles/360043051792-Safety-Event-Overview" target="_blank">harsh event</a> is triggered. **By default**, this setting is inferred by the Samsara Vehicle Gateway from the engine computer, but it may be set or updated through the Samsara Dashboard or the API at any time. If set to `off`, then no acceleration based harsh events are triggered for the vehicle. Valid values: `passengerCar`, `lightTruck`, `heavyDuty`, `off`, `automatic`.'
      enum:
      - passengerCar
      - lightTruck
      - heavyDuty
      - 'off'
      - automatic
      example: 'off'
      type: string
    VehicleStatsDecorations_barometricPressurePa:
      properties:
        value:
          $ref: '#/components/schemas/VehicleStatsBarometricPressurePaValue'
      required:
      - value
      type: object
    VehicleLocationLongitude:
      description: GPS longitude represented in degrees
      example: -93.343
      format: double
      type: number
    GoaPaginationResponseResponseBody:
      description: Pagination parameters.
      properties:
        endCursor:
          description: Cursor identifier representing the last element in the response. This value should be used in conjunction with a subsequent request's 'after' query parameter. This may be an empty string if there are no more pages left to view.
          example: MjkY
          type: string
        hasNextPage:
          description: True if there are more pages of results immediately available after this endCursor.
          example: true
          type: boolean
      required:
      - endCursor
      - hasNextPage
      type: object
    VehicleStatsObdEngineSeconds:
      description: Vehicle OBD engine seconds reading.
      properties:
        time:
          $ref: '#/components/schemas/time'
        value:
          description: Number of seconds the vehicle's engine has been on according to the on-board diagnostics.
          example: 9723103
          format: int64
          type: integer
      required:
      - time
      - value
      type: object
    UpdateVehicleRequest:
      description: All the editable portions of the vehicle object.
      properties:
        attributes:
          items:
            $ref: '#/components/schemas/attributeTiny'
          type: array
        auxInputType1:
          description: 'The type of <a href="https://kb.samsara.com/hc/en-us/articles/360043040512-Auxiliary-Inputs" target="_blank">auxiliary input</a> configured for this Vehicle. Once configured, these inputs will generate dynamic, time-series data that will be available to view in the Samsara Dashboard. **By default**: empty. This can be set or updated through the Samsara Dashboard or the API at any time. Inputs 3-13 are only available on gateways with an attached aux expander. Valid values: `None`, `Emergency Lights`, `Emergency Alarm`, `Stop Paddle`, `Power Take-Off`, `Plow`, `Sweeper`, `Salter`, `Reefer`, `Door`, `Boom`, `Auxiliary Engine`, `Generator`, `Eight-Way Lights`, `Panic Button`, `Privacy Button`, `Front Axle Drive`, `Weight Sensor`, `Other`, `Secondary Fuel Source`, `(ECU) Power Take-Off`.'
          enum:
          - none
          - emergencyLights
          - emergencyAlarm
          - stopPaddle
          - powerTakeOff
          - plow
          - sweeper
          - salter
          - reefer
          - door
          - boom
          - auxiliaryEngine
          - generator
          - eightWayLights
          - panicButton
          - privacyButton
          - frontAxleDrive
          - weightSensor
          - other
          - secondaryFuelSource
          - ecuPowerTakeOff
          example: boom
          type: string
        auxInputType10:
          description: 'The type of <a href="https://kb.samsara.com/hc/en-us/articles/360043040512-Auxiliary-Inputs" target="_blank">auxiliary input</a> configured for this Vehicle. Once configured, these inputs will generate dynamic, time-series data that will be available to view in the Samsara Dashboard. **By default**: empty. This can be set or updated through the Samsara Dashboard or the API at any time. Inputs 3-13 are only available on gateways with an attached aux expander. Valid values: `None`, `Emergency Lights`, `Emergency Alarm`, `Stop Paddle`, `Power Take-Off`, `Plow`, `Sweeper`, `Salter`, `Reefer`, `Door`, `Boom`, `Auxiliary Engine`, `Generator`, `Eight-Way Lights`, `Panic Button`, `Privacy Button`, `Front Axle Drive`, `Weight Sensor`, `Other`, `Secondary Fuel Source`, `(ECU) Power Take-Off`.'
          enum:
          - none
          - emergencyLights
          - emergencyAlarm
          - stopPaddle
          - powerTakeOff
          - plow
          - sweeper
          - salter
          - reefer
          - door
          - boom
          - auxiliaryEngine
          - generator
          - eightWayLights
          - panicButton
          - privacyButton
          - frontAxleDrive
          - weightSensor
          - other
          - secondaryFuelSource
          - ecuPowerTakeOff
          example: boom
          type: string
        auxInputType11:
          description: 'The type of <a href="https://kb.samsara.com/hc/en-us/articles/360043040512-Auxiliary-Inputs" target="_blank">auxiliary input</a> configured for this Vehicle. Once configured, these inputs will generate dynamic, time-series data that will be available to view in the Samsara Dashboard. **By default**: empty. This can be set or updated through the Samsara Dashboard or the API at any time. Inputs 3-13 are only available on gateways with an attached aux expander. Valid values: `None`, `Emergency Lights`, `Emergency Alarm`, `Stop Paddle`, `Power Take-Off`, `Plow`, `Sweeper`, `Salter`, `Reefer`, `Door`, `Boom`, `Auxiliary Engine`, `Generator`, `Eight-Way Lights`, `Panic Button`, `Privacy Button`, `Front Axle Drive`, `Weight Sensor`, `Other`, `Secondary Fuel Source`, `(ECU) Power Take-Off`.'
          enum:
          - none
          - emergencyLights
          - emergencyAlarm
          - stopPaddle
          - powerTakeOff
          - plow
          - sweeper
          - salter
          - reefer
          - door
          - boom
          - auxiliaryEngine
          - generator
          - eightWayLights
          - panicButton
          - privacyButton
          - frontAxleDrive
          - weightSensor
          - other
          - secondaryFuelSource
          - ecuPowerTakeOff
          example: boom
          type: string
        auxInputType12:
          description: 'The type of <a href="https://kb.samsara.com/hc/en-us/articles/360043040512-Auxiliary-Inputs" target="_blank">auxiliary input</a> configured for this Vehicle. Once configured, these inputs will generate dynamic, time-series data that will be available to view in the Samsara Dashboard. **By default**: empty. This can be set or updated through the Samsara Dashboard or the API at any time. Inputs 3-13 are only available on gateways with an attached aux expander. Valid values: `None`, `Emergency Lights`, `Emergency Alarm`, `Stop Paddle`, `Power Take-Off`, `Plow`, `Sweeper`, `Salter`, `Reefer`, `Door`, `Boom`, `Auxiliary Engine`, `Generator`, `Eight-Way Lights`, `Panic Button`, `Privacy Button`, `Front Axle Drive`, `Weight Sensor`, `Other`, `Secondary Fuel Source`, `(ECU) Power Take-Off`.'
          enum:
          - none
          - emergencyLights
          - emergencyAlarm
          - stopPaddle
          - powerTakeOff
          - plow
          - sweeper
          - salter
          - reefer
          - door
          - boom
          - auxiliaryEngine
          - generator
          - eightWayLights
          - panicButton
          - privacyButton
          - frontAxleDrive
          - weightSensor
          - other
          - secondaryFuelSource
          - ecuPowerTakeOff
          example: boom
          type: string
        auxInputType13:
          description: 'The type of <a href="https://kb.samsara.com/hc/en-us/articles/360043040512-Auxiliary-Inputs" target="_blank">auxiliary input</a> configured for this Vehicle. Once configured, these inputs will generate dynamic, time-series data that will be available to view in the Samsara Dashboard. **By default**: empty. This can be set or updated through the Samsara Dashboard or the API at any time. Inputs 3-13 are only available on gateways with an attached aux expander. Valid values: `None`, `Emergency Lights`, `Emergency Alarm`, `Stop Paddle`, `Power Take-Off`, `Plow`, `Sweeper`, `Salter`, `Reefer`, `Door`, `Boom`, `Auxiliary Engine`, `Generator`, `Eight-Way Lights`, `Panic Button`, `Privacy Button`, `Front Axle Drive`, `Weight Sensor`, `Other`, `Secondary Fuel Source`, `(ECU) Power Take-Off`.'
          enum:
          - none
          - emergencyLights
          - emergencyAlarm
          - stopPaddle
          - powerTakeOff
          - plow
          - sweeper
          - salter
          - reefer
          - door
          - boom
          - auxiliaryEngine
          - generator
          - eightWayLights
          - panicButton
          - privacyButton
          - frontAxleDrive
          - weightSensor
          - other
          - secondaryFuelSource
          - ecuPowerTakeOff
          example: boom
          type: string
        auxInputType2:
          description: 'The type of <a href="https://kb.samsara.com/hc/en-us/articles/360043040512-Auxiliary-Inputs" target="_blank">auxiliary input</a> configured for this Vehicle. Once configured, these inputs will generate dynamic, time-series data that will be available to view in the Samsara Dashboard. **By default**: empty. This can be set or updated through the Samsara Dashboard or the API at any time. Inputs 3-13 are only available on gateways with an attached aux expander. Valid values: `None`, `Emergency Lights`, `Emergency Alarm`, `Stop Paddle`, `Power Take-Off`, `Plow`, `Sweeper`, `Salter`, `Reefer`, `Door`, `Boom`, `Auxiliary Engine`, `Generator`, `Eight-Way Lights`, `Panic Button`, `Privacy Button`, `Front Axle Drive`, `Weight Sensor`, `Other`, `Secondary Fuel Source`, `(ECU) Power Take-Off`.'
          enum:
          - none
          - emergencyLights
          - emergencyAlarm
          - stopPaddle
          - powerTakeOff
          - plow
          - sweeper
          - salter
          - reefer
          - door
          - boom
          - auxiliaryEngine
          - generator
          - eightWayLights
          - panicButton
          - privacyButton
          - frontAxleDrive
          - weightSensor
          - other
          - secondaryFuelSource
          - ecuPowerTakeOff
          example: boom
          type: string
        auxInputType3:
          description: 'The type of <a href="https://kb.samsara.com/hc/en-us/articles/360043040512-Auxiliary-Inputs" target="_blank">auxiliary input</a> configured for this Vehicle. Once configured, these inputs will generate dynamic, time-series data that will be available to view in the Samsara Dashboard. **By default**: empty. This can be set or updated through the Samsara Dashboard or the API at any time. Inputs 3-13 are only available on gateways with an attached aux expander. Valid values: `None`, `Emergency Lights`, `Emergency Alarm`, `Stop Paddle`, `Power Take-Off`, `Plow`, `Sweeper`, `Salter`, `Reefer`, `Door`, `Boom`, `Auxiliary Engine`, `Generator`, `Eight-Way Lights`, `Panic Button`, `Privacy Button`, `Front Axle Drive`, `Weight Sensor`, `Other`, `Secondary Fuel Source`, `(ECU) Power Take-Off`.'
          enum:
          - none
          - emergencyLights
          - emergencyAlarm
          - stopPaddle
          - powerTakeOff
          - plow
          - sweeper
          - salter
          - reefer
          - door
          - boom
          - auxiliaryEngine
          - generator
          - eightWayLights
          - panicButton
          - privacyButton
          - frontAxleDrive
          - weightSensor
          - other
          - secondaryFuelSource
          - ecuPowerTakeOff
          example: boom
          type: string
        auxInputType4:
          description: 'The type of <a href="https://kb.samsara.com/hc/en-us/articles/360043040512-Auxiliary-Inputs" target="_blank">auxiliary input</a> configured for this Vehicle. Once configured, these inputs will generate dynamic, time-series data that will be available to view in the Samsara Dashboard. **By default**: empty. This can be set or updated through the Samsara Dashboard or the API at any time. Inputs 3-13 are only available on gateways with an attached aux expander. Valid values: `None`, `Emergency Lights`, `Emergency Alarm`, `Stop Paddle`, `Power Take-Off`, `Plow`, `Sweeper`, `Salter`, `Reefer`, `Door`, `Boom`, `Auxiliary Engine`, `Generator`, `Eight-Way Lights`, `Panic Button`, `Privacy Button`, `Front Axle Drive`, `Weight Sensor`, `Other`, `Secondary Fuel Source`, `(ECU) Power Take-Off`.'
          enum:
          - none
          - emergencyLights
          - emergencyAlarm
          - stopPaddle
          - powerTakeOff
          - plow
          - sweeper
          - salter
          - reefer
          - door
          - boom
          - auxiliaryEngine
          - generator
          - eightWayLights
          - panicButton
          - privacyButton
          - frontAxleDrive
          - weightSensor
          - other
          - secondaryFuelSource
          - ecuPowerTakeOff
          example: boom
          type: string
        auxInputType5:
          description: 'The type of <a href="https://kb.samsara.com/hc/en-us/articles/360043040512-Auxiliary-Inputs" target="_blank">auxiliary input</a> configured for this Vehicle. Once configured, these inputs will generate dynamic, time-series data that will be available to view in the Samsara Dashboard. **By default**: empty. This can be set or updated through the Samsara Dashboard or the API at any time. Inputs 3-13 are only available on gateways with an attached aux expander. Valid values: `None`, `Emergency Lights`, `Emergency Alarm`, `Stop Paddle`, `Power Take-Off`, `Plow`, `Sweeper`, `Salter`, `Reefer`, `Door`, `Boom`, `Auxiliary Engine`, `Generator`, `Eight-Way Lights`, `Panic Button`, `Privacy Button`, `Front Axle Drive`, `Weight Sensor`, `Other`, `Secondary Fuel Source`, `(ECU) Power Take-Off`.'
          enum:
          - none
          - emergencyLights
          - emergencyAlarm
          - stopPaddle
          - powerTakeOff
          - plow
          - sweeper
          - salter
          - reefer
          - door
          - boom
          - auxiliaryEngine
          - generator
          - eightWayLights
          - panicButton
          - privacyButton
          - frontAxleDrive
          - weightSensor
          - other
          - secondaryFuelSource
          - ecuPowerTakeOff
          example: boom
          type: string
        auxInputType6:
          description: 'The type of <a href="https://kb.samsara.com/hc/en-us/articles/360043040512-Auxiliary-Inputs" target="_blank">auxiliary input</a> configured for this Vehicle. Once configured, these inputs will generate dynamic, time-series data that will be available to view in the Samsara Dashboard. **By default**: empty. This can be set or updated through the Samsara Dashboard or the API at any time. Inputs 3-13 are only available on gateways with an attached aux expander. Valid values: `None`, `Emergency Lights`, `Emergency Alarm`, `Stop Paddle`, `Power Take-Off`, `Plow`, `Sweeper`, `Salter`, `Reefer`, `Door`, `Boom`, `Auxiliary Engine`, `Generator`, `Eight-Way Lights`, `Panic Button`, `Privacy Button`, `Front Axle Drive`, `Weight Sensor`, `Other`, `Secondary Fuel Source`, `(ECU) Power Take-Off`.'
          enum:
          - none
          - emergencyLights
          - emergencyAlarm
          - stopPaddle
          - powerTakeOff
          - plow
          - sweeper
          - salter
          - reefer
          - door
          - boom
          - auxiliaryEngine
          - generator
          - eightWayLights
          - panicButton
          - privacyButton
          - frontAxleDrive
          - weightSensor
          - other
          - secondaryFuelSource
          - ecuPowerTakeOff
          example: boom
          type: string
        auxInputType7:
          description: 'The type of <a href="https://kb.samsara.com/hc/en-us/articles/360043040512-Auxiliary-Inputs" target="_blank">auxiliary input</a> configured for this Vehicle. Once configured, these inputs will generate dynamic, time-series data that will be available to view in the Samsara Dashboard. **By default**: empty. This can be set or updated through the Samsara Dashboard or the API at any time. Inputs 3-13 are only available on gateways with an attached aux expander. Valid values: `None`, `Emergency Lights`, `Emergency Alarm`, `Stop Paddle`, `Power Take-Off`, `Plow`, `Sweeper`, `Salter`, `Reefer`, `Door`, `Boom`, `Auxiliary Engine`, `Generator`, `Eight-Way Lights`, `Panic Button`, `Privacy Button`, `Front Axle Drive`, `Weight Sensor`, `Other`, `Secondary Fuel Source`, `(ECU) Power Take-Off`.'
          enum:
          - none
          - emergencyLights
          - emergencyAlarm
          - stopPaddle
          - powerTakeOff
          - plow
          - sweeper
          - salter
          - reefer
          - door
          - boom
          - auxiliaryEngine
          - generator
          - eightWayLights
          - panicButton
          - privacyButton
          - frontAxleDrive
          - weightSensor
          - other
          - secondaryFuelSource
          - ecuPowerTakeOff
          example: boom
          type: string
        auxInputType8:
          description: 'The type of <a href="https://kb.samsara.com/hc/en-us/articles/360043040512-Auxiliary-Inputs" target="_blank">auxiliary input</a> configured for this Vehicle. Once configured, these inputs will generate dynamic, time-series data that will be available to view in the Samsara Dashboard. **By default**: empty. This can be set or updated through the Samsara Dashboard or the API at any time. Inputs 3-13 are only available on gateways with an attached aux expander. Valid values: `None`, `Emergency Lights`, `Emergency Alarm`, `Stop Paddle`, `Power Take-Off`, `Plow`, `Sweeper`, `Salter`, `Reefer`, `Door`, `Boom`, `Auxiliary Engine`, `Generator`, `Eight-Way Lights`, `Panic Button`, `Privacy Button`, `Front Axle Drive`, `Weight Sensor`, `Other`, `Secondary Fuel Source`, `(ECU) Power Take-Off`.'
          enum:
          - none
          - emergencyLights
          - emergencyAlarm
          - stopPaddle
          - powerTakeOff
          - plow
          - sweeper
          - salter
          - reefer
          - door
          - boom
          - auxiliaryEngine
          - generator
          - eightWayLights
          - panicButton
          - privacyButton
          - frontAxleDrive
          - weightSensor
          - other
          - secondaryFuelSource
          - ecuPowerTakeOff
          example: boom
          type: string
        auxInputType9:
          description: 'The type of <a href="https://kb.samsara.com/hc/en-us/articles/360043040512-Auxiliary-Inputs" target="_blank">auxiliary input</a> configured for this Vehicle. Once configured, these inputs will generate dynamic, time-series data that will be available to view in the Samsara Dashboard. **By default**: empty. This can be set or updated through the Samsara Dashboard or the API at any time. Inputs 3-13 are only available on gateways with an attached aux expander. Valid values: `None`, `Emergency Lights`, `Emergency Alarm`, `Stop Paddle`, `Power Take-Off`, `Plow`, `Sweeper`, `Salter`, `Reefer`, `Door`, `Boom`, `Auxiliary Engine`, `Generator`, `Eight-Way Lights`, `Panic Button`, `Privacy Button`, `Front Axle Drive`, `Weight Sensor`, `Other`, `Secondary Fuel Source`, `(ECU) Power Take-Off`.'
          enum:
          - none
          - emergencyLights
          - emergencyAlarm
          - stopPaddle
          - powerTakeOff
          - plow
          - sweeper
          - salter
          - reefer
          - door
          - boom
          - auxiliaryEngine
          - generator
          - eightWayLights
          - panicButton
          - privacyButton
          - frontAxleDrive
          - weightSensor
          - other
          - secondaryFuelSource
          - ecuPowerTakeOff
          example: boom
          type: string
        engineHours:
          description: A manual override for the vehicle's engine hours. You may only override a vehicle's engine hours if it cannot be read from on-board diagnostics. When you provide a manual engine hours override, Samsara will begin updating a vehicle's engine hours based on when the Samsara Vehicle Gateway is recieving power or not. Setting the value to 0 will unset the manual engine hours.
          example: 10943
          format: int64
          type: integer
        externalIds:
          additionalProperties:
            type: string
          description: The <a href="/docs/external-ids" target="_blank">external IDs</a> for the given object.
          example:
            maintenanceId: '250020'
            payrollId: ABFS18600
          type: object
        gatewaySerial:
          $ref: '#/components/schemas/UserIdentifierSerial'
        grossVehicleWeight:
          $ref: '#/components/schemas/GrossVehicleWeight'
        harshAccelerationSettingType:
          description: 'The harsh acceleration setting type. This setting influences the acceleration sensitivity from which a <a href="https://kb.samsara.com/hc/en-us/articles/360043051792-Safety-Event-Overview" target="_blank">harsh event</a> is triggered. **By default**, this setting is inferred by the Samsara Vehicle Gateway from the engine computer, but it may be set or updated through the Samsara Dashboard or the API at any time. If set to `off`, then no acceleration based harsh events are triggered for the vehicle. Valid values: `passengerCar`, `lightTruck`, `heavyDuty`, `off`, `automatic`.'
          enum:
          - passengerCar
          - lightTruck
          - heavyDuty
          - 'off'
          - automatic
          example: 'off'
          type: string
        licensePlate:
          description: 'The license plate of the Vehicle. **By default**: empty. Can be set or updated through the Samsara Dashboard or the API at any time.'
          example: XHK1234
          maxLength: 12
          type: string
        name:
          description: The human-readable name of the Vehicle. This is set by a fleet administrator and will appear in both Samsaras cloud dashboard as well as the Samsara Driver mobile app. **By default**, this name is the serial number of the Samsara Vehicle Gateway. It can be set or updated through the Samsara Dashboard or through the API at any time.
          example: Truck A7
          type: string
        notes:
          description: These are generic notes about the Vehicle. Empty by default. Can be set or updated through the Samsara Dashboard or the API at any time.
          example: These are notes about this given vehicle.
          maxLength: 255
          type: string
        odometerMeters:
          description: A manual override for the vehicle's odometer. You may only override a vehicle's odometer if it cannot be read from on-board diagnostics. When you provide a manual odometer override, Samsara will begin updating a vehicle's odometer using GPS distance traveled since this override was set. See <a href="https://kb.samsara.com/hc/en-us/articles/115005273667" target="_blank">here</a> for more details.
          example: 9182
          format: int64
          type: integer
        staticAssignedDriverId:
          description: ID for the static assigned driver of the vehicle. Setting the value to 0 will unassign the current driver.
          example: '123'
          type: string
        tagIds:
          description: An array of IDs of tags to associate with this vehicle. If your access to the API is scoped by one or more tags, this field is required to pass in.
          items:
            example: '321'
            type: string
          type: array
        vehicleRegulationMode:
          $ref: '#/components/schemas/VehicleRegulationMode'
        vehicleType:
          $ref: '#/components/schemas/VehicleType'
        vin:
          description: The VIN of the Vehicle. Most of the time, this will be automatically read from the engine computer by the Samsara Vehicle Gateway. It will be empty if it cannot be read. It can be set or updated through the Samsara Dashboard or the API at any time.
          example: 1FUJA6BD31LJ09646
          maxLength: 17
          minLength: 11
          type: string
      type: object
    VehicleResponse:
      description: A single vehicle.
      properties:
        data:
          $ref: '#/components/schemas/Vehicle'
      required:
      - data
      type: object
    tagTinyResponse:
      description: A minified tag object
      properties:
        id:
          description: ID of the tag.
          example: '3914'
          type: string
        name:
          description: Name of the tag.
          example: East Coast
          type: string
        parentTagId:
          description: If this tag is part a hierarchical tag tree, this is the ID of the parent tag, otherwise this will be omitted.
          example: '4815'
          type: string
      type: object
    VehicleStatsDecorations_defLevelMilliPercent:
      properties:
        value:
          $ref: '#/components/schemas/VehicleStatsDefLevelMilliPercentValue'
      required:
      - value
      type: object
    DriverEfficiencyGetDriverEfficiencyByVehiclesNotFoundErrorResponseBody:
      description: Resource not found
      properties:
        message:
          description: Message of error
          example: Object not found.
          type: string
        requestId:
          description: The request ID; used when reaching out to support for issues with requests.
          example: 8916e1c1
          type: string
      required:
      - message
      - requestId
      type: object
    VehiclesDriverAssignmentsGetVehiclesDriverAssignmentsBadRequestErrorResponseBody:
      description: Bad Request parameters
      properties:
        message:
          description: Message of error
          example: Invalid value for parameter.
          type: string
        requestId:
          description: The request ID; used when reaching out to support for issues with requests.
          example: 8916e1c1
          type: string
      required:
      - message
      - requestId
      type: object
    VehicleStatsFaultCodesIgnitionType:
      description: 'The ignition type of this passenger vehicle. Valid values: `spark`, `compression`.'
      enum:
      - spark
      - compression
      type: string
    VehicleLocation:
      description: Vehicle location event.
      properties:
        heading:
          $ref: '#/components/schemas/VehicleLocationHeading'
        latitude:
          $ref: '#/components/schemas/VehicleLocationLatitude'
        longitude:
          $ref: '#/components/schemas/VehicleLocationLongitude'
        reverseGeo:
          $ref: '#/components/schemas/reverseGeo'
        speed:
          $ref: '#/components/schemas/VehicleLocationSpeed'
        time:
          $ref: '#/components/schemas/time'
      required:
      - latitude
      - longitude
      - time
      type: object
    VehicleStatsResponse_spreaderOnState:
      description: Whether vehicle spreader is enabled.
      properties:
        time:
          description: 'UTC timestamp in RFC 3339 format. Example: `2020-01-27T07:06:25Z`.'
          example: '2020-01-27T07:06:25Z'
          type: string
        value:
          description: Whether vehicle spreader is enabled.
          enum:
          - 'On'
          - 'Off'
          example: 'On'
          type: string
      required:
      - time
      - value
      type: object
    VehicleStatsEvChargingCurrentMilliAmp:
      description: Charging current for electric and hybrid vehicles in milli amps. Not all EV and HEVs may report this field.
      properties:
        time:
          $ref: '#/components/schemas/time'
        value:
          description: Charging current for electric and hybrid vehicles in milli amps.
          example: 1000
          format: int64
          type: integer
      required:
      - time
      - value
      type: object
    EngineImmobilizerGetEngineImmobilizerStatesUnauthorizedErrorResponseBody:
      description: Unauthorized
      properties:
        message:
          description: Message of error
          example: Invalid token.
          type: string
        requestId:
          description: The request ID; used when reaching out to support for issues with requests.
          example: 8916e1c1
          type: string
      required:
      - message
      - requestId
      type: object
    vehicleSensorConfigurationResponseBody:
      description: The sensors configured on a vehicle
      properties:
        areas:
          description: Configured sensor areas on the vehicle with its associated sensors
          items:
            $ref: '#/components/schemas/vehicleSensorConfigurationAreaResponseBody'
          type: array
        doors:
          description: Configured door monitors on the vehicle
          items:
            $ref: '#/components/schemas/vehicleSensorConfigurationDoorResponseBody'
          type: array
      type: object
    VehicleStatsListSyntheticEngineSeconds:
      description: A list of synthetic engine seconds for the vehicle.
      properties:
        decorations:
          $ref: '#/components/schemas/VehicleStatsDecorations'
        time:
          $ref: '#/components/schemas/vehicleStatsAuxInputTime'
        value:
          $ref: '#/components/schemas/VehicleStatsSyntheticEngineSecondsValue'
      required:
      - time
      - value
      type: object
    VehicleStatsEvChargingEnergyMicroWh:
      description: Charging energy for electric and hybrid vehicles in microwatt hours. Not all EV and HEVs may report this field.
      properties:
        time:
          $ref: '#/components/schemas/time'
        value:
          description: Charging energy for electric and hybrid vehicles in microwatt hours.
          example: 1000
          format: int64
          type: integer
      required:
      - time
      - value
      type: object
    vehicleSensorConfigurationDoorResponseBody:
      description: A door monitor configuration on a vehicle
      properties:
        position:
          description: 'Position of the door monitor on the vehicle  Valid values: `back`, `left`, `right`'
          enum:
          - back
          - left
          - right
          example: back
          type: string
        sensor:
          $ref: '#/components/schemas/sensorResponseBody'
      required:
      - position
      - sensor
      type: object
    GoaGatewayTinyResponseResponseBody:
      description: A minified gateway object
      properties:
        model:
          description: 'The model of the gateway installed on the asset.  Valid values: `AG15`, `AG24`, `AG24EU`, `AG26`, `AG26EU`, `AG41`, `AG41EU`, `AG45`, `AG45EU`, `AG46`, `AG46EU`, `AG46P`, `AG46PEU`, `AG51`, `AG51EU`, `AG52`, `AG52EU`, `AG53`, `AG53EU`, `IG15`, `IG21`, `IG41`, `IG61`, `SG1`, `SG1B`, `SG1G`, `SG1G32`, `SG1x`, `VG32`, `VG33`, `VG34`, `VG34EU`, `VG34FN`, `VG34M`, `VG54ATT`, `VG54EU`, `VG54FN`, `VG54NA`, `VG54NAE`, `VG54NAH`, `VG55EU`, `VG55FN`, `VG55NA`'
          enum:
          - AG15
          - AG24
          - AG24EU
          - AG26
          - AG26EU
          - AG41
          - AG41EU
          - AG45
          - AG45EU
          - AG46
          - AG46EU
          - AG46P
          - AG46PEU
          - AG51
          - AG51EU
          - AG52
          - AG52EU
          - AG53
          - AG53EU
          - IG15
          - IG21
          - IG41
          - IG61
          - SG1
          - SG1B
          - SG1G
          - SG1G32
          - SG1x
          - VG32
          - VG33
          - VG34
          - VG34EU
          - VG34FN
          - VG34M
          - VG54ATT
          - VG54EU
          - VG54FN
          - VG54NA
          - VG54NAE
          - VG54NAH
          - VG55EU
          - VG55FN
          - VG55NA
          example: VG34
          type: string
        serial:
          description: The serial number of the gateway installed on the asset.
          example: GFRV-43N-VGX
          type: string
      required:
      - model
      - serial
      type: object
    DriverEfficiencyPercentageDataObjectResponseBody:
      description: Driver Efficiency percentage data. This object is returned when the percentage format is specified in dataFormats.
      properties:
        anticipationPercentage:
          description: Percentage of time a driver is in quickly breaking events vs total breaking events.
          example: 9.5
          format: double
          type: number
        coastingPercentage:
          description: Percentage of time a driver is in coasting.
          example: 45.6
          format: double
          type: number
        cruiseControlPercentage:
          description: Percentage of time a vehicle is in cruise control.
          example: 45.6
          format: double
          type: number
        greenBandPercentage:
          description: Percentage of time a driver is driving within the green band.
          example: 78.9
          format: double
          type: number
        highGradeRoadDrivingPercentage:
          description: Percentage of time a driver is driving on high-grade road.
          example: 15.3
          format: double
          type: number
        highTorquePercentage:
          description: Percentage of time a driver is driving in high torque.
          example: 23.4
          format: double
          type: number
        idlingPercentage:
          description: Percentage of time a driver is idling.
          example: 12.8
          format: double
          type: number
        overSpeedPercentage:
          description: Percentage of time a driver is in over-speeding.
          example: 5.6
          format: double
          type: number
        wearFreeBrakePercentage:
          description: Percentage of time a driver is in wear-free breaking.
          example: 88.2
          format: double
          type: number
      required:
      - idlingPercentage
      type: object
    VehicleTags:
      description: 'The list of <a href="https://kb.samsara.com/hc/en-us/articles/360043275091-Creating-and-Using-Tags" target="_blank">tags</a> associated with the Vehicle. **By default**: empty. Can be set or updated through the Samsara Dashboard or the API at any time.'
      items:
        $ref: '#/components/schemas/tagTinyResponse'
      type: array
    VehicleStatsGpsOdometerMeters:
      description: Vehicle GPS odometer event.
      properties:
        time:
          $ref: '#/components/schemas/time'
        value:
          description: Number of meters the vehicle has traveled according to the GPS calculations and the manually-specified odometer reading.
          example: 14010293
          format: int64
          type: integer
      required:
      - time
      - value
      type: object
    VehicleStatsResponse:
      description: Vehicle stats snapshot and pagination info.
      properties:
        data:
          description: List of vehicles and a snapshot of the request stats.
          items:
            $ref: '#/components/schemas/VehicleStatsResponse_data'
          type: array
        pagination:
          $ref: '#/components/schemas/paginationResponse'
      required:
      - data
      - pagination
      type: object
    VehicleStatsFaultCodesOBDII:
      description: Vehicle fault codes for passenger vehicles.
      properties:
        checkEngineLightIsOn:
          description: True if the check engine light is illuminated (MIL status field is nonzero for any faults).
          example: true
          type: boolean
        diagnosticTroubleCodes:
          description: Diagnostic trouble codes for passenger vehicles.
          items:
            $ref: '#/components/schemas/VehicleStatsFaultCodesOBDIITroubleCode'
          type: array
      type: object
    VehiclesListVehiclesTooManyRequestsErrorResponseBody:
      description: Too many requests
      properties:
        message:
          description: Message of error
          example: Exceeded rate limit.
          type: string
        requestId:
          description: The request ID; used when reaching out to support for issues with requests.
          example: 8916e1c1
          type: string
      required:
      - message
      - requestId
      type: object
    VehicleStatsGps:
      description: GPS location data for the vehicle.
      properties:
        address:
          $ref: '#/components/schemas/VehicleLocationAddress'
        headingDegrees:
          $ref: '#/components/schemas/VehicleLocationHeading'
        isEcuSpeed:
          $ref: '#/components/schemas/VehicleLocationIsEcuSpeed'
        latitude:
          $ref: '#/components/schemas/VehicleLocationLatitude'
        longitude:
          $ref: '#/components/schemas/VehicleLocationLongitude'
        reverseGeo:
          $ref: '#/components/schemas/reverseGeo'
        speedMilesPerHour:
          $ref: '#/components/schemas/VehicleLocationSpeed'
        time:
          $ref: '#/components/schemas/time'
      required:
      - latitude
      - longitude
      - time
      type: object
    VehicleStatsEvBatteryStateOfHealthMilliPercent:
      description: Milli percent battery state of health for electric and hybrid vehicles. Not all EV and HEVs may report this field.
      properties:
        time:
          $ref: '#/components/schemas/time'
        value:
          description: Milli percent battery state of health for electric and hybrid vehicles.
          example: 1000
          format: int64
          type: integer
      required:
      - time
      - value
      type: object
    VehicleStatsDecorations_gpsOdometerMeters:
      properties:
        value:
          $ref: '#/components/schemas/VehicleStatsGpsOdometerMetersValue'
      required:
      - value
      type: object
    VehicleStatsSyntheticEngineSeconds:
      description: Data for the synthetic engine seconds for the vehicle
      properties:
        decorations:
          $ref: '#/components/schemas/VehicleStatsDecorations'
        time:
          $ref: '#/components/schemas/vehicleStatsAuxInputTime'
        value:
          $ref: '#/components/schemas/VehicleStatsSyntheticEngineSecondsValue'
      required:
      - time
      - value
      type: object
    VehicleLocationHeading:
      description: Heading of the vehicle in degrees.
      example: 120
      format: double
      type: number
    VehicleStatsFaultCodesJ1939Lights:
      description: Status of engine lights on J1939 vehicles.
      properties:
        emissionsIsOn:
          description: True if the MIL status is nonzero.
          example: true
          type: boolean
        protectIsOn:
          description: True if the engine protect lamp status is nonzero.
          example: false
          type: boolean
        stopIsOn:
          description: True if the red lamp status is nonzero.
          example: false
          type: boolean
        warningIsOn:
          description: True if the amber lamp status is nonzero.
          example: false
          type: boolean
      required:
      - emissionsIsOn
      - protectIsOn
      - stopIsOn
      - warningIsOn
      type: object
    VehicleStatsResponse_spreaderLiquidName:
      description: Name of most recent type of liquid material spread, read from the material spreader.
      properties:
        time:
          description: 'UTC timestamp in RFC 3339 format. Example: `2020-01-27T07:06:25Z`.'
          example: '2020-01-27T07:06:25Z'
          type: string
        value:
          description: Name of most recent type of liquid material spread, read from the material spreader.
          example: DIR1
          type: string
      required:
      - time
      - value
      type: object
    reverseGeo:
      description: Reverse geocoded information.
      properties:
        formattedLocation:
          description: Formatted address of the reverse geocoding data.
          example: 16 N Fair Oaks Ave, Pasadena, CA 91103
          type: string
      type: object
    VehicleStatsBarometricPressurePaWithDecoration:
      description: Vehicle barometric pressure reading.
      properties:
        decorations:
          $ref: '#/components/schemas/VehicleStatsDecorations'
        time:
          $ref: '#/components/schemas/time'
        value:
          description: The barometric pressure reading in pascals.
          example: 100
          format: int64
          type: integer
      required:
      - time
      - value
      type: object
    VehicleStatsFaultCodesValue_oem:
      description: Vehicle fault codes for OEM vehicles.
      properties:
        diagnosticTroubleCodes:
          description: Proprietary diagnostic trouble codes for OEM vehicles.
          items:
            $ref: '#/components/schemas/VehicleStatsFaultCodesValue_oem_diagnosticTroubleCodes'
          type: array
      type: object
    VehicleStatsFaultCodesPassengerMonitorStatusValue:
      description: 'Enum of monitor status:

        -U: Unsupported

        -N: Not Complete

        -R: Complete

        '
      enum:
      - N
      - R
      - U
      type: string
    VehicleStatsFaultCodesCanBusType:
      description: The CAN bus type of the vehicle.
      example: CANBUS_J1939_500
      type: string
    VehicleStatsDecorations_fuelPercents:
      properties:
        value:
          $ref: '#/components/schemas/VehicleStatsFuelPercentValue'
      required:
      - value
      type: object
    EngineImmobilizerGetEngineImmobilizerStatesServiceUnavailableErrorResponseBody:
      description: Service unavailable
      properties:
        message:
          description: Message of error
          example: context deadline exceeded
          type: string
        requestId:
          description: The request ID; used when reaching out to support for issues with requests.
          example: 8916e1c1
          type: string
      required:
      - message
      - requestId
      type: object
    VehiclesListVehiclesMethodNotAllowedErrorResponseBody:
      description: Method not allowed
      properties:
        message:
          description: Message of error
          example: DELETE not allowed on /endpoint.
          type: string
        requestId:
          description: The request ID; used when reaching out to support for issues with requests.
          example: 8916e1c1
          type: string
      required:
      - message
      - requestId
      type: object
    VehicleStatsAuxInput:
      description: Data for auxiliary digio equipment.
      properties:
        name:
          $ref: '#/components/schemas/VehicleAuxInputName'
        time:
          $ref: '#/components/schemas/vehicleStatsAuxInputTime'
        value:
          description: Boolean indicating the state of the auxiliary equipment.
          example: true
          type: boolean
      type: object
    sensorResponseBody:
      description: A sensor
      properties:
        id:
          description: ID of the sensor
          example: '12345'
          type: string
        mac:
          description: The MAC address of the sensor
          example: 00:00:5e:00:53:af
          type: string
        name:
          description: The name of the sensor
          example: Rear temperature sensor
          type: string
      required:
      - id
      - mac
      - name
      type: object
    attributeTiny:
      description: A minified attribute.
      properties:
        id:
          description: The samsara id of the attribute object.
          example: 123e4567-e89b-12d3-a456-426614174000
          type: string
        name:
          description: Name of attribute.
          example: License Certifications
          type: string
        numberValues:
          description: Number values that are associated with this attribute.
          items:
            format: double
            type: number
          type: array
        stringValues:
          description: String values that are associated with this attribute.
          items:
            type: string
          type: array
      type: object
    VehicleAuxInputType:
      description: 'The type of <a href="https://kb.samsara.com/hc/en-us/articles/360043040512-Auxiliary-Inputs" target="_blank">auxiliary input</a> configured for this Vehicle. Once configured, these inputs will generate dynamic, time-series data that will be available to view in the Samsara Dashboard. **By default**: empty. This can be set or updated through the Samsara Dashboard or the API at any time. Inputs 3-13 are only available on gateways with an attached aux expander. The value returned will match what is configured in the dashboard per vehicle.'
      example: boom
      type: string
    Vehicle:
      description: The vehicle object.
      properties:
        attributes:
          description: A minified attribute
          items:
            $ref: '#/components/schemas/attributeTiny'
          type: array
        auxInputType1:
          $ref: '#/components/schemas/VehicleAuxInputType'
        auxInputType10:
          $ref: '#/components/schemas/VehicleAuxInputType'
        auxInputType11:
          $ref: '#/components/schemas/VehicleAuxInputType'
        auxInputType12:
          $ref: '#/components/schemas/VehicleAuxInputType'
        auxInputType13:
          $ref: '#/components/schemas/VehicleAuxInputType'
        auxInputType2:
          $ref: '#/components/schemas/VehicleAuxInputType'
        auxInputType3:
          $ref: '#/components/schemas/VehicleAuxInputType'
        auxInputType4:
          $ref: '#/components/schemas/VehicleAuxInputType'
        auxInputType5:
          $ref: '#/components/schemas/VehicleAuxInputType'
        auxInputType6:
          $ref: '#/components/schemas/VehicleAuxInputType'
        auxInputType7:
          $ref: '#/components/schemas/VehicleAuxInputType'
        auxInputType8:
          $ref: '#/components/schemas/VehicleAuxInputType'
        auxInputType9:
          $ref: '#/components/schemas/VehicleAuxInputType'
        cameraSerial:
          $ref: '#/components/schemas/CameraSerial'
        esn:
          $ref: '#/components/schemas/VehicleEsn'
        externalIds:
          $ref: '#/components/schemas/VehicleExternalIds'
        gateway:
          $ref: '#/components/schemas/gatewayTiny'
        grossVehicleWeight:
          $ref: '#/components/schemas/GrossVehicleWeight'
        harshAccelerationSettingType:
          $ref: '#/components/schemas/VehicleHarshAccelerationSettingType'
        id:
          $ref: '#/components/schemas/VehicleId'
        licensePlate:
          $ref: '#/components/schemas/VehicleLicensePlate'
        make:
          $ref: '#/components/schemas/VehicleMake'
        model:
          $ref: '#/components/schemas/VehicleModel'
        name:
          $ref: '#/components/schemas/VehicleName'
        notes:
          $ref: '#/components/schemas/VehicleNotes'
        sensorConfiguration:
          $ref: '#/components/schemas/VehicleSensorConfiguration'
        serial:
          $ref: '#/components/schemas/Serial'
        staticAssignedDriver:
          $ref: '#/components/schemas/driverTinyResponse'
        tags:
          $ref: '#/components/schemas/VehicleTags'
        vehicleRegulationMode:
          $ref: '#/components/schemas/VehicleRegulationMode'
        vehicleType:
          $ref: '#/components/schemas/VehicleType'
        vin:
          $ref: '#/components/schemas/VehicleVin'
        year:
          $ref: '#/components/schemas/VehicleYear'
      required:
      - id
      type: object
    VehicleStatsResponse_evChargingCurrentMilliAmp:
      description: Charging current for electric and hybrid vehicles in milli amps. Not all EV and HEVs may report this field.
      properties:
        time:
          description: 'UTC timestamp in RFC 3339 format. Example: `2020-01-27T07:06:25Z`.'
          example: '2020-01-27T07:06:25Z'
          type: string
        value:
          description: Charging current for electric and hybrid vehicles in milli amps.
          example: 1000
          format: int64
          type: integer
      required:
      - time
      - value
      type: object
    VehicleStatsAuxInputDecoration:
      properties:
        name:
          description: 'The type of <a href="https://kb.samsara.com/hc/en-us/articles/360043040512-Auxiliary-Inputs" target="_blank">auxiliary input</a> configured for this Vehicle. Once configured, these inputs will generate dynamic, time-series data that will be available to view in the Samsara Dashboard. **By default**: empty. This can be set or updated through the Samsara Dashboard or the API at any time. Inputs 3-13 are only available on gateways with an attached aux expander. The value returned will match what is configured in the dashboard per vehicle.'
          example: Boom
          type: string
        value:
          $ref: '#/components/schemas/VehicleStatsAuxInputValue'
      required:
      - name
      - value
      type: object
    VehicleStatsEcuSpeedMphWithDecoration:
      description: The speed of the vehicle in miles per hour, as reported by the ECU.
      properties:
        decorations:
          $ref: '#/components/schemas/VehicleStatsDecorations'
        time:
          $ref: '#/components/schemas/time'
        value:
          description: The speed of the vehicle in miles per hour.
          example: 32.1
          format: double
          type: number
      required:
      - time
      - value
      type: object
    VehicleStatsEngineRpm:
      description: Vehicle engine RPM reading.
      properties:
        time:
          $ref: '#/components/schemas/time'
        value:
          description: The revolutions per minute of the engine.
          example: 1000
          format: int64
          type: integer
      required:
      - time
      - value
      type: object
    VehicleStatsSpreaderAirTemp:
      description: Air (ambient) temperature in milli celsius reading from material spreader.
      properties:
        time:
          $ref: '#/components/schemas/time'
        value:
          description: Air (ambient) temperature in milli celsius reading from material spreader.
          example: 1000
          format: int64
          type: integer
      required:
      - time
      - value
      type: object
    VehicleExternalIds:
      description: The <a href="/docs/external-ids" target="_blank">external IDs</a> for the given object.
      example:
        maintenanceId: '250020'
        payrollId: ABFS18600
      type: object
    EngineImmobilizerGetEngineImmobilizerStatesGatewayTimeoutErrorResponseBody:
      description: Gateway timeout
      properties:
        message:
          description: Message of error
          example: context deadline exceeded
          type: string
        requestId:
          description: The request ID; used when reaching out to support for issues with requests.
          example: 8916e1c1
          type: string
      required:
      - message
      - requestId
      type: object
    VehicleStatsEvBatteryCurrentMilliAmp:
      description: Battery current for electric and hybrid vehicles in milli amps. Not all EV and HEVs may report this field.
      properties:
        time:
          $ref: '#/components/schemas/time'
        value:
          description: Battery current for electric and hybrid vehicles in milli amps.
          example: 1000
          format: int64
          type: integer
      required:
      - time
      - value
      type: object
    VehiclesListVehiclesGatewayTimeoutErrorResponseBody:
      description: Gateway timeout
      properties:
        message:
          description: Message of error
          example: context deadline exceeded
          type: string
        requestId:
          description: The request ID; used when reaching out to support for issues with requests.
          example: 8916e1c1
          type: string
      required:
      - message
      - requestId
      type: object
    EngineImmobilizerStateResponseBody:
      description: An engine immobilizer state.
      properties:
        happenedAtTime:
          description: 'A UTC 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).'
          example: '2019-06-13T19:08:25Z'
          type: string
        isConnectedToVehicle:
          description: Whether the engine immobilizer is connected the vehicle.
          example: false
          type: boolean
        relayStates:
          description: A list of states for each relay
          items:
            $ref: '#/components/schemas/EngineImmobilizerRelayStateResponseBody'
          type: array
        vehicleId:
          description: The ID of the vehicle that the engine immobilizer is connected to.
          example: '1234'
          type: string
      required:
      - happenedAtTime
      - isConnectedToVehicle
      - relayStates
      - vehicleId
      type: object
    VehicleStatsBarometricPressurePa:
      description: Vehicle barometric pressure reading.
      properties:
        time:
          $ref: '#/components/schemas/time'
        value:
          description: The barometric pressure reading in pascals.
          example: 99000
          format: int64
          type: integer
      required:
      - time
      - value
      type: object
    VehicleStatsResponse_evRegeneratedEnergyMicroWh:
      description: Regenerated energy for electric and hybrid vehicles in microwatt hours. Not all EV and HEVs may report this field.
      properties:
        time:
          description: 'UTC timestamp in RFC 3339 format. Example: `2020-01-27T07:06:25Z`.'
          example: '2020-01-27T07:06:25Z'
          type: string
        value:
          description: Regenerated energy for electric and hybrid vehicles in microwatt hours.
          example: 1000
          format: int64
          type: integer
      required:
      - time
      - value
      type: object
    VehicleStatsFaultCodesValue_obdii_confirmedDtcs:
      description: Passenger vehicle DTC information
      properties:
        dtcDescription:
          description: The DTC description, if available.
          example: Fuel Rail/System Pressure - Too Low Bank 1
          type: string
        dtcId:
          description: The DTC identifier.
          example: 135
          format: int32
          type: integer
        dtcShortCode:
          description: The DTC short code, if available.
          example: P0087
          type: string
      required:
      - dtcId
      type: object
    VehicleStatsFaultCodesOBDIITroubleCode:
      description: Diagnostic trouble code for passenger vehicles.
      properties:
        confirmedDtcs:
          description: Confirmed DTC codes.
          items:
            $ref: '#/components/schemas/VehicleStatsFaultCodesPassengerDtc'
          type: array
        ignitionType:
          $ref: '#/components/schemas/VehicleStatsFaultCodesIgnitionType'
        milStatus:
          description: The MIL status, indicating a check engine light.
          example: true
          type: boolean
        monitorStatus:
          $ref: '#/components/schemas/VehicleStatsFaultCodesPassengerMonitorStatus'
        pendingDtcs:
          description: Pending DTC codes.
          items:
            $ref: '#/components/schemas/VehicleStatsFaultCodesPassengerDtc'
          type: array
        permanentDtcs:
          description: Permanent DTC codes.
          items:
            $ref: '#/components/schemas/VehicleStatsFaultCodesPassengerDtc'
          type: array
        txId:
          $ref: '#/components/schemas/VehicleStatsFaultCodesTxId'
      required:
      - txId
      type: object
    DriverAssignmentObjectResponseBody:
      properties:
        assignmentType:
          description: 'Assignment type of the driver-vehicle assignment, indicating the provenance of the assignment. The only type of assignment supported right now is `driverApp` assignments. This list could change, so it is recommended that clients gracefully handle any types not enumerated in this list.  Valid values: `driverApp`'
          enum:
          - driverApp
          example: driverApp
          type: string
        driver:
          $ref: '#/components/schemas/GoaDriverTinyResponseResponseBody'
        endTime:
          description: ' An end time in RFC 3339 format. Omitted if not applicable. 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).'
          example: '2019-06-13T19:08:25Z'
          type: string
        isPassenger:
          description: Boolean indicating whether the driver is a passenger.
          example: false
          type: boolean
        startTime:
          description: ' A start time in RFC 3339 format. Defaults to now if not provided. 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).'
          example: '2019-06-13T19:08:25Z'
          type: string
      type: object
    VehicleStatsResponse_evBatteryStateOfHealthMilliPercent:
      description: Milli percent battery state of health for electric and hybrid vehicles. Not all EV and HEVs may report this field.
      properties:
        time:
          description: 'UTC timestamp in RFC 3339 format. Example: `2020-01-27T07:06:25Z`.'
          example: '2020-01-27T07:06:25Z'
          type: string
        value:
          description: Milli percent battery state of health for electric and hybrid vehicles.
          example: 1000
          format: int64
          type: integer
      required:
      - time
      - value
      type: object
    VehicleStatsAmbientAirTempMilliCValue:
      description: The ambient air temperature reading in millidegree Celsius.
      example: 31110
      format: int64
      type: integer
    V1VehicleHarshEventResponse_location:
      properties:
        address:
          description: Address of location where the harsh event occurred
          example: 350 Rhode Island St, San Francisco, CA
          type: string
        latitude:
          description: Latitude of location where the harsh event occurred
          example: 33.07614328
          type: number
        longitude:
          description: Longitude of location where the harsh event occurred
          example: -96.14907287
          type: number
      type: object
    VehicleStatsResponse_evStateOfChargeMilliPercent:
      description: State of Charge for electric and hybrid vehicles. Not all EV and HEVs may report this field.
      properties:
        time:
          description: 'UTC timestamp in RFC 3339 format. Example: `2020-01-27T07:06:25Z`.'
          example: '2020-01-27T07:06:25Z'
          type: string
        value:
          description: Milli percent State of Charge for electric and hybrid vehicles.
          example: 1000
          format: int64
          type: integer
      required:
      - time
      - value
      type: object
    VehiclesDriverAssignmentsGetVehiclesDriverAssignmentsBadGatewayErrorResponseBody:
      description: Bad Gateway
      properties:
        message:
          description: Message of error
          example: 'rpc error: code = Unknown desc = connection refused'
          type: string
        requestId:
          description: The request ID; used when reaching out to support for issues with requests.
          example: 8916e1c1
          type: string
      required:
      - message
      - requestId
      type: object
    VehicleStatsFaultCodesOem:
      description: Vehicle fault codes for OEM vehicles.
      properties:
        diagnosticTroubleCodes:
          $ref: '#/components/schemas/VehicleStatsFaultCodesOemTroubleCodes'
      type: object
    VehicleStatsResponse_spreaderAirTemp:
      description: Air (ambient) temperature in milli celsius reading from material spreader.
      properties:
        time:
          description: 'UTC timestamp in RFC 3339 format. Example: `2020-01-27T07:06:25Z`.'
          example: '2020-01-27T07:06:25Z'
          type: string
        value:
          description: Air (ambient) temperature in milli celsius reading from material spreader.
          example: 1000
          format: int64
          type: integer
      required:
      - time
      - value
      type: object
    VehicleStatsFaultCodes:
      description: Engine fault codes read from J1939, OBDII, and OEM vehicles.
      properties:
        canBusType:
          $ref: '#/components/schemas/VehicleStatsFaultCodesCanBusType'
        j1939:
          $ref: '#/components/schemas/VehicleStatsFaultCodesJ1939'
        obdii:
          $ref: '#/components/schemas/VehicleStatsFaultCodesOBDII'
        oem:
          $ref: '#/components/schemas/VehicleStatsFaultCodesOem'
        time:
          $ref: '#/components/schemas/vehicleStatsAuxInputTime'
      required:
      - time
      type: object
    VehicleStatsSpreaderRoadTemp:
      description: Road temperature reading in milli celsius from material spreader.
      properties:
        time:
          $ref: '#/components/schemas/time'
        value:
          description: Road temperature reading in milli celsius from material spreader.
          example: 1000
          format: int64
          type: integer
      required:
      - time
      - value
      type: object
    VehicleStatsAuxInputWithDecoration:
      description: Data for auxiliary digio equipment.
      properties:
        decorations:
          $ref: '#/components/schemas/VehicleStatsDecorations'
        name:
          $ref: '#/components/schemas/VehicleAuxInputName'
        time:
          $ref: '#/components/schemas/vehicleStatsAuxInputTime'
        value:
          description: Boolean indicating the state of the auxiliary equipment.
          example: true
          type: boolean
      type: object
    VehicleStatsEngineStateSetting:
      description: The state of the engine.
      enum:
      - 'Off'
      - 'On'
      - Idle
      example: 'On'
      type: string
    GoaTagTinyResponseResponseBody:
      description: A minified tag object
      properties:
        id:
          description: ID of the tag
          example: '3914'
          type: string
        name:
          description: Name of the tag.
          example: East Coast
          type: string
        parentTagId:
          description: If this tag is part a hierarchical tag tree, this is the ID of the parent tag, otherwise this will be omitted.
          example: '4815'
          type: string
      required:
      - id
      - name
      type: object
    vehicleTinyResponse:
      description: A minified vehicle object.
      properties:
        ExternalIds:
          additionalProperties:
            type: string
          description: The [external IDs](https://developers.samsara.com/docs/external-ids) for the given object.
          example:
            maintenanceId: '250020'
            payrollId: ABFS18600
          type: object
        id:
          description: ID of the vehicle.
          example: '123456789'
          type: string
        name:
          description: Name of the vehicle.
          example: 'Midwest Truck #4'
          type: string
      type: object
    VehicleStatsDecorations_intakeManifoldTemperatureMilliC:
      properties:
        value:
          $ref: '#/components/schemas/VehicleStatsIntakeManifoldTempMilliCValue'
      required:
      - value
      type: object
    singleDriverEfficiencyByVehicleDataObjectResponseBody:
      description: singleDriverEfficiencyByVehicleDataObject
      properties:
        difficultyScore:
          $ref: '#/components/schemas/DriverEfficiencyDifficultyScoreDataObjectResponseBody'
        percentageData:
          $ref: '#/components/schemas/DriverEfficiencyPercentageDataObjectResponseBody'
        rawData:
          $ref: '#/components/schemas/DriverEfficiencyRawDataObjectResponseBody'
        scoreData:
          $ref: '#/components/schemas/DriverEfficiencyDataObjectResponseBody'
        vehicleId:
          description: ID of the vehicle.
          example: vehicle_001
          type: string
      required:
      - vehicleId
      type: object
    VehicleType:
      description: The type of the vehicle. Only returned for customers with commercial speed limits (CSL) enabled.
      example: truck
      type: string
    VehiclesListVehiclesUnauthorizedErrorResponseBody:
      description: Unauthorized
      properties:
        message:
          description: Message of error
          example: Invalid token.
          type: string
        requestId:
          description: The request ID; used when reaching out to support for issues with requests.
          example: 8916e1c1
          type: string
      required:
      - message
      - requestId
      type: object
    Sensor:
      properties:
        id:
          description: ID of the sensor
          type: string
        mac:
          description: MAC address of the sensor
          type: string
        name:
          description: Name of the sensor
          type: string
      required:
      - id
      - mac
      - name
      type: object
    VehicleSensorConfiguration:
      description: The sensors configured on a vehicle
      properties:
        areas:
          items:
            $ref: '#/components/schemas/VehicleSensorConfigurationArea'
          type: array
        doors:
          items:
            $ref: '#/components/schemas/VehicleSensorConfigurationDoor'
          type: array
      type: object
    VehicleStatsFaultCodesValue_obdii_diagnosticTroubleCodes:
      description: Diagnostic trouble code for passenger vehicles.
      properties:
        confirmedDtcs:
          description: Confirmed DTC codes.
          items:
            $ref: '#/components/schemas/VehicleStatsFaultCodesValue_obdii_confirmedDtcs'
          type: array
        ignitionType:
          description: 'The ignition type of this passenger vehicle. Valid values: `spark`, `compression`.'
          enum:
          - spark
          - compression
          type: string
        milStatus:
          description: The MIL status, indicating a check engine light.
          example: true
          type: boolean
        monitorStatus:
          $ref: '#/components/schemas/VehicleStatsFaultCodesValue_obdii_monitorStatus'
        pendingDtcs:
          description: Pending DTC codes.
          items:
            $ref: '#/components/schemas/VehicleStatsFaultCodesValue_obdii_confirmedDtcs'
          type: array
        permanentDtcs:
          description: Permanent DTC codes.
          items:
            $ref: '#/components/schemas/VehicleStatsFaultCodesValue_obdii_confirmedDtcs'
          type: array
        txId:
          description: The TX identifier.
          example: 0
          format: int32
          type: integer
      required:
      - txId
      type: object
    VehicleStatsObdEngineSecondsWithDecoration:
      description: Vehicle OBD engine seconds reading.
      properties:
        decorations:
          $ref: '#/components/schemas/VehicleStatsDecorations'
        time:
          $ref: '#/components/schemas/time'
        value:
          description: Number of seconds the vehicle's engine has been on according to the on-board diagnostics.
          example: 9723103
          format: int64
          type: integer
      required:
      - time
      - value
      type: object
    DriverEfficiencyGetDriverEfficiencyByVehiclesGatewayTimeoutErrorResponseBody:
      description: Gateway timeout
      properties:
        message:
          description: Message of error
          example: context deadline exceeded
          type: string
        requestId:
          description: The request ID; used when reaching out to support for issues with requests.
          example: 8916e1c1
          type: string
      required:
      - message
      - requestId
      type: object
    VehicleStatsEvChargingVoltageMilliVolt:
      description: Charging voltage for electric and hybrid vehicles in milli volts. Not all EV and HEVs may report this field.
      properties:
        time:
          $ref: '#/components/schemas/time'
        value:
          description: Charging voltage for electric and hybrid vehicles in milli volts.
          example: 1000
          format: int64
          type: integer
      required:
      - time
      - value
      type: object
    VehicleSensorConfigurationArea:
      description: The sensor configuration for an area of the vehicle
      properties:
        cargoSensors:
          description: Cargo sensors configured in this position of the vehicle
          items:
            $ref: '#/components/schemas/Sensor'
          type: array
        humiditySensors:
          description: Humidity sensors configured in this position of the vehicle
          items:
            $ref: '#/components/schemas/Sensor'
          type: array
        position:
          description: Position of the area on vehicle
          enum:
          - Position_Front
          - Position_Middle
          - Position_Back
          example: ''
          type: string
        temperatureSensors:
          description: Temperature sensors configured in this position of the vehicle
          items:
            $ref: '#/components/schemas/Sensor'
          type: array
      type: object
    VehicleVin:
      description: The VIN of the Vehicle. Most of the time, this will be automatically read from the engine computer by the Samsara Vehicle Gateway. It will be empty if it cannot be read. It can be set or updated through the Samsara Dashboard or the API at any time.
      example: 1FUJA6BD31LJ09646
      maxLength: 17
      minLength: 11
      type: string
    VehiclesListVehiclesNotImplementedErrorResponseBody:
      description: Requested endpoint is not yet implemented
      properties:
        message:
          description: Message of error
          example: Not implemented.
          type: string
        requestId:
          description: The request ID; used when reaching out to support for issues with requests.
          example: 8916e1c1
          type: string
      required:
      - message
      - requestId
      type: object
    TachographVehicleFilesResponse:
      description: List of all vehicle tachograph files in a specified time range.
      properties:
        data:
          $ref: '#/components/schemas/TachographVehicleFileData'
        pagination:
          $ref: '#/components/schemas/paginationResponse'
      type: object
    VehicleStatsResponse_evBatteryVoltageMilliVolt:
      description: Battery voltage for electric and hybrid vehicles in milli volts. Not all EV and HEVs may report this field.
      properties:
        time:
          description: 'UTC timestamp in RFC 3339 format. Example: `2020-01-27T07:06:25Z`.'
          example: '2020-01-27T07:06:25Z'
          type: string
        value:
          description: Battery voltage for electric and hybrid vehicles in milli volts.
          example: 1000
          format: int64
          type: integer
      required:
      - time
      - value
      type: object
    Serial:
      description: The serial number of the gateway installed in the vehicle.
      example: VG12345
      type: string
    VehiclesListVehiclesResponseBody:
      properties:
        data:
          description: Multiple vehicles.
          items:
            $ref: '#/components/schemas/VehicleResponseObjectResponseBody'
          type: array
        pagination:
          $ref: '#/components/schemas/GoaPaginationResponseResponseBody'
      required:
      - data
      - pagination
      type: object
    VehicleStatsEvBatteryVoltageMilliVolt:
      description: Battery voltage for electric and hybrid vehicles in milli volts. Not all EV and HEVs may report this field.
      properties:
        time:
          $ref: '#/components/schemas/time'
        value:
          description: Battery voltage for electric and hybrid vehicles in milli volts.
          example: 1000
          format: int64
          type: integer
      required:
      - time
      - value
      type: object
    DriverEfficiencyGetDriverEfficiencyByVehiclesBadGatewayErrorResponseBody:
      description: Bad Gateway
      properties:
        message:
          description: Message of error
          example: 'rpc error: code = Unknown desc = connection refused'
          type: string
        requestId:
          description: The request ID; used when reaching out to support for issues with requests.
          example: 8916e1c1
          type: string
      required:
      - message
      - requestId
      type: object
    EngineImmobilizerGetEngineImmobilizerStatesBadGatewayErrorResponseBody:
      description: Bad Gateway
      properties:
        message:
          description: Message of error
          example: 'rpc error: code = Unknown desc = connection refused'
          type: string
        requestId:
          description: The request ID; used when reaching out to support for issues with requests.
          example: 8916e1c1
          type: string
      required:
      - message
      - requestId
      type: object
    VehicleStatsSpreaderActive:
      description: Whether vehicle is actively spreading any material.
      properties:
        time:
          $ref: '#/components/schemas/time'
        value:
          description: Whether vehicle is actively spreading any material.
          enum:
          - 'Off'
          - 'On'
          example: 'On'
          type: string
      required:
      - time
      - value
      type: object
    gatewayTiny:
      description: A minified gateway including serial number and model.
      properties:
        model:
          description: The gateway model
          example: VG34
          type: string
        serial:
          description: The serial number of the gateway.
          example: ABCD-123-XYZ
          type: string
      type: object
    VehicleStatsBatteryMilliVoltsValue:
      description: The battery voltage in millivolts.
      example: 7991
      format: int64
      type: integer
    VehicleStatsEvConsumedEnergyMicroWh:
      description: Consumed energy (including regenerated) for electric and hybrid vehicles in microwatt hours. Not all EV and HEVs may report this field.
      properties:
        time:
          $ref: '#/components/schemas/time'
        value:
          description: Consumed energy (including regenerated) for electric and hybrid vehicles in microwatt hours.
          example: 1000
          format: int64
          type: integer
      required:
      - time
      - value
      type: object
    VehicleStatsGpsDistanceMetersWithDecoration:
      description: Vehicle GPS distance event.
      properties:
        decorations:
          $ref: '#/components/schemas/VehicleStatsDecorations'
        time:
          $ref: '#/components/schemas/time'
        value:
          description: Number of meters the vehicle has traveled since the gateway was installed, based on GPS calculations.
          example: 81029.591434899
          format: double
          type: number
      required:
      - time
      - value
      type: object
    V1SafetyReportHarshEvent:
      description: List of harsh events
      properties:
        harshEventType:
          description: Sensor generated harsh event type.
          example: Harsh Braking
          type: string
        timestampMs:
          description: Timestamp that the harsh event occurred in Unix milliseconds since epoch
          example: 1535590776000
          type: integer
        vehicleId:
          description: Vehicle associated with the harsh event
          example: 212014918086169
          type: integer
      type: object
    VehicleStatsFaultCodesValue_j1939:
      description: Vehicle fault codes for J1939 vehicles.
      properties:
        checkEngineLights:
          $ref: '#/components/schemas/VehicleStatsFaultCodesValue_j1939_checkEngineLights'
        diagnosticTroubleCodes:
          description: Diagnostic trouble codes for J1939 vehicles.
          items:
            $ref: '#/components/schemas/VehicleStatsFaultCodesValue_j1939_diagnosticTroubleCodes'
          type: array
      type: object
    V1VehicleHarshEventResponse:
      description: Harsh event details for a vehicle
      properties:
        downloadForwardVideoUrl:
          description: URL for downloading the forward facing video
          example: https://samsara-dashcam-videos.s3.us-west-2.amazonaws.com/123/212123456789012/1539201872984/abC123De4-camera-video-segment-123456789.mp4?...
          type: string
        downloadInwardVideoUrl:
          description: URL for downloading the inward facing video
          example: https://samsara-dashcam-videos.s3.us-west-2.amazonaws.com/123/212123456789012/1539201872984/abC123De4-camera-video-segment-driver-123456789.mp4?...
          type: string
        downloadTrackedInwardVideoUrl:
          description: URL for downloading the tracked inward facing video
          example: https://samsara-dashcam-videos.s3.us-west-2.amazonaws.com/123/212123456789012/1539201872984/abC123De4-camera-video-segment-driver-123456789.tracked.mp4?...
          type: string
        harshEventType:
          description: 'Type of the harsh event. One of: [Crash, Harsh Acceleration, Harsh Braking, Harsh Turn, ROP Engine, ROP Brake, YC Engine, YC Brake, Harsh Event]'
          example: Harsh Braking
          type: string
        incidentReportUrl:
          description: URL of the associated incident report page
          example: https://cloud.samsara.com/o/1234/fleet/reports/safety/vehicle/212123456789012/incident/1539201882984
          type: string
        isDistracted:
          description: Whether the driver was deemed distracted during this harsh event
          example: true
          type: boolean
        location:
          $ref: '#/components/schemas/V1VehicleHarshEventResponse_location'
      required:
      - harshEventType
      - incidentReportUrl
      type: object
    VehicleStatsBatteryVoltageWithDecoration:
      description: Vehicle battery voltage reading.
      properties:
        decorations:
          $ref: '#/components/schemas/VehicleStatsDecorations'
        time:
          $ref: '#/components/schemas/time'
        value:
          description: The battery voltage in millivolts.
          example: 7991
          format: int64
          type: integer
      required:
      - time
      - value
      type: object
    VehicleStatsResponse_spreaderPrewetRate:
      description: 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. Unfiltered live stats are supplied as-read from the Material Spreader unit. Readings do not consider total spread rate(s) over time or distance.
      properties:
        time:
          description: 'UTC timestamp in RFC 3339 format. Example: `2020-01-27T07:06:25Z`.'
          example: '2020-01-27T07:06:25Z'
          type: string
        value:
          description: 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. Unfiltered live stats are supplied as-read from the Material Spreader unit. Readings do not consider total spread rate(s) over time or distance.
          example: 1000
          format: int64
          type: integer
      required:
      - time
      - value
      type: object
    VehicleStatsNfcCardScan:
      description: Data for the nfc card and the time that it was scanned.
      properties:
        card:
          $ref: '#/components/schemas/VehicleStatsNfcCardScan_card'
        time:
          $ref: '#/components/schemas/vehicleStatsAuxInputTime'
      required:
      - card
      - time
      type: object
    VehiclesListVehiclesServiceUnavailableErrorResponseBody:
      description: Service unavailable
      properties:
        message:
          description: Message of error
          example: context deadline exceeded
          type: string
        requestId:
          description: The request ID; used when reaching out to support for issues with requests.
          example: 8916e1c1
          type: string
      required:
      - message
      - requestId
      type: object
    driverTinyResponse:
      description: A minified driver object.
      properties:
        id:
          description: ID of the driver.
          example: '88668'
          type: string
        name:
          description: Name of the driver.
          example: Susan Bob
          type: string
      type: object
    VehicleLocationSpeed:
      description: GPS speed of the vehicle in miles per hour. See `isEcuSpeed` to determine speed data source.
      example: 48.3
      format: double
      type: number
    VehicleStatsSpreaderPrewetRate:
      description: 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. Unfiltered live stats are supplied as-read from the Material Spreader unit. Readings do not consider total spread rate(s) over time or distance.
      properties:
        time:
          $ref: '#/components/schemas/time'
        value:
          description: 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. Unfiltered live stats are supplied as-read from the Material Spreader unit. Readings do not consider total spread rate(s) over time or distance.
          example: 1000
          format: int64
          type: integer
      required:
      - time
      - value
      type: object
    VehicleStatsIntakeManifoldTempMilliCWithDecoration:
      description: Vehicle intake manifold temperature reading.
      properties:
        decorations:
          $ref: '#/components/schemas/VehicleStatsDecorations'
        time:
          $ref: '#/components/schemas/time'
        value:
          description: The intake manifold temperature reading in millidegree Celsius.
          example: 88000
          format: int64
          type: integer
      required:
      - time
      - value
      type: object
    VehicleStatsResponse_evChargingStatus:
      description: Charging status for electric and hybrid vehicles. Not all EV and HEVs may report this field.
      properties:
        time:
          description: 'UTC timestamp in RFC 3339 format. Example: `2020-01-27T07:06:25Z`.'
          example: '2020-01-27T07:06:25Z'
          type: string
        value:
          description: "Charging status for electric and hybrid vehicles. Statuses:\n unknown - 0,\n not charging - 1,\n charging - 2."
          enum:
          - 0
          - 1
          - 2
          - 3
          - 4
          format: int64
          type: integer
      required:
      - time
      - value
      type: object
    VehicleStatsEngineOilPressureKPa:
      description: Vehicle engine oil pressure reading.
      properties:
        time:
          $ref: '#/components/schemas/time'
        value:
          description: The engine oil pressure reading in kilopascals.
          example: 100
          format: int64
          type: integer
      required:
      - time
      - value
      type: object
    VehicleStatsEngineCoolantTempMilliCWithDecoration:
      description: Vehicle engine coolant temperature reading.
      properties:
        decorations:
          $ref: '#/components/schemas/VehicleStatsDecorations'
        time:
          $ref: '#/components/schemas/time'
        value:
          description: The engine coolant temperature reading in millidegree Celsius.
          example: 31110
          format: int64
          type: integer
      required:
      - time
      - value
      type: object
    VehicleStatsResponse_seatbeltDriver:
      description: Seatbelt Driver Status as read from the vehicle. `Buckled` or `Unbuckled`.
      properties:
        time:
          description: 'UTC timestamp in RFC 3339 format. Example: `2020-01-27T07:06:25Z`.'
          example: '2020-01-27T07:06:25Z'
          type: string
        value:
          description: Seatbelt Driver Status as read from the vehicle. `Buckled` or `Unbuckled`.
          enum:
          - Buckled
          - Unbuckled
          example: Buckled
          type: string
      required:
      - time
      - value
      type: object
    VehicleStatsFuelPercent:
      description: Vehicle fuel percentage reading.
      properties:
        time:
          $ref: '#/components/schemas/time'
        value:
          description: The engine fuel level in percentage points (e.g. `99`, `50`, etc).
          example: 54
          format: int64
          type: integer
      required:
      - time
      - value
      type: object
    VehicleStatsSpreaderLiquidName:
      description: Name of most recent type of liquid material spread, read from the material spreader.
      properties:
        time:
          $ref: '#/components/schemas/time'
        value:
          description: Name of most recent type of liquid material spread, read from the material spreader.
          example: DIR1
          type: string
      required:
      - time
      - value
      type: object
    VehiclesDriverAssignmentsGetVehiclesDriverAssignmentsNotImplementedErrorResponseBody:
      description: Requested endpoint is not yet implemented
      properties:
        message:
          description: Message of error
          example: Not implemented.
          type: string
        requestId:
          description: The request ID; used when reaching out to support for issues with requests.
          example: 8916e1c1
          type: string
      required:
      - message
      - requestId
      type: object
    VehicleStatsDecorations_gps:
      properties:
        address:
          $ref: '#/components/schemas/VehicleLocationAddress'
        headingDegrees:
          $ref: '#/components/schemas/VehicleLocationHeading'
        isEcuSpeed:
          $ref: '#/components/schemas/VehicleLocationIsEcuSpeed'
        latitude:
          $ref: '#/components/schemas/VehicleLocationLatitude'
        longitude:
          $ref: '#/components/schemas/VehicleLocationLongitude'
        reverseGeo:
          $ref: '#/components/schemas/reverseGeo'
        speedMilesPerHour:
          $ref: '#/components/schemas/VehicleLocationSpeed'
      required:
      - latitude
      - longitude
      type: object
    VehicleStatsFuelPercentWithDecoration:
      description: Vehicle fuel percentage reading.
      properties:
        decorations:
          $ref: '#/components/schemas/VehicleStatsDecorations'
        time:
          $ref: '#/components/schemas/time'
        value:
          description: The engine fuel level in percentage points (e.g. `99`, `50`, etc).
          example: 54
          format: int64
          type: integer
      required:
      - time
      - value
      type: object
    VehicleStatsFaultCodesVendorSpecificFields:
      description: Vendor specific data for J1939 vehicles.
      properties:
        dtcDescription:
          description: The DTC description, if available.
          example: 'false'
          type: string
        repairInstructionsUrl:
          description: A link to vendor repair instructions, if available.
          example: 'false'
          type: string
      type: object
    VehicleStatsGpsOdometerMetersWithDecoration:
      description: Vehicle GPS odometer event.
      properties:
        decorations:
          $ref: '#/components/schemas/VehicleStatsDecorations'
        time:
          $ref: '#/components/schemas/time'
        value:
          description: Number of meters the vehicle has traveled according to the GPS calculations and the manually-specified odometer reading.
          example: 14010293
          format: int64
          type: integer
      required:
      - time
      - value
      type: object
    DriverEfficiencyDifficultyScoreDataObjectResponseBody:
      description: Difficulty score won't be available if there is no data to compute it against.
      properties:
        overallScore:
          description: Represents the overall difficulty score. It has scores from 1 to 5.
          example: '4'
          type: string
        topographyScore:
          description: Represents the topography difficulty score. It has scores from 1 to 5.
          example: '5'
          type: string
        vehicleWeightScore:
          description: ' Represents the average vehicle weight score. It has scores from 1 to 5.'
          example: '4'
          type: string
      type: object
    VehicleSensorConfigurationDoor:
      description: A door monitor configuration for a vehicle
      properties:
        position:
          description: Position of the door monitor on the vehicle
          enum:
          - Position_Left
          - Position_Right
          example: ''
          type: string
        sensor:
          $ref: '#/components/schemas/Sensor'
      type: object
    VehicleNotes:
      description: These are generic notes about the Vehicle. Empty by default. Can be set or updated through the Samsara Dashboard or the API at any time.
      example: These are notes about this given vehicle.
      maxLength: 255
      type: string
    VehicleStatsDecorations:
      description: "Optional decorations to the primary stat event. See [here](doc:decorations) for more details. The example shows the response if you were to submit `decorations=engineStates&obdEngineSeconds` to the query parameter:\n\n```json\n\"decorations\":{\n  \"engineStates\": {\n    \"value\": \"Off\"\n  },\n  \"obdEngineSeconds\": {\n    \"value\": 9723103\n  }\n}\n```"
      properties:
        ambientAirTemperatureMilliC:
          $ref: '#/components/schemas/VehicleStatsDecorations_ambientAirTemperatureMilliC'
        auxInput1:
          $ref: '#/components/schemas/VehicleStatsAuxInputDecoration'
        auxInput10:
          $ref: '#/components/schemas/VehicleStatsAuxInputDecoration'
        auxInput11:
          $ref: '#/components/schemas/VehicleStatsAuxInputDecoration'
        auxInput12:
          $ref: '#/components/schemas/VehicleStatsAuxInputDecoration'
        auxInput13:
          $ref: '#/components/schemas/VehicleStatsAuxInputDecoration'
        auxInput2:
          $ref: '#/components/schemas/VehicleStatsAuxInputDecoration'
        auxInput3:
          $ref: '#/components/schemas/VehicleStatsAuxInputDecoration'
        auxInput4:
          $ref: '#/components/schemas/VehicleStatsAuxInputDecoration'
        auxInput5:
          $ref: '#/components/schemas/VehicleStatsAuxInputDecoration'
        auxInput6:
          $ref: '#/components/schemas/VehicleStatsAuxInputDecoration'
        auxInput7:
          $ref: '#/components/schemas/VehicleStatsAuxInputDecoration'
        auxInput8:
          $ref: '#/components/schemas/VehicleStatsAuxInputDecoration'
        auxInput9:
          $ref: '#/components/schemas/VehicleStatsAuxInputDecoration'
        barometricPressurePa:
          $ref: '#/components/schemas/VehicleStatsDecorations_barometricPressurePa'
        batteryMilliVolts:
          $ref: '#/components/schemas/VehicleStatsDecorations_batteryMilliVolts'
        defLevelMilliPercent:
          $ref: '#/components/schemas/VehicleStatsDecorations_defLevelMilliPercent'
        ecuSpeedMph:
          $ref: '#/components/schemas/VehicleStatsDecorations_ecuSpeedMph'
        engineCoolantTemperatureMilliC:
          $ref: '#/components/schemas/VehicleStatsDecorations_engineCoolantTemperatureMilliC'
        engineImmobilizer:
          $ref: '#/components/schemas/VehicleStatsEngineImmobilizer'
        engineLoadPercent:
          $ref: '#/components/schemas/VehicleStatsDecorations_engineLoadPercent'
        engineOilPressureKPa:
          $ref: '#/components/schemas/VehicleStatsDecorations_engineOilPressureKPa'
        engineRpm:
          $ref: '#/components/schemas/VehicleStatsDecorations_engineRpm'
        engineStates:
          $ref: '#/components/schemas/VehicleStatsDecorations_engineStates'
        evAverageBatteryTemperatureMilliCelsius:
          $ref: '#/components/schemas/VehicleStatsEvAverageBatteryTemperatureMilliCelsius'
        evBatteryCurrentMilliAmp:
          $ref: '#/components/schemas/VehicleStatsEvBatteryCurrentMilliAmp'
        evBatteryStateOfHealthMilliPercent:
          $ref: '#/components/schemas/VehicleStatsEvBatteryStateOfHealthMilliPercent'
        evBatteryVoltageMilliVolt:
          $ref: '#/components/schemas/VehicleStatsEvBatteryVoltageMilliVolt'
        evChargingCurrentMilliAmp:
          $ref: '#/components/schemas/VehicleStatsEvChargingCurrentMilliAmp'
        evChargingEnergyMicroWh:
          $ref: '#/components/schemas/VehicleStatsEvChargingEnergyMicroWh'
        evChargingStatus:
          $ref: '#/components/schemas/VehicleStatsEvChargingStatus'
        evChargingVoltageMilliVolt:
          $ref: '#/components/schemas/VehicleStatsEvChargingVoltageMilliVolt'
        evConsumedEnergyMicroWh:
          $ref: '#/components/schemas/VehicleStatsEvConsumedEnergyMicroWh'
        evDistanceDrivenMeters:
          $ref: '#/components/schemas/VehicleStatsEvDistanceDrivenMeters'
        evRegeneratedEnergyMicroWh:
          $ref: '#/components/schemas/VehicleStatsEvRegeneratedEnergyMicroWh'
        evStateOfChargeMilliPercent:
          $ref: '#/components/schemas/VehicleStatsEvStateOfChargeMilliPercent'
        faultCodes:
          $ref: '#/components/schemas/VehicleStatsFaultCodesValue'
        fuelPercents:
          $ref: '#/components/schemas/VehicleStatsDecorations_fuelPercents'
        gps:
          $ref: '#/components/schemas/VehicleStatsDecorations_gps'
        gpsDistanceMeters:
          $ref: '#/components/schemas/VehicleStatsDecorations_gpsDistanceMeters'
        gpsOdometerMeters:
          $ref: '#/components/schemas/VehicleStatsDecorations_gpsOdometerMeters'
        intakeManifoldTemperatureMilliC:
          $ref: '#/components/schemas/VehicleStatsDecorations_intakeManifoldTemperatureMilliC'
        obdEngineSeconds:
          $ref: '#/components/schemas/VehicleStatsDecorations_obdEngineSeconds'
        obdOdometerMeters:
          $ref: '#/components/schemas/VehicleStatsDecorations_obdOdometerMeters'
        seatbeltDriver:
          $ref: '#/components/schemas/VehicleStatsSeatbeltDriver'
        spreaderActive:
          $ref: '#/components/schemas/VehicleStatsSpreaderActive'
        spreaderAirTemp:
          $ref: '#/components/schemas/VehicleStatsSpreaderAirTemp'
        spreaderBlastState:
          $ref: '#/components/schemas/VehicleStatsSpreaderBlastState'
        spreaderGranularName:
          $ref: '#/components/schemas/VehicleStatsSpreaderGranularName'
        spreaderGranularRate:
          $ref: '#/components/schemas/VehicleStatsSpreaderGranularRate'
        spreaderLiquidName:
          $ref: '#/components/schemas/VehicleStatsSpreaderLiquidName'
        spreaderLiquidRate:
          $ref: '#/components/schemas/VehicleStatsSpreaderLiquidRate'
        spreaderOnState:
          $ref: '#/components/schemas/VehicleStatsSpreaderOnState'
        spreaderPlowStatus:
          $ref: '#/components/schemas/VehicleStatsSpreaderPlowStatus'
        spreaderPrewetName:
          $ref: '#/components/schemas/VehicleStatsSpreaderPrewetName'
        spreaderPrewetRate:
          $ref: '#/components/schemas/VehicleStatsSpreaderPrewetRate'
        spreaderRoadTemp:
          $ref: '#/components/schemas/VehicleStatsSpreaderRoadTemp'
        tirePressure:
          $ref: '#/components/schemas/VehicleStatsTirePressures'
      type: object
    VehicleName:
      description: The human-readable name of the Vehicle. This is set by a fleet administrator and will appear in both Samsaras cloud dashboard as well as the Samsara Driver mobile app. **By default**, this name is the serial number of the Samsara Vehicle Gateway. It can be set or updated through the Samsara Dashboard or through the API at any time.
      example: Truck A7
      type: string
    VehicleRegulationMode:
      description: 'Whether or not the vehicle is regulated, unregulated (non-CMV), or a mixed use unregulated vehicle. Valid values: `regulated`, `unregulated`, `mixed`.'
      enum:
      - regulated
      - unregulated
      - mixed
      example: regulated
      type: string
    VehicleLocationLatitude:
      description: GPS latitude represented in degrees
      example: 122.142
      format: double
      type: number
    VehicleStatsEngineOilPressureKPaValue:
      description: The engine oil pressure reading in kilopascals.
      example: 100
      format: int64
      type: integer
    VehicleStatsEngineRpmWithDecoration:
      description: Vehicle engine RPM reading.
      properties:
        decorations:
          $ref: '#/components/schemas/VehicleStatsDecorations'
        time:
          $ref: '#/components/schemas/time'
        value:
          description: The revolutions per minute of the engine.
          example: 1000
          format: int64
          type: integer
      required:
      - time
      - value
      type: object
    VehicleStatsFaultCodesTxId:
      description: The TX identifier.
      example: 0
      format: int32
      type: integer
    VehiclesListVehiclesInternalServerErrorResponseBody:
      description: An internal server error occurred
      properties:
        message:
          description: Message of error
          example: Failed to execute GraphQL query.
          type: string
        requestId:
          description: The request ID; used when reaching out to support for issues with requests.
          example: 8916e1c1
          type: string
      required:
      - message
      - requestId
      type: object
    VehicleStatsFaultCodesJ1939:
      description: Vehicle fault codes for J1939 vehicles.
      properties:
        checkEngineLights:
          $ref: '#/components/schemas/VehicleStatsFaultCodesJ1939Lights'
        diagnosticTroubleCodes:
          $ref: '#/components/schemas/VehicleStatsFaultCodesJ1939TroubleCodes'
      type: object
    VehicleStatsEngineCoolantTempMilliC:
      description: Vehicle engine coolant temperature reading.
      properties:
        time:
          $ref: '#/components/schemas/time'
        value:
          description: The engine coolant temperature reading in millidegree Celsius.
          example: 31110
          format: int64
          type: integer
      required:
      - time
      - value
      type: object
    VehicleStatsSpreaderPlowStatus:
      description: 'Snow plow status (`Up` or `Down`), as read from the material spreader. Note: this is separate from plow status defined via auxInput.'
      properties:
        time:
          $ref: '#/components/schemas/time'
        value:
          description: Snow plow status, as read from the material spreader
          enum:
          - Up
          - Down
          example: Down
          type: string
      required:
      - time
      - value
      type: object
    EngineImmobilizerGetEngineImmobilizerStatesTooManyRequestsErrorResponseBody:
      description: Too many requests
      properties:
        message:
          description: Message of error
          example: Exceeded rate limit.
          type: string
        requestId:
          description: The request ID; used when reaching out to support for issues with requests.
          example: 8916e1c1
          type: string
      required:
      - message
      - requestId
      type: object
    VehiclesDriverAssignmentsGetVehiclesDriverAssignmentsTooManyRequestsErrorResponseBody:
      description: Too many requests
      properties:
        message:
          description: Message of error
          example: Exceeded rate limit.
          type: string
        requestId:
          description: The request ID; used when reaching out to support for issues with requests.
          example: 8916e1c1
          type: string
      required:
      - message
      - requestId
      type: object
    VehicleStatsIntakeManifoldTempMilliCValue:
      description: The intake manifold temperature reading in millidegree Celsius.
      example: 88000
      format: int64
      type: integer
    EngineImmobilizerGetEngineImmobilizerStatesInternalServerErrorResponseBody:
      description: An internal server error occurred
      properties:
        message:
          description: Message of error
          example: Failed to execute GraphQL query.
          type: string
        requestId:
          description: The request ID; used when reaching out to support for issues with requests.
          example: 8916e1c1
          type: string
      required:
      - message
      - requestId
      type: object
    VehicleStatsObdOdometerMetersValue:
      description: Number of meters the vehicle has traveled according to the on-board diagnostics.
      example: 14010293
      format: int64
      type: integer
    VehicleStatsFaultCodesValue_oem_diagnosticTroubleCodes:
      description: Proprietary diagnostic trouble code for some OEM vehicles.
      properties:
        codeDescription:
          description: The OEM code description.
          example: KVGT Servo Error
          type: string
        codeIdentifier:
          description: The OEM code identifier.
          example: CA2387
          type: string
        codeSeverity:
          description: The OEM code severity.
          example: L03
          type: string
        codeSource:
          description: The OEM code source.
          example: ENG/M
          type: string
      type: object
    VehiclesDriverAssignmentsGetVehiclesDriverAssignmentsNotFoundErrorResponseBody:
      description: Resource not found
      properties:
        message:
          description: Message of error
          example: Object not found.
          type: string
        requestId:
          description: The request ID; used when reaching out to support for issues with requests.
          example: 8916e1c1
          type: string
      required:
      - message
      - requestId
      type: object
    VehicleStatsFaultCodesValue_j1939_diagnosticTroubleCodes:
      description: Diagnostic trouble code for J1939 vehicles.
      properties:
        fmiDescription:
          description: A short description of the FMI identifier, if available.
          example: Voltage Below Normal
          type: string
        fmiId:
          description: The FMI identifier.
          example: 9
          format: int32
          type: integer
        milStatus:
          description: The MIL status, indicating a check engine light.
          example: 1
          format: int32
          type: integer
        occurrenceCount:
          description: The number of times this fault has triggered.
          example: 1
          format: int32
          type: integer
        sourceAddressName:
          description: The source address name corresponding to the txId
          example: 'Engine #1'
          type: string
        spnDescription:
          description: A short description of the SPN identifier, if available.
          example: 'System Diagnostic Code #1'
          type: string
        spnId:
          description: The SPN identifier.
          example: 3031
          format: int32
          type: integer
        txId:
          description: The TX identifier.
          example: 0
          format: int32
          type: integer
        vendorSpecificFields:
          $ref: '#/components/schemas/VehicleStatsFaultCodesValue_j1939_vendorSpecificFields'
      required:
      - fmiId
      - milStatus
      - occurrenceCount
      - spnId
      - txId
      type: object
    VehicleStatsResponse_data:
      description: A vehicle and its most recent stat.
      properties:
        ambientAirTemperatureMilliC:
          $ref: '#/components/schemas/VehicleStatsAmbientAirTempMilliC'
        auxInput1:
          $ref: '#/components/schemas/VehicleStatsAuxInput'
        auxInput10:
          $ref: '#/components/schemas/VehicleStatsAuxInput'
        auxInput11:
          $ref: '#/components/schemas/VehicleStatsAuxInput'
        auxInput12:
          $ref: '#/components/schemas/VehicleStatsAuxInput'
        auxInput13:
          $ref: '#/components/schemas/VehicleStatsAuxInput'
        auxInput2:
          $ref: '#/components/schemas/VehicleStatsAuxInput'
        auxInput3:
          $ref: '#/components/schemas/VehicleStatsAuxInput'
        auxInput4:
          $ref: '#/components/schemas/VehicleStatsAuxInput'
        auxInput5:
          $ref: '#/components/schemas/VehicleStatsAuxInput'
        auxInput6:
          $ref: '#/components/schemas/VehicleStatsAuxInput'
        auxInput7:
          $ref: '#/components/schemas/VehicleStatsAuxInput'
        auxInput8:
          $ref: '#/components/schemas/VehicleStatsAuxInput'
        auxInput9:
          $ref: '#/components/schemas/VehicleStatsAuxInput'
        barometricPressurePa:
          $ref: '#/components/schemas/VehicleStatsBarometricPressurePa'
        batteryMilliVolts:
          $ref: '#/components/schemas/VehicleStatsBatteryVoltage'
        defLevelMilliPercent:
          $ref: '#/components/schemas/VehicleStatsDefLevelMilliPercent'
        ecuSpeedMph:
          $ref: '#/components/schemas/VehicleStatsEcuSpeedMph'
        engineCoolantTemperatureMilliC:
          $ref: '#/components/schemas/VehicleStatsEngineCoolantTempMilliC'
        engineImmobilizer:
          $ref: '#/components/schemas/VehicleStatsEngineImmobilizer'
        engineLoadPercent:
          $ref: '#/components/schemas/VehicleStatsEngineLoadPercent'
        engineOilPressureKPa:
          $ref: '#/components/schemas/VehicleStatsEngineOilPressureKPa'
        engineRpm:
          $ref: '#/components/schemas/VehicleStatsEngineRpm'
        engineState:
          $ref: '#/components/schemas/VehicleStatsEngineState'
        evAverageBatteryTemperatureMilliCelsius:
          $ref: '#/components/schemas/VehicleStatsResponse_evAverageBatteryTemperatureMilliCelsius'
        evBatteryCurrentMilliAmp:
          $ref: '#/components/schemas/VehicleStatsResponse_evBatteryCurrentMilliAmp'
        evBatteryStateOfHealthMilliPercent:
          $ref: '#/components/schemas/VehicleStatsResponse_evBatteryStateOfHealthMilliPercent'
        evBatteryVoltageMilliVolt:
          $ref: '#/components/schemas/VehicleStatsResponse_evBatteryVoltageMilliVolt'
        evChargingCurrentMilliAmp:
          $ref: '#/components/schemas/VehicleStatsResponse_evChargingCurrentMilliAmp'
        evChargingEnergyMicroWh:
          $ref: '#/components/schemas/VehicleStatsResponse_evChargingEnergyMicroWh'
        evChargingStatus:
          $ref: '#/components/schemas/VehicleStatsResponse_evChargingStatus'
        evChargingVoltageMilliVolt:
          $ref: '#/components/schemas/VehicleStatsResponse_evChargingVoltageMilliVolt'
        evConsumedEnergyMicroWh:
          $ref: '#/components/schemas/VehicleStatsResponse_evConsumedEnergyMicroWh'
        evDistanceDrivenMeters:
          $ref: '#/components/schemas/VehicleStatsResponse_evDistanceDrivenMeters'
        evRegeneratedEnergyMicroWh:
          $ref: '#/components/schemas/VehicleStatsResponse_evRegeneratedEnergyMicroWh'
        evStateOfChargeMilliPercent:
          $ref: '#/components/schemas/VehicleStatsResponse_evStateOfChargeMilliPercent'
        externalIds:
          $ref: '#/components/schemas/VehicleExternalIds'
        faultCodes:
          $ref: '#/components/schemas/VehicleStatsFaultCodes'
        fuelPercent:
          $ref: '#/components/schemas/VehicleStatsFuelPercent'
        gps:
          $ref: '#/components/schemas/VehicleStatsGps'
        gpsDistanceMeters:
          $ref: '#/components/schemas/VehicleStatsGpsDistanceMeters'
        gpsOdometerMeters:
          $ref: '#/components/schemas/VehicleStatsGpsOdometerMeters'
        id:
          $ref: '#/components/schemas/VehicleId'
        intakeManifoldTemperatureMilliC:
          $ref: '#/components/schemas/VehicleStatsIntakeManifoldTempMilliC'
        name:
          $ref: '#/components/schemas/VehicleName'
        nfcCardScan:
          $ref: '#/components/schemas/VehicleStatsNfcCardScan'
        obdEngineSeconds:
          $ref: '#/components/schemas/VehicleStatsObdEngineSeconds'
        obdOdometerMeters:
          $ref: '#/components/schemas/VehicleStatsObdOdometerMeters'
        seatbeltDriver:
          $ref: '#/components/schemas/VehicleStatsResponse_seatbeltDriver'
        spreaderActive:
          $ref: '#/components/schemas/VehicleStatsResponse_spreaderActive'
        spreaderAirTemp:
          $ref: '#/components/schemas/VehicleStatsResponse_spreaderAirTemp'
        spreaderBlastState:
          $ref: '#/components/schemas/VehicleStatsResponse_spreaderBlastState'
        spreaderGranularName:
          $ref: '#/components/schemas/VehicleStatsResponse_spreaderGranularName'
        spreaderGranularRate:
          $ref: '#/components/schemas/VehicleStatsResponse_spreaderGranularRate'
        spreaderLiquidName:
          $ref: '#/components/schemas/VehicleStatsResponse_spreaderLiquidName'
        spreaderLiquidRate:
          $ref: '#/components/schemas/VehicleStatsResponse_spreaderLiquidRate'
        spreaderOnState:
          $ref: '#/components/schemas/VehicleStatsResponse_spreaderOnState'
        spreaderPlowStatus:
          $ref: '#/components/schemas/VehicleStatsResponse_spreaderPlowStatus'
        spreaderPrewetName:
          $ref: '#/components/schemas/VehicleStatsResponse_spreaderPrewetName'
        spreaderPrewetRate:
          $ref: '#/components/schemas/VehicleStatsResponse_spreaderPrewetRate'
        spreaderRoadTemp:
          $ref: '#/components/schemas/VehicleStatsResponse_spreaderRoadTemp'
        syntheticEngineSeconds:
          $ref: '#/components/schemas/VehicleStatsSyntheticEngineSeconds'
      required:
      - id
      - name
      type: object
    VehicleStatsFaultCodesValue_j1939_vendorSpecificFields:
      description: Vendor specific data for J1939 vehicles.
      properties:
        dtcDescription:
          description: The DTC description, if available.
          example: 'false'
          type: string
        repairInstructionsUrl:
          description: A link to vendor repair instructions, if available.
          example: 'false'
          type: string
      type: object
    DriverEfficiencyGetDriverEfficiencyByVehiclesMethodNotAllowedErrorResponseBody:
      description: Method not allowed
      properties:
        message:
          description: Message of error
          example: DELETE not allowed on /endpoint.
          type: string
        requestId:
          description: The request ID; used when reaching out to support for issues with requests.
          example: 8916e1c1
          type: string
      required:
      - message
      - requestId
      type: object
    VehiclesDriverAssignmentsGetVehiclesDriverAssignmentsUnauthorizedErrorResponseBody:
      description: Unauthorized
      properties:
        message:
          description: Message of error
          example: Invalid token.
          type: string
        requestId:
          description: The request ID; used when reaching out to support for issues with requests.
          example: 8916e1c1
          type: string
      required:
      - message
      - requestId
      type: object
    VehicleStatsObdEngineSecondsValue:
      description: Number of seconds the vehicle's engine has been on according to the on-board diagnostics.
      example: 9723103
      format: int64
      type: integer
    DriverEfficiencyGetDriverEfficiencyByVehiclesResponseBody:
      properties:
        data:
          description: List of driver efficiency data associated with vehicles.
          items:
            $ref: '#/components/schemas/singleDriverEfficiencyByVehicleDataObjectResponseBody'
          type: array
        pagination:
          $ref: '#/components/schemas/GoaPaginationResponseResponseBody'
      required:
      - data
      - pagination
      type: object
    VehiclesListVehiclesBadGatewayErrorResponseBody:
      description: Bad Gateway
      properties:
        message:
          description: Message of error
          example: 'rpc error: code = Unknown desc = connection refused'
          type: string
        requestId:
          description: The request ID; used when reaching out to support for issues with requests.
          example: 8916e1c1
          type: string
      required:
      - message
      - requestId
      type: object
    VehicleStatsDecorations_batteryMilliVolts:
      properties:
        value:
          $ref: '#/components/schemas/VehicleStatsBatteryMilliVoltsValue'
      required:
      - value
      type: object
    DriverEfficiencyGetDriverEfficiencyByVehiclesUnauthorizedErrorResponseBody:
      description: Unauthorized
      properties:
        message:
          description: Message of error
          example: Invalid token.
          type: string
        requestId:
          description: The request ID; used when reaching out to support for issues with requests.
          example: 8916e1c1
          type: string
      required:
      - message
      - requestId
      type: object
    VehicleStatsEvAverageBatteryTemperatureMilliCelsius:
      description: Battery temperature for electric and hybrid vehicles in milli celsius. Not all EV and HEVs may report this field.
      properties:
        time:
          $ref: '#/components/schemas/time'
        value:
          description: Battery temperature for electric and hybrid vehicles in milli celsius.
          example: 1000
          format: int64
          type: integer
      required:
      - time
      - value
      type: object
    VehicleStatsSyntheticEngineSecondsValue:
      description: Stats for the number of seconds the vehicle's engine has been on, calculated based on a manually-specified engine seconds reading and the number of seconds the vehicle has been on according to the engine state changes reported to the vehicle gateway since that reading was set. This stat will not be present for any vehicle that does not have the engine seconds reading set. The engine seconds reading can be set from the UI on the vehicle details page.
      example: 14010293
      format: int64
      type: integer
    VehiclesDriverAssignmentsGetVehiclesDriverAssignmentsServiceUnavailableErrorResponseBody:
      description: Service unavailable
      properties:
        message:
          description: Message of error
          example: context deadline exceeded
          type: string
        requestId:
          description: The request ID; used when reaching out to support for issues with requests.
          example: 8916e1c1
          type: string
      required:
      - message
      - requestId
      type: object
    VehiclesListVehiclesNotFoundErrorResponseBody:
      description: Resource not found
      properties:
        message:
          description: Message of error
          example: Object not found.
          type: string
        requestId:
          description: The request ID; used when reaching out to support for issues with requests.
          example: 8916e1c1
          type: string
      required:
      - message
      - requestId
      type: object
    VehicleMake:
      description: The Vehicles manufacturing make. Automatically read from the engine computer if available. Empty if not available. Cannot be manually set.
      example: Ford
      maxLength: 255
      type: string
    VehicleLocationsListResponse:
      description: List of vehicle location events and pagination info.
      properties:
        data:
          description: A list of vehicles and an array of location events for each vehicle.
          items:
            $ref: '#/components/schemas/VehicleLocationsListResponse_data'
          type: array
        pagination:
          $ref: '#/components/schemas/paginationResponse'
      required:
      - data
      - pagination
      type: object
    VehicleStatsEcuSpeedMph:
      description: The speed of the vehicle in miles per hour, as reported by the ECU.
      properties:
        time:
          $ref: '#/components/schemas/time'
        value:
          description: The speed of the vehicle in miles per hour.
          example: 32.1
          format: double
          type: number
      required:
      - time
      - value
      type: object
    VehicleStatsFaultCodesPassengerDtc:
      description: Passenger vehicle DTC information
      properties:
        dtcDescription:
          description: The DTC description, if available.
          example: Fuel Rail/System Pressure - Too Low Bank 1
          type: string
        dtcId:
          description: The DTC identifier.
          example: 135
          format: int32
          type: integer
        dtcShortCode:
          description: The DTC short code, if available.
          example: P0087
          type: string
      required:
      - dtcId
      type: object
    VehicleLocationsListResponse_data:
      description: A vehicle and its list of location events.
      properties:
        id:
          $ref: '#/components/schemas/VehicleId'
        locations:
          description: A list of location events for the given vehicle.
          items:
            $ref: '#/components/schemas/VehicleLocation'
          type: array
        name:
          $ref: '#/components/schemas/VehicleName'
      required:
      - id
      - locations
      - name
      type: object
    VehicleStatsDecorations_engineCoolantTemperatureMilliC:
      properties:
        value:
          $ref: '#/components/schemas/VehicleStatsEngineCoolantTempMilliCValue'
      required:
      - value
      type: object
    VehicleStatsDefLevelMilliPercentValue:
      description: The Diesel Exhaust Fluid (DEF) level in milli percentage points (e.g. `99001`, `49999`, etc).
      example: 54200
      format: int64
      maximum: 99999
      minimum: 0
      type: integer
    VehicleStatsFaultCodesValue_obdii:
      description: Vehicle fault codes for passenger vehicles.
      properties:
        checkEngineLightIsOn:
          description: True if the check engine light is illuminated (MIL status field is nonzero for any faults).
          example: true
          type: boolean
        diagnosticTroubleCodes:
          description: Diagnostic trouble codes for passenger vehicles.
          items:
            $ref: '#/components/schemas/VehicleStatsFaultCodesValue_obdii_diagnosticTroubleCodes'
          type: array
      type: object
    VehicleStatsDecorations_obdOdometerMeters:
      properties:
        value:
          $ref: '#/components/schemas/VehicleStatsObdOdometerMetersValue'
      required:
      - value
      type: object
    VehicleStatsTirePressures:
      description: Tire pressure readings for each of four tires in kilopascals.
      properties:
        backLeftTirePressureKPa:
          description: The tire pressure of the rear left tire as seen when standing behind the vehicle in kilopascals.
          example: 200
          format: int64
          type: integer
        backRightTirePressureKPa:
          description: The tire pressure of the rear right tire as seen when standing behind the vehicle in kilopascals.
          example: 200
          format: int64
          type: integer
        frontLeftTirePressureKPa:
          description: The tire pressure of the front left tire as seen when standing behind the vehicle in kilopascals.
          example: 200
          format: int64
          type: integer
        frontRightTirePressureKPa:
          description: The tire pressure of the front right tire as seen when standing behind the vehicle in kilopascals.
          example: 200
          format: int64
          type: integer
      type: object
    VehicleResponseObjectResponseBody:
      description: A single vehicle
      properties:
        attributes:
          description: List of attributes associated with the entity
          items:
            $ref: '#/components/schemas/GoaAttributeTinyResponseBody'
          type: array
        auxInputType1:
          description: The type of auxiliary input configured for this Vehicle.
          example: boom
          type: string
        auxInputType10:
          description: The type of auxiliary input configured for this Vehicle.
          example: boom
          type: string
        auxInputType11:
          description: The type of auxiliary input configured for this Vehicle.
          example: boom
          type: string
        auxInputType12:
          description: The type of auxiliary input configured for this Vehicle.
          example: boom
          type: string
        auxInputType13:
          description: The type of auxiliary input configured for this Vehicle.
          example: boom
          type: string
        auxInputType2:
          description: The type of auxiliary input configured for this Vehicle.
          example: boom
          type: string
        auxInputType3:
          description: The type of auxiliary input configured for this Vehicle.
          example: boom
          type: string
        auxInputType4:
          description: The type of auxiliary input configured for this Vehicle.
          example: boom
          type: string
        auxInputType5:
          description: The type of auxiliary input configured for this Vehicle.
          example: boom
          type: string
        auxInputType6:
          description: The type of auxiliary input configured for this Vehicle.
          example: boom
          type: string
        auxInputType7:
          description: The type of auxiliary input configured for this Vehicle.
          example: boom
          type: string
        auxInputType8:
          description: The type of auxiliary input configured for this Vehicle.
          example: boom
          type: string
        auxInputType9:
          description: The type of auxiliary input configured for this Vehicle.
          example: boom
          type: string
        cameraSerial:
          description: The serial number of the camera installed in the vehicle
          example: CNCK-VT8-XA8
          type: string
        createdAtTime:
          description: Time the vehicle was created in RFC 3339 format.
          example: '1992-07-25T10:57:56Z'
          format: date-time
          type: string
        esn:
          description: Engine serial number.
          example: '56349811'
          type: string
        externalIds:
          additionalProperties:
            type: string
          description: A map of external ids
          type: object
        gateway:
          $ref: '#/components/schemas/GoaGatewayTinyResponseResponseBody'
        harshAccelerationSettingType:
          description: The harsh acceleration setting type.
          example: 'off'
          type: string
        id:
          description: ID of the vehicle
          example: '494123'
          type: string
        licensePlate:
          description: The license plate of the vehicle.
          example: 6SAM123
          type: string
        make:
          description: The Vehicles manufacturing make.
          example: Ford
          type: string
        model:
          description: The Vehicles manufacturing model.
          example: F150
          type: string
        name:
          description: Name of the vehicle
          example: 'Fleet Truck #1'
          type: string
        notes:
          description: These are generic notes about the Vehicle.
          example: These are notes about this given vehicle.
          type: string
        sensorConfiguration:
          $ref: '#/components/schemas/vehicleSensorConfigurationResponseBody'
        serial:
          description: The serial number of the gateway installed in the vehicle.
          example: VG12345
          type: string
        staticAssignedDriver:
          $ref: '#/components/schemas/DriverObjectResponseBody'
        tags:
          description: The list of tags associated with the Vehicle.
          items:
            $ref: '#/components/schemas/GoaTagTinyResponseResponseBody'
          type: array
        updatedAtTime:
          description: Time the vehicle was updated in RFC 3339 format.
          example: '2014-04-21T17:14:40Z'
          format: date-time
          type: string
        vehicleRegulationMode:
          description: 'Whether the vehicle is regulated or unregulated (non-CMV).  Valid values: `regulated`, `unregulated`'
          enum:
          - regulated
          - unregulated
          example: regulated
          type: string
        vehicleType:
          description: 'The type of the vehicle. Only returned for customers with commercial speed limits (CSL) enabled.  Valid values: `unset`, `passenger`, `truck`, `bus`'
          enum:
          - unset
          - passenger
          - truck
          - bus
          example: unset
          type: string
        vehicleWeight:
          description: The weight of the vehicle in either pounds (lb) or kilograms (kg). Unit of weight is unknown. Only returned for customers with commercial speed limits (CSL) enabled.
          example: 1000
          format: int64
          type: integer
        vehicleWeightInKilograms:
          description: The weight of the vehicle in kilograms (kg). Only returned for customers with commercial speed limits (CSL) enabled.
          example: 1000
          format: int64
          type: integer
        vehicleWeightInPounds:
          description: The weight of the vehicle in pounds (lb). Only returned for customers with commercial speed limits (CSL) enabled.
          example: 2200
          format: int64
          type: integer
        vin:
          description: The VIN of the vehicle.
          example: 1GBJ6P1B2HV112765
          type: string
        year:
          example: '2008'
          type: string
      required:
      - createdAtTime
      - id
      type: object
    VehicleStatsDecorations_engineLoadPercent:
      properties:
        value:
          $ref: '#/components/schemas/VehicleStatsEngineLoadPercentValue'
      required:
      - value
      type: object
    VehiclesDriverAssignmentsGetVehiclesDriverAssignmentsMethodNotAllowedErrorResponseBody:
      description: Method not allowed
      properties:
        message:
          description: Message of error
          example: DELETE not allowed on /endpoint.
          type: string
        requestId:
          description: The request ID; used when reaching out to support for issues with requests.
          example: 8916e1c1
          type: string
      required:
      - message
      - requestId
      type: object
    DriverEfficiencyDataObjectResponseBody:
      description: Driver Efficiency score data. This object is returned by default or when the score format is specified in dataFormats.
      properties:
        anticipationScore:
          description: Represents the anticipation score for the driver. The score will be in either number or letter format depending on the organisation config.
          example: C
          type: string
        coastingScore:
          description: Represents the coasting score for the driver. The score will be in either number or letter format depending on the organisation config.
          example: C
          type: string
        cruiseControlScore:
          description: Represents the cruise control score for the driver. The score will be in either number or letter format depending on the organisation config.
          example: B
          type: string
        greenBandScore:
          description: Represents the green band score for the driver. The score will be in either number or letter format depending on the organisation config.
          example: A
          type: string
        highTorqueScore:
          description: Represents the high torque score for the driver. The score will be in either number or letter format depending on the organisation config.
          example: A
          type: string
        idlingScore:
          description: Represents the idling score for the driver.The score will be in either number or letter format depending on the organisation config.
          example: B
          type: string
        overSpeedScore:
          description: Represents the over speed score for the driver. The score will be in either number or letter format depending on the organisation config.
          example: B
          type: string
        overallScore:
          description: Represents the overall score for the driver. The score will be in either number (0-100) as a string or letter format (A-G) depending on the organisation config.
          example: A
          type: string
        wearFreeBrakeScore:
          description: Represents the ware-free breaking score for the driver. The score will be in either number or letter format depending on the organisation config.
          example: A
          type: string
      required:
      - overallScore
      type: object
    EngineImmobilizerGetEngineImmobilizerStatesMethodNotAllowedErrorResponseBody:
      description: Method not allowed
      properties:
        message:
          description: Message of error
          example: DELETE not allowed on /endpoint.
          type: string
        requestId:
          description: The request ID; used when reaching out to support for issues with requests.
          example: 8916e1c1
          type: string
      required:
      - message
      - requestId
      type: object
    VehicleStatsDecorations_ambientAirTemperatureMilliC:
      properties:
        value:
          $ref: '#/components/schemas/VehicleStatsAmbientAirTempMilliCValue'
      required:
      - value
      type: object
    VehicleStatsFaultCodesValue:
      description: Fault codes for the vehicle
      properties:
        canBusType:
          description: The CAN bus type of the vehicle.
          example: CANBUS_J1939_500
          type: string
        j1939:
          $ref: '#/components/schemas/VehicleStatsFaultCodesValue_j1939'
        obdii:
          $ref: '#/components/schemas/VehicleStatsFaultCodesValue_obdii'
        oem:
          $ref: '#/components/schemas/VehicleStatsFaultCodesValue_oem'
      type: object
    DriverObjectResponseBody:
      description: 'Current driver of the vehicle. Note: this parameter includes all assignment sources, not just static assignments.'
      properties:
        id:
          description: ID of the driver.
          example: 0987
          type: string
        name:
          description: Name of the driver.
          example: Driver Name
          type: string
      type: object
    VehicleStatsEngineLoadPercent:
      description: The engine load percentage reading.
      properties:
        time:
          $ref: '#/components/schemas/time'
        value:
          description: The engine load in percentage points (e.g. `99`, `50`, etc).
          example: 54
          format: int64
          type: integer
      required:
      - time
      - value
      type: object
    TachographVehicleFileListWrapper:
      properties:
        files:
          $ref: '#/components/schemas/TachographVehicleFileList'
        vehicle:
          $ref: '#/components/schemas/vehicleTinyResponse'
      type: object
    VehicleStatsObdOdometerMeters:
      description: Vehicle OBD odometer reading.
      properties:
        time:
          $ref: '#/components/schemas/time'
        value:
          description: Number of meters the vehicle has traveled according to the on-board diagnostics.
          example: 14010293
          format: int64
          type: integer
      required:
      - time
      - value
      type: object
    VehicleEsn:
      description: Engine serial number.
      example: '11223344'
      type: string
    VehicleStatsDecorations_obdEngineSeconds:
      properties:
        value:
          $ref: '#/components/schemas/VehicleStatsObdEngineSecondsValue'
      required:
      - value
      type: object
    VehicleStatsObdOdometerMetersWithDecoration:
      description: Vehicle OBD odometer reading.
      properties:
        decorations:
          $ref: '#/components/schemas/VehicleStatsDecorations'
        time:
          $ref: '#/components/schemas/time'
        value:
          description: Number of meters the vehicle has traveled according to the on-board diagnostics.
          example: 14010293
          format: int64
          type: integer
      required:
      - time
      - value
      type: object
    VehicleStatsListResponse_data:
      description: A vehicle and its list of stat events.
      properties:
        ambientAirTemperatureMilliC:
          description: A list of ambient air temperature readings in millidegree Celsius for the given vehicle.
          items:
            $ref: '#/components/schemas/VehicleStatsAmbientAirTempMilliCWithDecoration'
          type: array
        auxInput1:
          description: A list of auxiliary equipment states.
          items:
            $ref: '#/components/schemas/VehicleStatsAuxInputWithDecoration'
          type: array
        auxInput10:
          description: A list of auxiliary equipment states.
          items:
            $ref: '#/components/schemas/VehicleStatsAuxInputWithDecoration'
          type: array
        auxInput11:
          description: A list of auxiliary equipment states.
          items:
            $ref: '#/components/schemas/VehicleStatsAuxInputWithDecoration'
          type: array
        auxInput12:
          description: A list of auxiliary equipment states.
          items:
            $ref: '#/components/schemas/VehicleStatsAuxInputWithDecoration'
          type: array
        auxInput13:
          description: A list of auxiliary equipment states.
          items:
            $ref: '#/components/schemas/VehicleStatsAuxInputWithDecoration'
          type: array
        auxInput2:
          description: A list of auxiliary equipment states.
          items:
            $ref: '#/components/schemas/VehicleStatsAuxInputWithDecoration'
          type: array
        auxInput3:
          description: A list of auxiliary equipment states.
          items:
            $ref: '#/components/schemas/VehicleStatsAuxInputWithDecoration'
          type: array
        auxInput4:
          description: A list of auxiliary equipment states.
          items:
            $ref: '#/components/schemas/VehicleStatsAuxInputWithDecoration'
          type: array
        auxInput5:
          description: A list of auxiliary equipment states.
          items:
            $ref: '#/components/schemas/VehicleStatsAuxInputWithDecoration'
          type: array
        auxInput6:
          description: A list of auxiliary equipment states.
          items:
            $ref: '#/components/schemas/VehicleStatsAuxInputWithDecoration'
          type: array
        auxInput7:
          description: A list of auxiliary equipment states.
          items:
            $ref: '#/components/schemas/VehicleStatsAuxInputWithDecoration'
          type: array
        auxInput8:
          description: A list of auxiliary equipment states.
          items:
            $ref: '#/components/schemas/VehicleStatsAuxInputWithDecoration'
          type: array
        auxInput9:
          description: A list of auxiliary equipment states.
          items:
            $ref: '#/components/schemas/VehicleStatsAuxInputWithDecoration'
          type: array
        barometricPressurePa:
          description: A list of barometric pressure readings in pascals for the given vehicle.
          items:
            $ref: '#/components/schemas/VehicleStatsBarometricPressurePaWithDecoration'
          type: array
        batteryMilliVolts:
          description: A list of battery levels in milliVolts for the given vehicle.
          items:
            $ref: '#/components/schemas/VehicleStatsBatteryVoltageWithDecoration'
          type: array
        defLevelMilliPercent:
          description: A list of DEF level milli percentage readings for the given vehicle.
          items:
            $ref: '#/components/schemas/VehicleStatsDefLevelMilliPercentWithDecoration'
          type: array
        ecuSpeedMph:
          description: A list of the speeds of the vehicle in miles per hour, as reported by the ECU.
          items:
            $ref: '#/components/schemas/VehicleStatsEcuSpeedMphWithDecoration'
          type: array
        engineCoolantTemperatureMilliC:
          description: A list of engine coolant temperature readings in millidegree Celsius for the given vehicle.
          items:
            $ref: '#/components/schemas/VehicleStatsEngineCoolantTempMilliCWithDecoration'
          type: array
        engineImmobilizer:
          description: A list of engine immobilizer data for the given vehicle.
          items:
            $ref: '#/components/schemas/VehicleStatsEngineImmobilizerWithDecoration'
          type: array
        engineLoadPercent:
          description: A list of engine load percentage readings for the given vehicle.
          items:
            $ref: '#/components/schemas/VehicleStatsEngineLoadPercentWithDecoration'
          type: array
        engineOilPressureKPa:
          description: A list of engine oil pressure readings in kilopascals for the given vehicle.
          items:
            $ref: '#/components/schemas/VehicleStatsEngineOilPressureKPaWithDecoration'
          type: array
        engineRpm:
          description: A list engine RPM values for the given vehicle.
          items:
            $ref: '#/components/schemas/VehicleStatsEngineRpmWithDecoration'
          type: array
        engineStates:
          description: A list of engine state events for the given vehicle.
          items:
            $ref: '#/components/schemas/VehicleStatsEngineStateWithDecoration'
          type: array
        evAverageBatteryTemperatureMilliCelsius:
          description: Battery temperature for electric and hybrid vehicles in milli celsius. Not all EV and HEVs may report this field.
          items:
            $ref: '#/components/schemas/VehicleStatsEvAverageBatteryTemperatureMilliCelsius'
          type: array
        evBatteryCurrentMilliAmp:
          description: Battery current for electric and hybrid vehicles in milli amps. Not all EV and HEVs may report this field.
          items:
            $ref: '#/components/schemas/VehicleStatsEvBatteryCurrentMilliAmp'
          type: array
        evBatteryStateOfHealthMilliPercent:
          description: Milli percent battery state of health for electric and hybrid vehicles. Not all EV and HEVs may report this field.
          items:
            $ref: '#/components/schemas/VehicleStatsEvBatteryStateOfHealthMilliPercent'
          type: array
        evBatteryVoltageMilliVolt:
          description: Battery voltage for electric and hybrid vehicles in milli volts. Not all EV and HEVs may report this field.
          items:
            $ref: '#/components/schemas/VehicleStatsEvBatteryVoltageMilliVolt'
          type: array
        evChargingCurrentMilliAmp:
          description: Charging current for electric and hybrid vehicles in milli amps. Not all EV and HEVs may report this field.
          items:
            $ref: '#/components/schemas/VehicleStatsEvChargingCurrentMilliAmp'
          type: array
        evChargingEnergyMicroWh:
          description: Charging energy for electric and hybrid vehicles in microwatt hours. Not all EV and HEVs may report this field.
          items:
            $ref: '#/components/schemas/VehicleStatsEvChargingEnergyMicroWh'
          type: array
        evChargingStatus:
          description: Charging status for electric and hybrid vehicles. Not all EV and HEVs may report this field.
          items:
            $ref: '#/components/schemas/VehicleStatsEvChargingStatus'
          type: array
        evChargingVoltageMilliVolt:
          description: Charging voltage for electric and hybrid vehicles in milli  volts. Not all EV and HEVs may report this field.
          items:
            $ref: '#/components/schemas/VehicleStatsEvChargingVoltageMilliVolt'
          type: array
        evConsumedEnergyMicroWh:
          description: Consumed energy (including regenerated) for electric and hybrid vehicles in microwatt hours. Not all EV and HEVs may report this field.
          items:
            $ref: '#/components/schemas/VehicleStatsEvConsumedEnergyMicroWh'
          type: array
        evDistanceDrivenMeters:
          description: Electric distance driven for electric and hybrid vehicles in meters. Not all EV and HEVs may report this field.
          items:
            $ref: '#/components/schemas/VehicleStatsEvDistanceDrivenMeters'
          type: array
        evRegeneratedEnergyMicroWh:
          description: Regenerated energy for electric and hybrid vehicles in microwatt hours. Not all EV and HEVs may report this field.
          items:
            $ref: '#/components/schemas/VehicleStatsEvRegeneratedEnergyMicroWh'
          type: array
        evStateOfChargeMilliPercent:
          description: State of Charge for electric and hybrid vehicles. Not all EV and HEVs may report this field.
          items:
            $ref: '#/components/schemas/VehicleStatsEvStateOfChargeMilliPercent'
          type: array
        externalIds:
          $ref: '#/components/schemas/VehicleExternalIds'
        faultCodes:
          description: A list of engine fault codes.
          items:
            $ref: '#/components/schemas/VehicleStatsFaultCodesWithDecoration'
          type: array
        fuelPercents:
          description: A list of fuel percentage readings for the given vehicle.
          items:
            $ref: '#/components/schemas/VehicleStatsFuelPercentWithDecoration'
          type: array
        gps:
          description: A list of GPS location events for the given vehicles.
          items:
            $ref: '#/components/schemas/VehicleStatsListGps'
          type: array
        gpsDistanceMeters:
          description: A list of GPS distance events for the given vehicle.
          items:
            $ref: '#/components/schemas/VehicleStatsGpsDistanceMetersWithDecoration'
          type: array
        gpsOdometerMeters:
          description: A list of GPS odometer events for the given vehicle.
          items:
            $ref: '#/components/schemas/VehicleStatsGpsOdometerMetersWithDecoration'
          type: array
        id:
          $ref: '#/components/schemas/VehicleId'
        intakeManifoldTemperatureMilliC:
          description: A list of intake manifold temperature readings in millidegree Celsius for the given vehicle.
          items:
            $ref: '#/components/schemas/VehicleStatsIntakeManifoldTempMilliCWithDecoration'
          type: array
        name:
          $ref: '#/components/schemas/VehicleName'
        nfcCardScans:
          description: A list of NFC cards that were scanned for the given vehicles.
          items:
            $ref: '#/components/schemas/VehicleStatsNfcCardScanWithDecoration'
          type: array
        obdEngineSeconds:
          description: A list of OBD engine seconds readings for the given vehicle.
          items:
            $ref: '#/components/schemas/VehicleStatsObdEngineSecondsWithDecoration'
          type: array
        obdOdometerMeters:
          description: A list of OBD odometer readings for the given vehicle.
          items:
            $ref: '#/components/schemas/VehicleStatsObdOdometerMetersWithDecoration'
          type: array
        seatbeltDriver:
          description: Seatbelt Driver Status as read from the vehicle. `Buckled` or `Unbuckled`.
          items:
            $ref: '#/components/schemas/VehicleStatsSeatbeltDriver'
          type: array
        spreaderActive:
          description: Whether vehicle is actively spreading any material.
          items:
            $ref: '#/components/schemas/VehicleStatsSpreaderActive'
          type: array
        spreaderAirTemp:
          description: Air (ambient) temperature in milli celsius reading from material spreader.
          items:
            $ref: '#/components/schemas/VehicleStatsSpreaderAirTemp'
          type: array
        spreaderBlastState:
          description: Whether vehicle is actively spreading material in blast mode.
          items:
            $ref: '#/components/schemas/VehicleStatsSpreaderBlastState'
          type: array
        spreaderGranularName:
          description: Name of most recent type of granular material spread, read from the material spreader.
          items:
            $ref: '#/components/schemas/VehicleStatsSpreaderGranularName'
          type: array
        spreaderGranularRate:
          description: Granular spread rate reading in milliliters per meter, read from the material spreader. Unfiltered live stats are supplied as-read from the Material Spreader unit. Readings do not consider total spread rate(s) over time or distance.
          items:
            $ref: '#/components/schemas/VehicleStatsSpreaderGranularRate'
          type: array
        spreaderLiquidName:
          description: Name of most recent type of liquid material spread, read from the material spreader.
          items:
            $ref: '#/components/schemas/VehicleStatsSpreaderLiquidName'
          type: array
        spreaderLiquidRate:
          description: 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.
          items:
            $ref: '#/components/schemas/VehicleStatsSpreaderLiquidRate'
          type: array
        spreaderOnState:
          description: Whether vehicle spreader is enabled.
          items:
            $ref: '#/components/schemas/VehicleStatsSpreaderOnState'
          type: array
        spreaderPlowStatus:
          description: 'Snow plow status (`Up` or `Down`), as read from the material spreader. Note: this is separate from plow status defined via auxInput.'
          items:
            $ref: '#/components/schemas/VehicleStatsSpreaderPlowStatus'
          type: array
        spreaderPrewetName:
          description: Name of most recent type of prewet material spread, read from the material spreader.
          items:
            $ref: '#/components/schemas/VehicleStatsSpreaderPrewetName'
          type: array
        spreaderPrewetRate:
          description: 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.
          items:
            $ref: '#/components/schemas/VehicleStatsSpreaderPrewetRate'
          type: array
        spreaderRoadTemp:
          description: Road temperature reading in milli celsius from material spreader.
          items:
            $ref: '#/components/schemas/VehicleStatsSpreaderRoadTemp'
          type: array
        syntheticEngineSeconds:
          description: A list of synthetic engine seconds values.
          items:
            $ref: '#/components/schemas/VehicleStatsListSyntheticEngineSeconds'
          type: array
      type: object
    VehicleStatsSpreaderBlastState:
      description: Whether vehicle is actively spreading material in blast mode.
      properties:
        time:
          $ref: '#/components/schemas/time'
        value:
          description: Whether vehicle is actively spreading material in blast mode.
          enum:
          - 'On'
          - 'Off'
          example: 'Off'
          type: string
      required:
      - time
      - value
      type: object
    VehicleStatsDecorations_engineOilPressureKPa:
      properties:
        value:
          $ref: '#/components/schemas/VehicleStatsEngineOilPressureKPaValue'
      required:
      - value
      type: object
    VehicleStatsGpsDistanceMeters:
      description: Vehicle GPS distance event.
      properties:
        time:
          $ref: '#/components/schemas/time'
        value:
          description: Number of meters the vehicle has traveled since the gateway was installed, based on GPS calculations.
          example: 81029.591434899
          format: double
          type: number
      required:
      - time
      - value
      type: object
    VehicleStatsSpreaderOnState:
      description: Whether vehicle spreader is enabled.
      properties:
        time:
          $ref: '#/components/schemas/time'
        value:
          description: Whether vehicle spreader is enabled.
          enum:
          - 'On'
          - 'Off'
          example: 'On'
          type: string
      required:
      - time
      - value
      type: object
    VehicleStatsBarometricPressurePaValue:
      description: The barometric pressure reading in pascals.
      example: 99000
      format: int64
      type: integer
    EngineImmobilizerGetEngineImmobilizerStatesNotFoundErrorResponseBody:
      description: Resource not found
      properties:
        message:
          description: Message of error
          example: Object not found.
          type: string
        requestId:
          description: The request ID; used when reaching out to support for issues with requests.
          example: 8916e1c1
          type: string
      required:
      - message
      - requestId
      type: object
    VehicleLocationIsEcuSpeed:
      description: True if the speed value is reported from the ECU. Speed value is reported from GPS otherwise.
      example: true
      type: boolean
    VehicleLocationAddress:
      description: Address that the location is in.
      properties:
        id:
          description: Id of the address.
          example: '1234'
          type: string
        name:
          description: Name of address.
          example: Address 1
          type: string
      type: object
    VehicleStatsEngineCoolantTempMilliCValue:
      description: The engine coolant temperature reading in millidegree Celsius.
      example: 31110
      format: int64
      type: integer
    VehicleStatsAmbientAirTempMilliC:
      description: Vehicle ambient air temperature reading.
      properties:
        time:
          $ref: '#/components/schemas/time'
        value:
          description: The ambient air temperature reading in millidegree Celsius.
          example: 31110
          format: int64
          type: integer
      required:
      - time
      - value
      type: object
    TachographVehicleFileList:
      description: List of all tachograph vehicle files in a specified time range.
      items:
        $ref: '#/components/schemas/TachographVehicleFile'
      type: array
    VehicleStatsResponse_evChargingVoltageMilliVolt:
      description: Charging voltage for electric and hybrid vehicles in milli volts. Not all EV and HEVs may report this field.
      properties:
        time:
          description: 'UTC timestamp in RFC 3339 format. Example: `2020-01-27T07:06:25Z`.'
          example: '2020-01-27T07:06:25Z'
          type: string
        value:
          description: Charging voltage for electric and hybrid vehicles in milli volts.
          example: 1000
          format: int64
          type: integer
      required:
      - time
      - value
      type: object
    VehicleStatsBatteryVoltage:
      description: Vehicle battery voltage reading.
      properties:
        time:
          $ref: '#/components/schemas/time'
        value:
          description: The battery voltage in millivolts.
          example: 7991
          format: int64
          type: integer
      required:
      - time
      - value
      type: object
    VehicleStatsEvStateOfChargeMilliPercent:
      description: State of Charge for electric and hybrid vehicles. Not all EV and HEVs may report this field.
      properties:
        time:
          $ref: '#/components/schemas/time'
        value:
          description: Milli percent State of Charge for electric and hybrid vehicles.
          example: 1000
          format: int64
          type: integer
      required:
      - time
      - value
      type: object
    DriverEfficiencyGetDriverEfficiencyByVehiclesBadRequestErrorResponseBody:
      description: Bad Request parameters
      properties:
        message:
          description: Message of error
          example: Invalid value for parameter.
          type: string
        requestId:
          description: The request ID; used when reaching out to support for issues with requests.
          example: 8916e1c1
          type: string
      required:
      - message
      - requestId
      type: object
    VehicleStatsFaultCodesValue_j1939_checkEngineLights:
      description: Status of engine lights on J1939 vehicles.
      properties:
        emissionsIsOn:
          description: True if the MIL status is nonzero.
          example: true
          type: boolean
        protectIsOn:
          description: True if the engine protect lamp status is nonzero.
          example: false
          type: boolean
        stopIsOn:
          description: True if the red lamp status is nonzero.
          example: false
          type: boolean
        warningIsOn:
          description: True if the amber lamp status is nonzero.
          example: false
          type: boolean
      required:
      - emissionsIsOn
      - protectIsOn
      - stopIsOn
      - warningIsOn
      type: object
  securitySchemes:
    AccessTokenHeader:
      type: http
      scheme: bearer
x-original-swagger-version: '2.0'
x-readme:
  explorer-enabled: true
  proxy-enabled: true