Sleep
Sleep Cycle
Meal
Workouts
Profile
Activity
Body
Menstrual Cycle
Electrocardiogram
Vitals Timeseries
Activity Timeseries
Wellness Timeseries
Diary Timeseries
Nutrition Timeseries
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,
"daily_movement": 200,
"date": "2023-03-22T00:00:00+00:00",
"floors_climbed": 10,
"heart_rate": {
"avg_bpm": 80,
"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,
"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
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.
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.
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.
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
[DEPRECATED] The time zone full identifier for the data. 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
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,
"daily_movement": 200,
"date": "2023-03-22T00:00:00+00:00",
"floors_climbed": 10,
"heart_rate": {
"avg_bpm": 80,
"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,
"user_id": "1449752e-0d8a-40e0-9206-91ab099b2537"
}
]
}