WIwithterminal
Vehicles

Historical Vehicle Locations

Changed on

List the historical breadcrumb locations for a vehicle.

Note:

Given the large volume of location data available, we encourage customers to accept compressed (gzip) responses in order to maximize throughput. This is supported with many popular HTTP clients. Result limits vary depending on if results are compressed or not.

get/vehicles/{vehicleId}/locations

Request

  • Base URL
    https://api.withterminal.com/tsp/v1
  • URL
    https://api.withterminal.com/tsp/v1/vehicles/{vehicleId}/locations
  • Auth
    HTTP bearer

Query parameters

cursorstring cursor
Example:cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw

Pagination cursor to start requests from

limitinteger

The maximum number of results to return in a page.

startAtstring date-time
Example:2021-01-06T03:24:53.000Z

Timestamp to start from - defaults to beginning of history

endAtstring date-time
Example:2021-01-06T03:24:53.000Z

Timestamp to end at - defaults to now

rawboolean

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

Headers

X-Application-Idstring

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-Tokenstring required
Example:con_tkn_22vUhkC6tgre4kwaYfUkCDA1rzn6eyb4

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

Response

OK

nextstring cursor

Cursor used for pagination.

Example response

{
  "results": [
    {
      "id": "vcl_loc_01D8ZQFGHVJ858NBF2Q7DV9MNC",
      "sourceId": "123456789",
      "provider": "geotab",
      "vehicle": "vcl_01D8ZQFGHVJ858NBF2Q7DV9MNC",
      "driver": "drv_01D8ZQFGHVJ858NBF2Q7DV9MNC",
      "locatedAt": "2021-01-06T03:24:53.000Z",
      "location": {
        "longitude": -122.4194155,
        "latitude": 37.7749295
      },
      "address": {
        "formatted": "1.5 miles from Austin, TX"
      },
      "heading": 25,
      "speed": 95.33,
      "raw": []
    }
  ],
  "next": "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw"
}

Changes

  • 71081936e1bdRevision changes
    • breaking

      added the pattern ^[A-Za-z0-9+/=_-]+$ to the query request parameter cursor

    • info

      added the non-success response with the status

    • info

      added to the / response property allOf list for the response status

    • info

      removed subschema #2: Base Vehicle Location from the / response property allOf list for the response status

    • info

      the response's property pattern ^[A-Za-z0-9+/=_-]+$ was added for the status