Skip to main content

Field Coverage

The percentage of connections across all providers that have data populated for each field.
id
string<ulid>
required
Example:

"dvc_61D9ZWFGHVJ858NBF2Q7DV9MNC"

sourceId
string
required

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

Example:

"123456789"

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"

type
enum<string>
required

The type of device

Available options:
tracker,
camera,
phone
Example:

"tracker"

metadata
CoreEntityMetadata · object
required

Internal metadata about the record.

vehicle

The vehicle that the device is associated with. 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"

description
string

The description or model of the device

Example:

"CM31"

serialNumber
string

The serial number of the device

Example:

"1234567890"

lastConnectedAt
string<date-time>

The time the device was last connected

Example:

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

createdAt
string<date-time>

The date and time the record was created in the provider's system. This timestamp comes directly from the source system and represents when the data was originally created there. Note: not all providers expose this.

updatedAt
string<date-time>

The date and time the record was updated in the provider's system. This timestamp comes directly from the source system and represents when the data was last updated there. Note: not all providers expose this.

raw
RawData · object[]
Example: