Vehicle Location - Terminal

{
  "id": "vcl_loc_01D8ZQFGHVJ858NBF2Q7DV9MNC",
  "provider": "geotab",
  "vehicle": "vcl_01D8ZQFGHVJ858NBF2Q7DV9MNC",
  "locatedAt": "2021-01-06T03:24:53.000Z",
  "location": {
    "longitude": -122.4194155,
    "latitude": 37.7749295
  },
  "metadata": {
    "modifiedAt": "2023-11-07T05:31:56Z"
  },
  "sourceId": "123456789",
  "driver": "drv_01D8ZQFGHVJ858NBF2Q7DV9MNC",
  "address": {
    "formatted": "1.5 miles from Austin, TX"
  },
  "heading": 25,
  "speed": 95.33,
  "raw": []
}

Field Coverage

The percentage of connections across all providers that have data populated for each field.

Field	Coverage
`address.formatted`	60.8%
`driver`	47.5%
`heading`	71.3%
`id`	100%
`locatedAt`	100%
`location`	100%
`provider`	100%
`speed`	83%
`vehicle`	100%

string<ulid>

required

Unique identifier for the vehicle location in Terminal.

Example:

"vcl_loc_01D8ZQFGHVJ858NBF2Q7DV9MNC"

provider

string

required

Every provider has a unique code to identify it across Terminal's system. You can find each provider's code under provider details.

Example:

"geotab"

vehicle

required

The vehicle that the location is tracking.

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

Example:

"vcl_01D8ZQFGHVJ858NBF2Q7DV9MNC"

locatedAt

string<date-time>

required

ISO 8601 date

Example:

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

location

Coordinates · object

required

Show child attributes

metadata

TimeSeriesMetadata · object

required

Internal metadata about the time series.

Show child attributes

sourceId

string

The ID used to represent the entity in the source system.

Example:

"123456789"

driver

The driver that was driving the vehicle at the time of this location.

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

Example:

"drv_01D8ZQFGHVJ858NBF2Q7DV9MNC"

address

object

Reverse geocoded address details for locations when available at the source.

Show child attributes

heading

number

Heading in degrees

Example:

25

speed

number

Speed in KPH rounded to 2 decimal places.

Example:

95.33

raw

RawData · object[]

Show child attributes

Example:

[]

⌘I

​Field Coverage

Field Coverage