Sync - Terminal

{
  "id": "sync_01GV12VR4DJP70GD1ZBK0SDWFH",
  "status": "completed",
  "failureReason": "Reason for failure if sync status is 'failed'",
  "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
}

string<ulid>

required

Example:

"sync_01GV12VR4DJP70GD1ZBK0SDWFH"

status

enum<string>

required

The status of the sync

Available options:

requested,

in_progress,

completed,

failed

Example:

"completed"

requestedAt

string<date-time>

required

ISO 8601 date

Example:

"2021-01-06T03:24:53.000Z"

failureReason

string

If the sync failed, this will contain the reason

Example:

"Reason for failure if sync status is 'failed'"

issues

(string<ulid> | ExpandableIssue · object)[]

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.

Show child attributes

startFrom

string<date-time>

The earliest records to sync for those based on time (ex: historical locations and stats)

Example:

"2021-01-06T03:24:53.000Z"

completedAt

string<date-time>

ISO 8601 date

Example:

"2021-01-06T03:24:53.000Z"

attempts

number

Example:

1

Connection Issue

⌘I

Common Models