GET
/
v2
/
timeseries
/
{user_id}
/
hrv

Authorizations

x-vital-api-key
string
headerrequired

Vital Team API Key

Path Parameters

user_id
string
required

Query Parameters

provider
string
default:

Provider oura/strava etc

start_date
string
required

Date from in YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 00:00:00

end_date
string | null

Date to YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 23:59:59

Response

200 - application/json
id
integer | null

Deprecated

timezone_offset
integer | null

Time zone UTC offset in seconds. Positive offset indicates east of UTC; negative offset indicates west of UTC; and null indicates the time zone information is unavailable at source.

type
string | null

The reading type of the measurement. This is applicable only to Cholesterol, IGG, IGE and InsulinInjection.

unit
string
required

Measured in rmssd.

timestamp
string
required

The timestamp of the measurement.

value
number
required

HRV calculated using rmssd during sleep