Releasesv0.1.0
Read data

ECG recordings, metadata only

GET
/v1/users/{id}/ecg

The user's ECG recordings (Apple Watch, Withings) by start time, then id, without their voltage samples: read one recording for those. classification is the label the recording device gave, in its maker's vocabulary, passed through as recorded: Open Health Sync does not compute or check it. start and end bound start_date. See docs/api.md.

Authorization

tenantKey
headerAuthorizationBearer <token>

Tenant API key, ohs_sk_ + 43 base62 characters.

Path Parameters

id*string
Formatuuid

Query Parameters

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 start_date.

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/ecg' \  -H 'Authorization: Bearer ohs_sk_...'
{  "next_cursor": "string",  "data": [    {      "provider": "string",      "source": "string",      "device": "string",      "ingested_at": "2019-08-24T14:15:22Z",      "id": 0,      "start_date": "2019-08-24T14:15:22Z",      "end_date": "2019-08-24T14:15:22Z",      "classification": "sinus_rhythm",      "classification_value": 0,      "symptoms_status": "string",      "average_heart_rate": 0,      "sampling_frequency_hz": 0,      "number_of_measurements": 0,      "metadata": {}    }  ]}
Edit on GitHub