Skip to main content
GET
Historical Vehicle Stats

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

X-Application-Id
string

Scopes the request to a Terminal application in the caller's organization. Required for multi-application organizations when using a user session or OAuth access token. API keys are already bound to a single application.

Connection-Token
string
required

The token returned when a user authenticated their account. This authorizes access to a specific account.

Pattern: ^con_tkn_\S+$
Example:

"con_tkn_22vUhkC6tgre4kwaYfUkCDA1rzn6eyb4"

Path Parameters

vehicleId
string<ulid>
required

Unique identifier for the vehicle in Terminal.

Pattern: ^vcl_[0-9A-HJKMNP-TV-Z]{26}$
Example:

"vcl_01D8ZQFGHVJ858NBF2Q7DV9MNC"

Query Parameters

cursor
string<cursor>

Pagination cursor to start requests from

Example:

"cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw"

limit
integer

The maximum number of results to return in a page.

expand
enum<string>

Expand resources in the returned response

Available options:
vehicle
startAt
string<date-time>

Timestamp to start from - defaults to beginning of history

Example:

"2021-01-06T03:24:53.000Z"

endAt
string<date-time>

Timestamp to end at - defaults to now

Example:

"2021-01-06T03:24:53.000Z"

types
string

Comma separated list of vehicle stats to filter for

Example:

"odometer,engine_state,fuel_level,total_fuel_consumption"

raw
boolean

Include raw responses used to normalize model. Used for debugging or accessing unique properties that are not unified.

Response

OK

results
(Engine State Log · object | Odometer Log · object | Total Fuel Consumption Log · object | Fuel Level Log · object | Engine Runtime Log · object | Engine Oil Percentage Log · object | Engine Oil Pressure Log · object | Engine Oil Temperature Log · object | Engine Coolant Temperature Log · object | Coolant Percentage Log · object | Engine RPM Log · object | Battery Voltage Log · object)[]
required
Example:
next
string<cursor>

Cursor used for pagination.

Example:

"cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw"