Request Sync
Manually request to sync the current connections data.
By default, Terminal will sync all connections where syncMode = automatic on a regular cadence. For customers that may not need a fleet’s data to be kept up to date and want to reduce their active tracked trucks, you can set syncMode = manual and invoke this endpoint when you want to sync data.
If you’re wondering if this is relevent to your use case then feel free to reach out and we’d be happy to assist.
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Headers
The token returned when a user authenticated their account. This authorizes access to a specific account.
Body
How to sync the data. If startFrom is not provided, it will either sync from the last time a sync was requested or now if the connection has no sync history. Can also provide days instead of startFrom and it will be converted to a date and used in place of startFrom.
When to start syncing from. If startFrom is not provided, it will either sync from the last time a sync was requested or now if the connection has no sync history.
How many days of history to sync from now. Will be converted to a date and used in place of startFrom
Response
An object containing the state of a sync job. This can be polled after connection linking to know when data is available for ingestion.
requested, in_progress, completed, failed ISO 8601 date
If the sync failed, this will contain the reason
Issues are problems encountered with a connection that did not result in a failed sync but may require manual intervention. You can see the issues for a given sync by providing issues to the expand parameter.
The earliest records to sync for those based on time (ex: historical locations and stats)
ISO 8601 date