GET
/
v2
/
timeseries
/
{user_id}
/
floors_climbed
curl --request GET \
     --url {{BASE_URL}}/v2/timeseries/{user_id}/floors_climbed?start_date={{START_DATE}}&end_date={{END_DATE}} \
     --header 'Accept: application/json' \
     --header 'x-vital-api-key: <API_KEY>'
[
  {
    "timestamp": "2022-04-20T13:02:01.123771+00:00",
    "timezone_offset": 3600,
    "value": 123,
    "type": null,
    "unit": "count"
  }
]

Authorizations

x-vital-api-key
string
headerrequired

API key based authentication

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

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

Deprecated

timestamp
string
required

The timestamp of the measurement.

timezone_offset
integer

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

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

unit
enum<string>
required

Measured in counts

Available options:
count
value
number
required

Number of floors climbed at the time or interval::count