Releasesv0.1.0
Read data

Beat-to-beat (RR) intervals

GET
/v1/users/{id}/rr-intervals

The stored RR intervals of the user's heartbeat series, one per beat, by beat time (beats that share a time by an internal key the cursor carries). start and end bound the beat time. See docs/hrv.md.

Authorization

tenantKey
headerAuthorizationBearer <token>

Tenant API key, ohs_sk_ + 43 base62 characters.

Path Parameters

id*string
Formatuuid

Query Parameters

series_id?string

Keep one heartbeat series.

start?|

Inclusive lower bound, RFC 3339 or YYYY-MM-DD.

end?|

Exclusive upper bound, RFC 3339 or YYYY-MM-DD. Must not be before start.

cursor?string

The next_cursor of the previous page.

limit?integer
Range1 <= value <= 1000
Default100

Header Parameters

Authorization*string

The tenant API key, as a bearer secret.

Response Body

One page, by beat time.

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/rr-intervals' \  -H 'Authorization: Bearer ohs_sk_...'
{  "next_cursor": "string",  "data": [    {      "timestamp": "2019-08-24T14:15:22Z",      "rr_ms": 0,      "series_id": "string",      "provider": "string",      "ingested_at": "2019-08-24T14:15:22Z"    }  ]}
Edit on GitHub