Data Management

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

Request

  • Base URL
    https://api.withterminal.com/tsp/v1
  • URL
    https://api.withterminal.com/tsp/v1/syncs
  • Auth
    HTTP bearer

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
daysnumber

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

providerRequestsSyncProviderRequestType[]

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
requestedAtstring date-time required
completedAtstring date-time
attemptsnumber
providerRequestsSyncProviderRequestType[]

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"
  ]
}

Changes

    • breaking

      added to the / response property oneOf list for the response status

    • warning

      added the new provider_timeout enum value to the response property for the response status

    • info

      added the non-success response with the status

    • info

      removed subschema #2 from the / response property oneOf list for the response status