{
"id": "sync_01GV12VR4DJP70GD1ZBK0SDWFH",
"status": "completed",
"requestedAt": "2021-01-06T03:24:53.000Z",
"failureReason": "Reason for failure if sync status is 'failed'",
"progress": 85,
"issues": [
"isu_01D8ZQFGHVJ858NBF2Q7DV9MNC"
],
"startFrom": "2021-01-06T03:24:53.000Z",
"completedAt": "2021-01-06T03:24:53.000Z",
"attempts": 1,
"providerRequests": [
"historical_files"
]
}Sync
An object containing the state of a sync job. This can be polled after connection linking to know when data is available for ingestion.
^sync_[0-9A-HJKMNP-TV-Z]{26}$"sync_01GV12VR4DJP70GD1ZBK0SDWFH"
The status of the sync
requested, in_progress, completed, failed "completed"
If the sync failed, this will contain the reason
"Reason for failure if sync status is 'failed'"
Current sync progress as a percentage between 0 and 100.
0 <= x <= 10085
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.
^isu_[0-9A-HJKMNP-TV-Z]{26}$"isu_01D8ZQFGHVJ858NBF2Q7DV9MNC"
The earliest records to sync for those based on time (ex: historical locations and stats)
"2021-01-06T03:24:53.000Z"
1
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.
historical_files, provision_credentials ["historical_files"]