Common Models
Overview
Documentation for Terminal’s common model schemas
All data Terminal provides is normalized to our Common Models, which are schemas that remain consistent across all providers. This section documents these common models that you’ll encounter when working with Terminal data, regardless of the provider. You can see the common models supported by each provider on our Live Integrations page.
Here are the common models available from Terminal:
Entity Models
Vehicle
The model representing a vehicle in Terminal.
Driver
The model representing a driver in Terminal.
Group
A group represents a collection of assets (vehicles, trailers, drivers)
defined by the provider.
Device
Type of device installed in a vehicle.
Trailer
The model representing a trailer in Terminal.
Real-Time Data
Latest Vehicle Location
The latest record of a vehicle’s location according to the provider.
HOS Available Time
The available time left on the clock for a specific driver.
Latest Trailer Location
The latest record of a trailer’s location according to the provider.
Historical Data
Vehicle Location
A point-in-time record of a vehicle’s location.
Vehicle Stat Log
A point-in-time record of stats and logs for a specific vehicle.
Safety Event
A normalized record of a safety-related incident that occurred during a
vehicle’s operation. These events are detected and recorded by the telematics
provider’s system.
Trip
Trips define a period of time where a vehicle is in motion. Trips are based on
the provider’s definition.
Vehicle Utilization Day
Daily vehicle usage metrics for a specific vehicle and date.
Vehicle Utilization
Vehicle usage metrics for a specific vehicle and date range.
HOS Log
Records a change in duty status by a driver.
HOS Daily Log
Record of daily hours of service.
IFTA Vehicle Month
Mileage driven by a vehicle, month and jurisdiction. In the API, this is
summarized by the IFTA Summary model.
IFTA Summary
A report of IFTA data for a specific vehicle. Currently only incremented by
full months.
Terminal Platform
Connection
The connection your application has with your customer’s TSP.
Sync
An object containing the state of a sync job. This can be polled after
connection linking to know when data is available for ingestion.
Issue
An issue is a problem we encountered while ingesting data from a connection
that may impact the quality or completeness of the data.
Other
Camera Media
Video footage from vehicle cameras associated with safety events.