metadata
object that is returned with each record. These timestamps are related to when Terminal processes the data, rather than when events occur in the source system.
Timestamp | Description |
---|---|
metadata.addedAt | The date and time when the record was ingested into Terminal |
metadata.modifiedAt | The date and time when the record was last updated in Terminal |
metadata.deletedAt | The date and time when the record was deleted from Terminal. When Terminal no longer sees the record in the source system, this timestamp is set to indicate a soft delete. By default, Terminal will not return deleted records in the response |
Vehicle
, Driver
, and Device
. Other models representing events or logs will have more specific timestamps.
Timestamp | Description |
---|---|
createdAt | The date and time when the record was created in the source system when available |
updatedAt | The date and time when the record was last updated in the source system when available |
Common Model | Timestamp | Format | Description |
---|---|---|---|
Safety Event | startedAt | ISO 8601 | The date and time when the safety event started |
Vehicle Stat Log | timestamp | ISO 8601 | The date and time when the vehicle statistics were recorded |
Vehicle Location | locatedAt | ISO 8601 | The date and time when the vehicle was at the recorded location |
Latest Vehicle Location | locatedAt | ISO 8601 | The date and time when the vehicle was at the recorded location |
Latest Trailer Location | locatedAt | ISO 8601 | The date and time when the trailer was at the recorded location |
Trip | startedAt | ISO 8601 | The date and time when the trip began |
HOS Log | startedAt | ISO 8601 | The date and time when the HOS status period began |
HOS Daily Log | date | YYYY-MM-DD | The calendar date of the daily log |
IFTA Summary | month | YYYY-MM | The month and year of the IFTA report |
metadata.addedAt
, metadata.modifiedAt
). While Terminal system timestamps track when data was processed by Terminal, these record-specific timestamps represent when events actually occurred according to the source system.
Access Pattern | Use Case |
---|---|
Modified Time | Ideal for syncing data to capture all changes effectively |
Record Time | Best for analyzing when events occurred in the real world |
Combined Approach | Targets records within a range that have been changed since a specific date |
modifiedAfter
and modifiedBefore
to easily sync only the data that has changed.startedAfter
and startedBefore
to show data based on when events actually happened.modifiedAt
timestamp using the modifiedAfter
and modifiedBefore
query parameters. These filters apply to the metadata.modifiedAt
field.
For example, to retrieve safety events that were modified in Terminal between January 1, 2023 and January 31, 2023:
metadata.modifiedAt
timestamp falls within the specified time range:
startedAfter
and startedBefore
parameters.
To retrieve safety events that occurred between January 15, 2023 and January 16, 2023:
startedAt
timestamp falls within the specified time range: