Skip to main content
GET
/
vehicles
/
{vehicleId}
/
stats
/
historical
Historical Vehicle Stats
curl --request GET \
  --url https://api.withterminal.com/tsp/v1/vehicles/{vehicleId}/stats/historical \
  --header 'Authorization: Bearer <token>' \
  --header 'Connection-Token: <connection-token>'
{
  "results": [
    [
      {
        "id": "vcl_st_01D8ZQFGHVJ858NBF2Q7DV9MNC",
        "sourceId": "123456789",
        "provider": "geotab",
        "type": "engine_state",
        "timestamp": "2021-01-06T03:24:53.000Z",
        "vehicle": "vcl_01D8ZQFGHVJ858NBF2Q7DV9MNC",
        "state": "on",
        "metadata": {
          "modifiedAt": "2021-01-06T03:24:53.000Z"
        },
        "raw": []
      },
      {
        "id": "vcl_st_01D8ZQFGHVJ8584BF2Q7D29M2D",
        "sourceId": "987654321",
        "provider": "geotab",
        "type": "odometer",
        "timestamp": "2021-01-06T04:34:52.000Z",
        "vehicle": "vcl_01D8ZQFGHVJ858NBF2Q7DV9MNC",
        "odometer": 230843,
        "raw": []
      },
      {
        "id": "vcl_st_01D8ZQFGHVJ8584BF2Q7D29M3E",
        "sourceId": "987654322",
        "provider": "geotab",
        "type": "engine_runtime",
        "timestamp": "2021-01-06T04:34:52.000Z",
        "vehicle": "vcl_01D8ZQFGHVJ858NBF2Q7DV9MNC",
        "duration": 1234.5,
        "raw": []
      },
      {
        "id": "vcl_st_01D8ZQFGHVJ8584BF2Q7D29M3F",
        "sourceId": "987654323",
        "provider": "geotab",
        "type": "engine_oil_percentage",
        "timestamp": "2021-01-06T04:34:52.000Z",
        "vehicle": "vcl_01D8ZQFGHVJ858NBF2Q7DV9MNC",
        "percentage": 85,
        "raw": []
      },
      {
        "id": "vcl_st_01D8ZQFGHVJ8584BF2Q7D29M3G",
        "sourceId": "987654324",
        "provider": "geotab",
        "type": "engine_oil_pressure",
        "timestamp": "2021-01-06T04:34:52.000Z",
        "vehicle": "vcl_01D8ZQFGHVJ858NBF2Q7DV9MNC",
        "pressure": 45.2,
        "raw": []
      },
      {
        "id": "vcl_st_01D8ZQFGHVJ8584BF2Q7D29M3H",
        "sourceId": "987654325",
        "provider": "geotab",
        "type": "engine_oil_temperature",
        "timestamp": "2021-01-06T04:34:52.000Z",
        "vehicle": "vcl_01D8ZQFGHVJ858NBF2Q7DV9MNC",
        "temperature": 95,
        "raw": []
      },
      {
        "id": "vcl_st_01D8ZQFGHVJ8584BF2Q7D29M3I",
        "sourceId": "987654326",
        "provider": "geotab",
        "type": "engine_coolant_temperature",
        "timestamp": "2021-01-06T04:34:52.000Z",
        "vehicle": "vcl_01D8ZQFGHVJ858NBF2Q7DV9MNC",
        "temperature": 90,
        "raw": []
      },
      {
        "id": "vcl_st_01D8ZQFGHVJ8584BF2Q7D29M3J",
        "sourceId": "987654327",
        "provider": "geotab",
        "type": "coolant_percentage",
        "timestamp": "2021-01-06T04:34:52.000Z",
        "vehicle": "vcl_01D8ZQFGHVJ858NBF2Q7DV9MNC",
        "percentage": 75,
        "raw": []
      },
      {
        "id": "vcl_st_01D8ZQFGHVJ8584BF2Q7D29M3K",
        "sourceId": "987654328",
        "provider": "geotab",
        "type": "engine_rpm",
        "timestamp": "2021-01-06T04:34:52.000Z",
        "vehicle": "vcl_01D8ZQFGHVJ858NBF2Q7DV9MNC",
        "rpm": 2500,
        "raw": []
      },
      {
        "id": "vcl_st_01D8ZQFGHVJ8584BF2Q7D29M3L",
        "sourceId": "987654329",
        "provider": "geotab",
        "type": "battery_voltage",
        "timestamp": "2021-01-06T04:34:52.000Z",
        "vehicle": "vcl_01D8ZQFGHVJ858NBF2Q7DV9MNC",
        "voltage": 12.5,
        "raw": []
      }
    ]
  ],
  "next": "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw"
}

Authorizations

​
Authorization
string
header
required

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

Headers

​
Connection-Token
string
required

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

Example:

"con_tkn_22vUhkC6tgre4kwaYfUkCDA1rzn6eyb4"

Path Parameters

​
vehicleId
string
required

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
  • Engine State Log
  • Odometer Log
  • Total Fuel Consumption Log
  • Fuel Level Log
  • Engine Runtime Log
  • Engine Oil Percentage Log
  • Engine Oil Pressure Log
  • Engine Oil Temperature Log
  • Engine Coolant Temperature Log
  • Coolant Percentage Log
  • Engine RPM Log
  • Battery Voltage Log
​
next
string<cursor>

Cursor used for pagination.

Example:

"cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw"