GET
/
vehicles
/
{vehicleId}
/
stats
/
historical
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",
      "type": "engine_state",
      "sourceId": "123456789",
      "provider": "geotab",
      "timestamp": "2021-01-06T03:24:53.000Z",
      "vehicle": "vcl_01D8ZQFGHVJ858NBF2Q7DV9MNC",
      "state": "on",
      "raw": []
    },
    {
      "id": "vcl_st_01D8ZQFGHVJ8584BF2Q7D29M2D",
      "type": "odometer",
      "sourceId": "987654321",
      "provider": "geotab",
      "timestamp": "2021-01-06T04:34:52.000Z",
      "vehicle": "vcl_01D8ZQFGHVJ858NBF2Q7DV9MNC",
      "odometer": 230843,
      "raw": []
    },
    {
      "id": "vcl_st_01D8ZQFGHVJ8584BF2Q7D29M2D",
      "type": "fuel_level",
      "sourceId": "987654321",
      "provider": "geotab",
      "timestamp": "2021-01-06T04:34:52.000Z",
      "vehicle": "vcl_01D8ZQFGHVJ858NBF2Q7DV9MNC",
      "fuelPercentage": 70,
      "raw": []
    },
    {
      "id": "vcl_st_01D8ZQFGHVJ8584BF2Q7D29M2D",
      "type": "total_fuel_consumption",
      "sourceId": "987654321",
      "provider": "geotab",
      "timestamp": "2021-01-06T04:34:52.000Z",
      "vehicle": "vcl_01D8ZQFGHVJ858NBF2Q7DV9MNC",
      "fuelConsumed": 12370.34,
      "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

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

Timestamp to start from - defaults to beginning of history

Example:

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

​
endAt
string

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

200
application/json
OK
​
results
object[]
required
Example:
[
  {
    "id": "vcl_st_01D8ZQFGHVJ858NBF2Q7DV9MNC",
    "type": "engine_state",
    "sourceId": "123456789",
    "provider": "geotab",
    "timestamp": "2021-01-06T03:24:53.000Z",
    "vehicle": "vcl_01D8ZQFGHVJ858NBF2Q7DV9MNC",
    "state": "on",
    "raw": []
  },
  {
    "id": "vcl_st_01D8ZQFGHVJ8584BF2Q7D29M2D",
    "type": "odometer",
    "sourceId": "987654321",
    "provider": "geotab",
    "timestamp": "2021-01-06T04:34:52.000Z",
    "vehicle": "vcl_01D8ZQFGHVJ858NBF2Q7DV9MNC",
    "odometer": 230843,
    "raw": []
  },
  {
    "id": "vcl_st_01D8ZQFGHVJ8584BF2Q7D29M2D",
    "type": "fuel_level",
    "sourceId": "987654321",
    "provider": "geotab",
    "timestamp": "2021-01-06T04:34:52.000Z",
    "vehicle": "vcl_01D8ZQFGHVJ858NBF2Q7DV9MNC",
    "fuelPercentage": 70,
    "raw": []
  },
  {
    "id": "vcl_st_01D8ZQFGHVJ8584BF2Q7D29M2D",
    "type": "total_fuel_consumption",
    "sourceId": "987654321",
    "provider": "geotab",
    "timestamp": "2021-01-06T04:34:52.000Z",
    "vehicle": "vcl_01D8ZQFGHVJ858NBF2Q7DV9MNC",
    "fuelConsumed": 12370.34,
    "raw": []
  }
]
​
next
string

Cursor used for pagination.

Example:

"cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw"