Releasesv0.1.0
Connections

The user's sync history

GET
/v1/users/{id}/sync-runs

Every pull of the user's connections, newest first: what started it, its window, its status, the raw payloads it stored and the provider's error when it failed. Finished runs are kept 30 days.

Authorization

tenantKey
headerAuthorizationBearer <token>

Tenant API key, ohs_sk_ + 43 base62 characters.

Path Parameters

id*string
Formatuuid

Query Parameters

provider?string

Only this provider's runs.

limit?integer
Range1 <= value <= 100
Default50
cursor?string

The next_cursor of the previous page.

Header Parameters

Authorization*string

The tenant API key, as a bearer secret.

Response Body

A page of runs.

application/json
  1. response
data*array<>
next_cursor*|

Null on the last page.

curl -X GET 'http://localhost:8080/v1/users/497f6eca-6276-4993-bfeb-53cbbbba6f08/sync-runs' \  -H 'Authorization: Bearer ohs_sk_...'
{  "next_cursor": "string",  "data": [    {      "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"    }  ]}
Edit on GitHub