Skip to main content

Field Coverage

The percentage of connections across all providers that have data populated for each field.
id
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. Use the expand query parameter to return the full entity details instead of just the ID.

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

"vcl_01D8ZQFGHVJ858NBF2Q7DV9MNC"

locatedAt
string<date-time>
required
Example:

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

location
Coordinates · object
required
metadata
TimeSeriesMetadata · object
required

Internal metadata about the time series.

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. Use the expand query parameter to return the full entity details instead of just the ID.

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

"drv_01D8ZQFGHVJ858NBF2Q7DV9MNC"

address
object

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

heading
number

Heading in degrees

Example:

25

speed
number

Speed in KPH rounded to 2 decimal places.

Example:

95.33

raw
RawData · object[]
Example: