HOS Daily Log - Terminal

{
  "id": "hos_day_01D8ZQFGHVJ858NBF2Q7DV9MNC",
  "sourceId": "123456789",
  "provider": "geotab",
  "driver": "drv_01D8ZQFGHVJ858NBF2Q7DV9MNC",
  "date": "2021-01-06",
  "statusDurations": {
    "onDuty": 11252299,
    "offDuty": 48478999,
    "driving": 26668701,
    "waiting": 232322,
    "sleeperBed": 2300000,
    "personalConveyance": 500000,
    "yardMove": 62000
  },
  "metadata": {
    "addedAt": "2023-11-07T05:31:56Z",
    "modifiedAt": "2023-11-07T05:31:56Z"
  },
  "vehicles": [
    "vcl_01D8ZQFGHVJ858NBF2Q7DV9MNC"
  ],
  "distances": {
    "total": 100,
    "driving": 100,
    "personalConveyance": 100,
    "yardMove": 100
  },
  "raw": []
}

Field Coverage

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

Field	Coverage
`date`	100%
`distances.driving`	18.5%
`distances.personalConveyance`	0%
`distances.total`	30%
`distances.yardMove`	0%
`driver`	100%
`id`	100%
`provider`	100%
`sourceId`	100%
`statusDurations.driving`	91.7%
`statusDurations.offDuty`	65.5%
`statusDurations.onDuty`	93.1%
`statusDurations.personalConveyance`	0.5%
`statusDurations.sleeperBed`	58%
`statusDurations.waiting`	19.5%
`statusDurations.yardMove`	18.6%
`vehicles`

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

Reference to the driver for this log

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

Example:

"drv_01D8ZQFGHVJ858NBF2Q7DV9MNC"

date

string<date>

required

Example:

"2021-01-06"

statusDurations

object

required

Show child attributes

metadata

EntityMetadata · object

required

Internal metadata about the record.

Show child attributes

vehicles

(string<ulid> | Expanded Vehicle · object)[]

Vehicles associated with this daily HOS log.

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

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

Example:

"vcl_01D8ZQFGHVJ858NBF2Q7DV9MNC"

distances

object

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

Show child attributes

raw

RawData · object[]

Show child attributes

Example:

[]

⌘I

​Field Coverage

Field Coverage