Sleep
Sleep Cycle
Meal
Workouts
Profile
Activity
Body
Menstrual Cycle
Electrocardiogram
Vitals Timeseries
Activity Timeseries
Wellness Timeseries
Diary Timeseries
Nutrition Timeseries
Summary
Get Body summary for user_id
curl --request GET \
--url {{BASE_URL}}/v2/summary/body/{user_id} \
--header 'Accept: application/json' \
--header 'x-vital-api-key: <API_KEY>'
{
"body": [
{
"bone_mass_percentage": 4.3,
"calendar_date": "2023-02-27",
"date": "2023-02-27T12:31:24+00:00",
"fat": 30,
"height": 183,
"id": "8be1306e-01fc-46b1-b5d1-a9e39052db09",
"muscle_mass_percentage": 40.2,
"source": {
"logo": "https://logo_url.com",
"name": "Withings",
"slug": "withings"
},
"user_id": "1449752e-0d8a-40e0-9206-91ab099b2537",
"visceral_fat_index": 4.5,
"water_percentage": 55.4,
"weight": 80
}
]
}curl --request GET \
--url {{BASE_URL}}/v2/summary/body/{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
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 summarizes where a sample or a summary is sourced from. At minimum, the source provider is always included.
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.
Weight in kg::kg
Total body fat percentage::perc
Water percentage in the body::perc
Muscle mass percentage in the body::perc
Visceral fat index::scalar
Bone mass percentage in the body::perc
curl --request GET \
--url {{BASE_URL}}/v2/summary/body/{user_id} \
--header 'Accept: application/json' \
--header 'x-vital-api-key: <API_KEY>'
{
"body": [
{
"bone_mass_percentage": 4.3,
"calendar_date": "2023-02-27",
"date": "2023-02-27T12:31:24+00:00",
"fat": 30,
"height": 183,
"id": "8be1306e-01fc-46b1-b5d1-a9e39052db09",
"muscle_mass_percentage": 40.2,
"source": {
"logo": "https://logo_url.com",
"name": "Withings",
"slug": "withings"
},
"user_id": "1449752e-0d8a-40e0-9206-91ab099b2537",
"visceral_fat_index": 4.5,
"water_percentage": 55.4,
"weight": 80
}
]
}