Sleep
Sleep Cycle
Meal
Workouts
Profile
Activity
Body
Menstrual Cycle
Electrocardiogram
Vitals Timeseries
- GETAfib Burden
- GETBlood Oxygen
- GETBlood Pressure
- GETCholesterol
- GETGlucose
- GETHeart Rate
- GETHeart Rate Variability
- GETHeart Rate Alert
- GETInsulin Injection
- GETIgg
- GETIge
- GETRespiratory Rate
- GETVo2 Max
- GETForced Expiratory Volume 1
- GETForced Vital Capacity
- GETPeak Expiratory Flow Rate
- GETInhaler Usage
- GETHeart Rate Recovery One Minute
Body Timeseries
Activity Timeseries
Workout Stream Timeseries
Wellness Timeseries
Diary Timeseries
Nutrition Timeseries
Activity
Summary
Get activity summary for user_id
GET
/
v2
/
summary
/
activity
/
{user_id}
curl --request GET \
--url {{BASE_URL}}/v2/summary/activity/{user_id}/raw \
--header 'Accept: application/json' \
--header 'x-vital-api-key: <API_KEY>'
{
"activity": [
{
"calendar_date": "2023-03-22",
"calories_active": 2000,
"calories_total": 100,
"created_at": "2023-02-27T20:31:24+00:00",
"daily_movement": 200,
"date": "2023-03-22T00:00:00+00:00",
"floors_climbed": 10,
"heart_rate": {
"avg_bpm": 80,
"avg_walking_bpm": 70,
"max_bpm": 100,
"min_bpm": 60,
"resting_bpm": 60
},
"high": 6000,
"low": 6400,
"medium": 6400,
"source": {
"logo": "https://logo_url.com",
"name": "Oura",
"slug": "oura"
},
"steps": 10000,
"time_zone": "Europe/London",
"timezone_offset": 3600,
"updated_at": "2023-02-28T01:22:38+00:00",
"user_id": "1449752e-0d8a-40e0-9206-91ab099b2537"
}
]
}
curl --request GET \
--url {{BASE_URL}}/v2/summary/activity/{user_id}/raw \
--header 'Accept: application/json' \
--header 'x-vital-api-key: <API_KEY>'
Authorizations
Vital Team API Key
Path Parameters
Query Parameters
Provider oura/strava etc
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
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
Successful Response
The response is of type object
.
curl --request GET \
--url {{BASE_URL}}/v2/summary/activity/{user_id}/raw \
--header 'Accept: application/json' \
--header 'x-vital-api-key: <API_KEY>'
{
"activity": [
{
"calendar_date": "2023-03-22",
"calories_active": 2000,
"calories_total": 100,
"created_at": "2023-02-27T20:31:24+00:00",
"daily_movement": 200,
"date": "2023-03-22T00:00:00+00:00",
"floors_climbed": 10,
"heart_rate": {
"avg_bpm": 80,
"avg_walking_bpm": 70,
"max_bpm": 100,
"min_bpm": 60,
"resting_bpm": 60
},
"high": 6000,
"low": 6400,
"medium": 6400,
"source": {
"logo": "https://logo_url.com",
"name": "Oura",
"slug": "oura"
},
"steps": 10000,
"time_zone": "Europe/London",
"timezone_offset": 3600,
"updated_at": "2023-02-28T01:22:38+00:00",
"user_id": "1449752e-0d8a-40e0-9206-91ab099b2537"
}
]
}