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:

"hos_log_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"

status
enum<string>
required
Available options:
off_duty,
sleeper_bed,
driving,
on_duty,
yard_move,
personal_conveyance,
waiting_time
driver
required

The driver this log belongs to. 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"

startedAt
string<date-time>
required
Example:

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

remarks
object[]
required
metadata
EntityMetadata · object
required

Internal metadata about the record.

vehicle

The vehicle the driver was driving when the log was recorded. 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"

codrivers
(string<ulid> | Driver · object)[]

Additional drivers that were included in the HOS log. Use the expand query parameter to return the full entity details instead of just the ID.

Unique identifier for the driver in Terminal.

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

"drv_01D8ZQFGHVJ858NBF2Q7DV9MNC"

endedAt
string<date-time>
Example:

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

location
Coordinates · object

Where the log was recorded

raw
RawData · object[]
Example: