Trip

Trips define a period of time where a vehicle is in motion. Trips are based on the provider’s definition.

id · string<ulid> · required

Example:

"trp_01D9ZQFGHVJ858NBF2Q7DV9MNH"

sourceId · string · required

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

Example:

"123456789"

vehicle · string<ulid> Expanded Vehicle · object · required

The ID of the vehicle that was involved in the trip.

Example:

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

startedAt · string<date-time> · required

ISO 8601 date

Example:

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

endedAt · string<date-time> · required

ISO 8601 date

Example:

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

duration · integer · required

Duration in MS

Required range: x >= 0

Example:

0

metadata · EntityMetadata · object · required

Internal metadata about the record.

Show child attributes

driver · string<ulid> Expanded Driver · object

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

Example:

"drv_01D8ZQFGHVJ858NBF2Q7DV9MNC"

startLocation · Coordinates · object

Show child attributes

endLocation · Coordinates · object

Show child attributes

distance · number

Distance in kilometers

Example:

100

raw · RawData · object[]

Show child attributes

Example:

[]