Open Health Sync
Releasesv0.1.0
Api referenceEndpointsAdmin

How up to date each of the user's sources is (instance admin, one tenant)

GET
/v1/admin/tenants/{tenant_id}/users/{id}/freshness

GET /v1/users/{id}/freshness (getFreshness) for the tenant of tenant_id, read with an instance admin key: the same parameters and the same answer as the tenant's own key gets. Read only. Recorded in the caller's audit log and, actor admin, in the tenant's. See docs/admin-api.md.

Authorization

tenantKey
headerAuthorizationBearer <token>

Tenant API key, ohs_sk_ + 43 base62 characters.

Path Parameters

tenant_id*string

The id of a tenant; any other value is a 404.

Formatuuid
id*string
Formatuuid

Header Parameters

Authorization*string

The tenant API key, as a bearer secret.

Response Body

Freshness of every source.

application/json
  1. response
as_of*string
Formatdate-time
data*array<>
curl -X GET 'http://localhost:8080/v1/admin/tenants/497f6eca-6276-4993-bfeb-53cbbbba6f08/users/497f6eca-6276-4993-bfeb-53cbbbba6f08/freshness' \  -H 'Authorization: Bearer ohs_sk_...'
{  "as_of": "2019-08-24T14:15:22Z",  "data": [    {      "provider": "string",      "kind": "oauth",      "status": "active",      "state": "fresh",      "synced_through": "2019-08-24T14:15:22Z",      "lag_seconds": 0,      "last_sync_at": "2019-08-24T14:15:22Z",      "last_event_at": "2019-08-24T14:15:22Z",      "push_healthy": true,      "pull_every_seconds": 0,      "next_pull_at": "2019-08-24T14:15:22Z",      "last_attempt_at": "2019-08-24T14:15:22Z",      "last_error": "string",      "consecutive_failures": 0,      "health": {        "healthy": true,        "reason": "needs_reauth",        "action": "reconnect",        "since": "2019-08-24T14:15:22Z",        "retry_at": "2019-08-24T14:15:22Z"      }    }  ]}
Edit on GitHub