Connections
One sync run
GET
tenantKeyheader
AuthorizationBearer <token>Tenant API key, ohs_sk_ + 43 base62 characters.
id*stringFormat
uuidrun_id*integerFormat
int64The run.
application/json- response
One pull of one connection. status is queued, running, retrying (the last attempt
failed, see error; the next is at next_attempt_at), rate_limited (the provider asked to
wait until next_attempt_at), succeeded, failed (attempts spent, or the grant was refused)
or cancelled (the connection was disconnected). objects_stored counts the raw provider
payloads stored; the records written from them are announced by data.written webhooks.
id*integerFormat
int64provider*stringtrigger*stringValue in
"backfill""scheduled""notification""manual"status*stringValue in
"queued""running""retrying""rate_limited""succeeded""failed""cancelled"data_type*|Set when a notification named the one data type to pull.
window_start*stringFormat
date-timewindow_end*stringFormat
date-timeattempts*integerFailed attempts so far.
objects_stored*integer|nullerror*string|nullcreated_at*stringFormat
date-timestarted_at*|Format
date-timefinished_at*|Format
date-timenext_attempt_at*|Format
date-timecurl -X GET 'http://localhost:8080/v1/users/497f6eca-6276-4993-bfeb-53cbbbba6f08/sync-runs/0' \ -H 'Authorization: Bearer ohs_sk_...'{ "id": 0, "provider": "string", "trigger": "backfill", "status": "queued", "data_type": "string", "window_start": "2019-08-24T14:15:22Z", "window_end": "2019-08-24T14:15:22Z", "attempts": 0, "objects_stored": 0, "error": "string", "created_at": "2019-08-24T14:15:22Z", "started_at": "2019-08-24T14:15:22Z", "finished_at": "2019-08-24T14:15:22Z", "next_attempt_at": "2019-08-24T14:15:22Z"}