Sign in

v1

latestOpenAPI 3.1.02026-07-22370342.6 KB
Data Management

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.

post/syncs

Headers

Connection-Tokenstring required
Example:con_tkn_22vUhkC6tgre4kwaYfUkCDA1rzn6eyb4

The token returned when a user authenticated their account. This authorizes access to a specific account.

Request body

startFromstring date-time

ISO 8601 date

daysnumber

How many days of history to sync from now. Will be converted to a date and used in place of startFrom

providerRequestsstring[]

Request additional information from the provider for this sync.

Example request

{
  "days": 7
}

Response

Created

idstring ulid required
status'requested' | 'in_progress' | 'completed' | 'failed' required

The status of the sync

failureReasonstring

If the sync failed, this will contain the reason

progressnumber

Percentage value between 0 and 100, rounded to 2 decimal places.

startFromstring date-time

ISO 8601 date

requestedAtstring date-time required

ISO 8601 date

completedAtstring date-time

ISO 8601 date

attemptsnumber
providerRequestsstring[]

Provider requests attached to this sync. When non-empty, the sync is waiting on an out-of-band step on the provider's side (e.g. the provider manually delivering historical files, or credentials being provisioned) and may legitimately stay in progress for an extended period.

Example response

{
  "id": "sync_01GV12VR4DJP70GD1ZBK0SDWFH",
  "status": "completed",
  "failureReason": "Reason for failure if sync status is 'failed'",
  "progress": 85,
  "issues": [
    "isu_01D8ZQFGHVJ858NBF2Q7DV9MNC"
  ],
  "startFrom": "2021-01-06T03:24:53.000Z",
  "requestedAt": "2021-01-06T03:24:53.000Z",
  "completedAt": "2021-01-06T03:24:53.000Z",
  "attempts": 1,
  "providerRequests": [
    "historical_files"
  ]
}