Skip to main content

Field Coverage

The percentage of connections across all providers that have data populated for each field.
FieldCoverage
date100%
distances.driving18.8%
distances.personalConveyance0%
distances.total29.8%
distances.yardMove0%
driver100%
id100%
provider100%
sourceId100%
statusDurations.driving92.4%
statusDurations.offDuty64.8%
statusDurations.onDuty93.8%
statusDurations.personalConveyance0.5%
statusDurations.sleeperBed58%
statusDurations.waiting18.7%
statusDurations.yardMove18.8%
id
string<ulid>
required
Example:

"hos_day_01D8ZQFGHVJ858NBF2Q7DV9MNC"

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"

driver
required

Entities in Terminal are expandable. Using the expand query parameter you can choose to ingest just an ID or the full entity details.

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

"drv_01D8ZQFGHVJ858NBF2Q7DV9MNC"

date
string<date>
required
Example:

"2021-01-06"

statusDurations
object
required
metadata
EntityMetadata · object
required

Internal metadata about the record.

distances
object

Breakdown of different distance measurements for the day when available in the source system

raw
RawData · object[]
Example:
[]