- Home
- Wearables
- Lab Testing
- API Reference
- Event Catalog
- Changelog
Users
Introspection
Orders
At-home Phlebotomy
Tests
Results
Health Insurance
Vitals
Body
Activity
Wellness
Nutrition
Core
Lab Testing
Timeseries Data
Summary
Get Daily Activity for user_id
API key based authentication
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
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": "2022-08-04",
"calories_total": 100,
"calories_active": 2000,
"steps": 10000,
"daily_movement": 200,
"low": 6400,
"medium": 6400,
"high": 6000,
"source": {
"name": "Garmin",
"slug": "garmin",
"logo": "https://logo_url.com"
},
"user_id": "70c64d5a-ff06-4c16-b137-361b2441d86e",
"heart_rate": {
"avg_bpm": 76.4,
"max_bpm": 134,
"min_bpm": 55,
"resting_bpm": 60
}
}
]
}
Authorizations
API key based authentication
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
Date of the summary in the YYYY-mm-dd format.
Energy consumption caused by the physical activity of the day in kilocalories::kilocalories
Total energy consumption during the day including Basal Metabolic Rate in kilocalories::kilocalories
Deprecated. Daily physical activity as equal meters i.e. amount of walking needed to get the same amount of activity::meters
Date of the specified record, formatted as ISO8601 datetime string in UTC 00:00. Deprecated in favour of calendar_date.
Distance traveled during activities throughout the day::meters
Number of floors climbed by the user::count
Heart rate daily summary.
Average heart rate::bpm
Maximum heart rate::bpm
Minimum heart rate::bpm
Resting heart rate::bpm
Number of minutes during the day with high intensity activity (e.g. running)::minutes
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
Source the data has come from.
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. Subject to removal after 1 Jan 2024.
Provider slug. e.g., oura
, fitbit
, garmin
.
Deprecated. Use provider
instead. Subject to removal after 1 Jan 2024.
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
Total number of steps registered during the day::steps
[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
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.
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": "2022-08-04",
"calories_total": 100,
"calories_active": 2000,
"steps": 10000,
"daily_movement": 200,
"low": 6400,
"medium": 6400,
"high": 6000,
"source": {
"name": "Garmin",
"slug": "garmin",
"logo": "https://logo_url.com"
},
"user_id": "70c64d5a-ff06-4c16-b137-361b2441d86e",
"heart_rate": {
"avg_bpm": 76.4,
"max_bpm": 134,
"min_bpm": 55,
"resting_bpm": 60
}
}
]
}