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
Workouts
Summary
Get workout summary for user_id
GET
/
v2
/
summary
/
workouts
/
{user_id}
curl --request GET \
--url {{BASE_URL}}/v2/summary/workouts/{user_id} \
--header 'Accept: application/json' \
--header 'x-vital-api-key: <API_KEY>'
{
"workouts": [
{
"average_hr": 100,
"average_speed": 4.2,
"average_watts": 100,
"calendar_date": "2023-02-27",
"calories": 300,
"created_at": "2023-02-27T20:31:24+00:00",
"device_watts": 80,
"distance": 1700,
"elev_high": 20.2,
"elev_low": -10.2,
"hr_zones": [
100,
90,
10,
10,
200
],
"id": "185d0f34-dfc0-429f-84f9-b24030914bdd",
"map": {
"summary_polyline": "agn~Ftb{uOvr@daBunBjdBkHwiD????~Ngn@ha@_N~Ql`@"
},
"max_hr": 190,
"max_speed": 7.8,
"max_watts": 200,
"moving_time": 100,
"source": {
"provider": "strava",
"type": "unknown"
},
"sport": {
"id": 1,
"name": "football"
},
"time_end": "2023-02-27T12:31:24+00:00",
"time_start": "2023-02-27T11:31:24+00:00",
"total_elevation_gain": 10,
"updated_at": "2023-02-28T01:22:38+00:00",
"user_id": "1449752e-0d8a-40e0-9206-91ab099b2537",
"weighted_average_watts": 250
}
]
}
curl --request GET \
--url {{BASE_URL}}/v2/summary/workouts/{user_id} \
--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/workouts/{user_id} \
--header 'Accept: application/json' \
--header 'x-vital-api-key: <API_KEY>'
{
"workouts": [
{
"average_hr": 100,
"average_speed": 4.2,
"average_watts": 100,
"calendar_date": "2023-02-27",
"calories": 300,
"created_at": "2023-02-27T20:31:24+00:00",
"device_watts": 80,
"distance": 1700,
"elev_high": 20.2,
"elev_low": -10.2,
"hr_zones": [
100,
90,
10,
10,
200
],
"id": "185d0f34-dfc0-429f-84f9-b24030914bdd",
"map": {
"summary_polyline": "agn~Ftb{uOvr@daBunBjdBkHwiD????~Ngn@ha@_N~Ql`@"
},
"max_hr": 190,
"max_speed": 7.8,
"max_watts": 200,
"moving_time": 100,
"source": {
"provider": "strava",
"type": "unknown"
},
"sport": {
"id": 1,
"name": "football"
},
"time_end": "2023-02-27T12:31:24+00:00",
"time_start": "2023-02-27T11:31:24+00:00",
"total_elevation_gain": 10,
"updated_at": "2023-02-28T01:22:38+00:00",
"user_id": "1449752e-0d8a-40e0-9206-91ab099b2537",
"weighted_average_watts": 250
}
]
}