Sleep
Sleep Cycle
Meal
Workouts
Profile
Activity
Body
Menstrual Cycle
Electrocardiogram
Vitals Timeseries
Body Timeseries
Activity Timeseries
Workout Stream Timeseries
Wellness Timeseries
Diary Timeseries
Nutrition Timeseries
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,
"id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"low": 6400,
"medium": 6400,
"source": {
"device_id": "550e8400-e29b-41d4-a716-446655440000",
"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"
}
]
}Summary
Get activity summary for 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,
"id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"low": 6400,
"medium": 6400,
"source": {
"device_id": "550e8400-e29b-41d4-a716-446655440000",
"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 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 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 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
Successful Response
Show child attributes
Show child attributes
User id returned by vital create user request. This id should be stored in your database against the user and used for all interactions with the vital api.
Date of the specified record, formatted as ISO8601 datetime string in UTC 00:00. Deprecated in favour of calendar_date.
Date of the summary in the YYYY-mm-dd format.
Source the data has come from.
Show child attributes
Show child attributes
Provider slug. e.g., oura, fitbit, garmin.
The type of the data source (app or device) by which the summary or the timeseries data were recorded. This defaults to unknown when Vital cannot extract or infer that information
The identifier of the app which recorded this summary. This is only applicable to multi-source providers like Apple Health and Android Health Connect.
The identifier of the device which recorded this summary.
For workout stream timeseries, this is the standard sport slug of the workout with which the timeseries data are associated.
For the distance timeseries, this is wheelchair_pushing if the user is a wheelchair user, or null otherwise.
For all summary types and non-workout timeseries, this is always null.
For workout stream timeseries, this is the workout ID with which the timeseries data are associated.
For all other types, this is always null.
Deprecated. Subject to removal after 1 Jan 2024.
Deprecated. Use provider instead. Subject to removal after 1 Jan 2024.
Deprecated. Subject to removal after 1 Jan 2024.
{ "provider": "oura", "type": "ring" }Total energy consumption during the day including Basal Metabolic Rate in kilocalories::kilocalories
Energy consumption caused by the physical activity of the day in kilocalories::kilocalories
Total number of steps registered during the day::steps
Deprecated. Daily physical activity as equal meters i.e. amount of walking needed to get the same amount of activity::meters
Distance traveled during activities throughout the day::meters
Number of minutes during the day with low intensity activity (e.g. household work)::minutes
Number of minutes during the day with medium intensity activity (e.g. walking)::minutes
Number of minutes during the day with high intensity activity (e.g. running)::minutes
Number of floors climbed by the user::count
The IANA time zone identifier. Example: 'Europe/London'.
Timezone offset from UTC as seconds. For example, EEST (Eastern European Summer Time, +3h) is 10800. PST (Pacific Standard Time, -8h) is -28800::seconds
Heart rate daily summary.
Show child attributes
Show child attributes
Average heart rate::bpm
Minimum heart rate::bpm
Maximum heart rate::bpm
Resting heart rate::bpm
{
"avg_bpm": 80,
"avg_walking_bpm": 70,
"max_bpm": 100,
"min_bpm": 60,
"resting_bpm": 60
}Was this page helpful?