Releasesv0.1.0
Read data

Heart rate variability derived from the RR intervals

GET
/v1/users/{id}/hrv

One record per heartbeat series: the time domain HRV measures (RMSSD, SDNN, pNN50) and the mean RR interval and heart rate, computed from the stored intervals after implausible and ectopic intervals are set aside. Ordered by the series' first beat, then provider and series id. A series is in [start, end) when its first beat is, and is always summarized whole. See docs/hrv.md for the rules.

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 the series' first beat.

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/hrv' \  -H 'Authorization: Bearer ohs_sk_...'
{  "next_cursor": "string",  "data": [    {      "series_id": "string",      "provider": "string",      "start_date": "2019-08-24T14:15:22Z",      "end_date": "2019-08-24T14:15:22Z",      "intervals": 0,      "accepted_intervals": 0,      "successive_pairs": 0,      "mean_rr_ms": 0,      "mean_heart_rate_bpm": 0,      "sdnn_ms": 0,      "rmssd_ms": 0,      "pnn50_percent": 0    }  ]}
Edit on GitHub