tryVital · mintlify · Apr 29, 2026
diff --git a/docs/api-reference/data/timeseries/afib-burden.mdx b/docs/api-reference/data/timeseries/afib-burden.mdx
@@ -1,5 +1,6 @@
 ---
 title: "Afib Burden"
+description: "Retrieve atrial fibrillation burden time-series data for a specific user from their connected wearable provider."
 openapi: "GET /v2/timeseries/{user_id}/afib_burden/grouped"
 ---
 

diff --git a/docs/api-reference/data/timeseries/basal-body-temperature.mdx b/docs/api-reference/data/timeseries/basal-body-temperature.mdx
@@ -1,5 +1,6 @@
 ---
 title: "Basal Body Temperature"
+description: "Retrieve basal body temperature time-series data for a specific user from their connected wearable provider."
 openapi: "GET /v2/timeseries/{user_id}/basal_body_temperature/grouped"
 ---
 

diff --git a/docs/api-reference/data/timeseries/blood-oxygen.mdx b/docs/api-reference/data/timeseries/blood-oxygen.mdx
@@ -1,5 +1,6 @@
 ---
 title: "Blood Oxygen"
+description: "Retrieve blood oxygen saturation (SpO2) time-series data for a specific user from their connected wearable provider."
 openapi: "GET /v2/timeseries/{user_id}/blood_oxygen/grouped"
 ---
 

diff --git a/docs/api-reference/data/timeseries/blood-pressure.mdx b/docs/api-reference/data/timeseries/blood-pressure.mdx
@@ -1,5 +1,6 @@
 ---
 title: "Blood Pressure"
+description: "Retrieve systolic and diastolic blood pressure time-series readings for a specific user from their connected provider."
 openapi: "GET /v2/timeseries/{user_id}/blood_pressure/grouped"
 ---
 

diff --git a/docs/api-reference/data/timeseries/body-fat.mdx b/docs/api-reference/data/timeseries/body-fat.mdx
@@ -1,5 +1,6 @@
 ---
 title: "Body Fat"
+description: "Retrieve body fat percentage time-series measurements for a specific user from their connected wearable provider."
 openapi: "GET /v2/timeseries/{user_id}/body_fat/grouped"
 ---
 

diff --git a/docs/api-reference/data/timeseries/body-mass-index.mdx b/docs/api-reference/data/timeseries/body-mass-index.mdx
@@ -1,5 +1,6 @@
 ---
 title: "Body Mass Index"
+description: "Retrieve body mass index (BMI) time-series measurements for a specific user from their connected wearable provider."
 openapi: "GET /v2/timeseries/{user_id}/body_mass_index/grouped"
 ---
 

diff --git a/docs/api-reference/data/timeseries/body-temperature-delta.mdx b/docs/api-reference/data/timeseries/body-temperature-delta.mdx
@@ -1,5 +1,6 @@
 ---
 title: "Body Temperature Delta"
+description: "Retrieve body temperature deviation time-series data for a specific user from their connected wearable provider."
 openapi: "GET /v2/timeseries/{user_id}/body_temperature_delta/grouped"
 ---
 

diff --git a/docs/api-reference/data/timeseries/body-temperature.mdx b/docs/api-reference/data/timeseries/body-temperature.mdx
@@ -1,5 +1,6 @@
 ---
 title: "Body Temperature"
+description: "Retrieve body temperature time-series readings for a specific user from their connected wearable provider."
 openapi: "GET /v2/timeseries/{user_id}/body_temperature/grouped"
 ---
 

diff --git a/docs/api-reference/data/timeseries/body-weight.mdx b/docs/api-reference/data/timeseries/body-weight.mdx
@@ -1,5 +1,6 @@
 ---
 title: "Body Weight"
+description: "Retrieve body weight time-series measurements for a specific user from their connected wearable provider."
 openapi: "GET /v2/timeseries/{user_id}/body_weight/grouped"
 ---
 

diff --git a/docs/api-reference/data/timeseries/caffeine.mdx b/docs/api-reference/data/timeseries/caffeine.mdx
@@ -1,5 +1,6 @@
 ---
 title: "Caffeine"
+description: "Retrieve caffeine intake time-series records for a specific user from their connected nutrition tracking provider."
 openapi: "GET /v2/timeseries/{user_id}/caffeine/grouped"
 ---
 

diff --git a/docs/api-reference/data/timeseries/calories-active.mdx b/docs/api-reference/data/timeseries/calories-active.mdx
@@ -1,5 +1,6 @@
 ---
 title: "Calories Active"
+description: "Retrieve active calorie burn time-series data for a specific user from their connected wearable provider."
 openapi: "GET /v2/timeseries/{user_id}/calories_active/grouped"
 ---
 

diff --git a/docs/api-reference/data/timeseries/calories-basal.mdx b/docs/api-reference/data/timeseries/calories-basal.mdx
@@ -1,5 +1,6 @@
 ---
 title: "Calories Basal"
+description: "Retrieve basal calorie burn time-series data for a specific user from their connected wearable provider."
 openapi: "GET /v2/timeseries/{user_id}/calories_basal/grouped"
 ---
 

diff --git a/docs/api-reference/data/timeseries/carbohydrates.mdx b/docs/api-reference/data/timeseries/carbohydrates.mdx
@@ -1,5 +1,6 @@
 ---
 title: "Carbohydrates"
+description: "Retrieve carbohydrate intake time-series records for a specific user from their connected nutrition tracking provider."
 openapi: "GET /v2/timeseries/{user_id}/carbohydrates/grouped"
 ---
 

diff --git a/docs/api-reference/data/timeseries/cholesterol.mdx b/docs/api-reference/data/timeseries/cholesterol.mdx
@@ -1,5 +1,6 @@
 ---
 title: "Cholesterol"
+description: "Retrieve cholesterol time-series measurements for a specific user from their connected health provider."
 openapi: "GET /v2/timeseries/{user_id}/cholesterol/grouped"
 ---
 

diff --git a/docs/api-reference/data/timeseries/daylight-exposure.mdx b/docs/api-reference/data/timeseries/daylight-exposure.mdx
@@ -1,5 +1,6 @@
 ---
 title: "Daylight Exposure"
+description: "Retrieve daylight exposure time-series data for a specific user from their connected wearable provider."
 openapi: "GET /v2/timeseries/{user_id}/daylight_exposure/grouped"
 ---
 

diff --git a/docs/api-reference/data/timeseries/distance.mdx b/docs/api-reference/data/timeseries/distance.mdx
@@ -1,5 +1,6 @@
 ---
 title: "Distance"
+description: "Retrieve distance traveled time-series data for a specific user from their connected wearable provider."
 openapi: "GET /v2/timeseries/{user_id}/distance/grouped"
 ---
 

diff --git a/docs/api-reference/data/timeseries/electrocardiogram-voltage.mdx b/docs/api-reference/data/timeseries/electrocardiogram-voltage.mdx
@@ -1,5 +1,6 @@
 ---
 title: "Electrocardiogram Voltage"
+description: "Retrieve electrocardiogram voltage time-series samples for a specific user from their connected wearable provider."
 openapi: "GET /v2/timeseries/{user_id}/electrocardiogram_voltage/grouped"
 ---
 

diff --git a/docs/api-reference/data/timeseries/fall.mdx b/docs/api-reference/data/timeseries/fall.mdx
@@ -1,5 +1,6 @@
 ---
 title: "Fall"
+description: "Retrieve detected fall event time-series data for a specific user from their connected wearable provider."
 openapi: "GET /v2/timeseries/{user_id}/fall/grouped"
 ---
 

diff --git a/docs/api-reference/data/timeseries/floors-climbed.mdx b/docs/api-reference/data/timeseries/floors-climbed.mdx
@@ -1,5 +1,6 @@
 ---
 title: "Floors Climbed"
+description: "Retrieve floors climbed time-series data for a specific user from their connected wearable provider."
 openapi: "GET /v2/timeseries/{user_id}/floors_climbed/grouped"
 ---
 

diff --git a/docs/api-reference/data/timeseries/forced-expiratory-volume-1.mdx b/docs/api-reference/data/timeseries/forced-expiratory-volume-1.mdx
@@ -1,5 +1,6 @@
 ---
 title: "Forced Expiratory Volume 1"
+description: "Retrieve forced expiratory volume in one second (FEV1) time-series data for a specific user from their connected provider."
 openapi: "GET /v2/timeseries/{user_id}/forced_expiratory_volume_1/grouped"
 ---
 

diff --git a/docs/api-reference/data/timeseries/forced-vital-capacity.mdx b/docs/api-reference/data/timeseries/forced-vital-capacity.mdx
@@ -1,5 +1,6 @@
 ---
 title: "Forced Vital Capacity"
+description: "Retrieve forced vital capacity (FVC) lung function time-series data for a specific user from their connected provider."
 openapi: "GET /v2/timeseries/{user_id}/forced_vital_capacity/grouped"
 ---
 

diff --git a/docs/api-reference/data/timeseries/glucose.mdx b/docs/api-reference/data/timeseries/glucose.mdx
@@ -1,5 +1,6 @@
 ---
 title: "Glucose"
+description: "Retrieve blood glucose time-series readings for a specific user from their connected continuous glucose monitor or provider."
 openapi: "GET /v2/timeseries/{user_id}/glucose/grouped"
 ---
 

diff --git a/docs/api-reference/data/timeseries/handwashing.mdx b/docs/api-reference/data/timeseries/handwashing.mdx
@@ -1,5 +1,6 @@
 ---
 title: "Handwashing"
+description: "Retrieve handwashing event time-series data for a specific user from their connected wearable provider."
 openapi: "GET /v2/timeseries/{user_id}/handwashing/grouped"
 ---
 

diff --git a/docs/api-reference/data/timeseries/heart-rate-alert.mdx b/docs/api-reference/data/timeseries/heart-rate-alert.mdx
@@ -1,5 +1,6 @@
 ---
 title: "Heart Rate Alert"
+description: "Retrieve heart rate alert time-series events for a specific user from their connected wearable provider."
 openapi: "GET /v2/timeseries/{user_id}/heart_rate_alert/grouped"
 ---
 

diff --git a/docs/api-reference/data/timeseries/heart-rate-recovery-one-minute.mdx b/docs/api-reference/data/timeseries/heart-rate-recovery-one-minute.mdx
@@ -1,5 +1,6 @@
 ---
 title: "Heart Rate Recovery One Minute"
+description: "Retrieve one-minute post-exercise heart rate recovery measurements for a specific user from their connected wearable provider."
 openapi: "GET /v2/timeseries/{user_id}/heart_rate_recovery_one_minute/grouped"
 ---
 

diff --git a/docs/api-reference/data/timeseries/heartrate.mdx b/docs/api-reference/data/timeseries/heartrate.mdx
@@ -1,5 +1,6 @@
 ---
 title: "Heart Rate"
+description: "Retrieve heart rate time-series measurements for a specific user from their connected wearable provider."
 openapi: "GET /v2/timeseries/{user_id}/heartrate/grouped"
 ---
 

diff --git a/docs/api-reference/data/timeseries/hrv.mdx b/docs/api-reference/data/timeseries/hrv.mdx
@@ -1,5 +1,6 @@
 ---
 title: "Heart Rate Variability"
+description: "Retrieve heart rate variability (HRV) time-series measurements for a specific user from their connected wearable provider."
 openapi: "GET /v2/timeseries/{user_id}/hrv/grouped"
 ---
 

diff --git a/docs/api-reference/data/timeseries/hypnogram.mdx b/docs/api-reference/data/timeseries/hypnogram.mdx
@@ -1,5 +1,6 @@
 ---
 title: "Hypnogram"
+description: "Retrieve sleep stage hypnogram time-series data for a specific user from their connected sleep tracking provider."
 openapi: "GET /v2/timeseries/{user_id}/hypnogram/grouped"
 ---
 

diff --git a/docs/api-reference/data/timeseries/ige.mdx b/docs/api-reference/data/timeseries/ige.mdx
@@ -1,5 +1,6 @@
 ---
 title: "Ige"
+description: "Retrieve immunoglobulin E (IgE) time-series test results for a specific user from their connected health provider."
 openapi: "GET /v2/timeseries/{user_id}/ige/grouped"
 ---
 

diff --git a/docs/api-reference/data/timeseries/igg.mdx b/docs/api-reference/data/timeseries/igg.mdx
@@ -1,5 +1,6 @@
 ---
 title: "Igg"
+description: "Retrieve immunoglobulin G (IgG) time-series test results for a specific user from their connected health provider."
 openapi: "GET /v2/timeseries/{user_id}/igg/grouped"
 ---
 

diff --git a/docs/api-reference/data/timeseries/inhaler-usage.mdx b/docs/api-reference/data/timeseries/inhaler-usage.mdx
@@ -1,5 +1,6 @@
 ---
 title: "Inhaler Usage"
+description: "Retrieve inhaler usage time-series events for a specific user from their connected health tracking provider."
 openapi: "GET /v2/timeseries/{user_id}/inhaler_usage/grouped"
 ---
 

diff --git a/docs/api-reference/data/timeseries/insulin-injection.mdx b/docs/api-reference/data/timeseries/insulin-injection.mdx
@@ -1,5 +1,6 @@
 ---
 title: "Insulin Injection"
+description: "Retrieve insulin injection time-series records for a specific user from their connected health tracking provider."
 openapi: "GET /v2/timeseries/{user_id}/insulin_injection/grouped"
 ---
 

diff --git a/docs/api-reference/data/timeseries/lean-body-mass.mdx b/docs/api-reference/data/timeseries/lean-body-mass.mdx
@@ -1,5 +1,6 @@
 ---
 title: "Lean Body Mass"
+description: "Retrieve lean body mass time-series measurements for a specific user from their connected wearable provider."
 openapi: "GET /v2/timeseries/{user_id}/lean_body_mass/grouped"
 ---
 

diff --git a/docs/api-reference/data/timeseries/mindfulness-minutes.mdx b/docs/api-reference/data/timeseries/mindfulness-minutes.mdx
@@ -1,5 +1,6 @@
 ---
 title: "Mindfulness Minutes"
+description: "Retrieve logged mindfulness or meditation minute time-series data for a specific user from their connected provider."
 openapi: "GET /v2/timeseries/{user_id}/mindfulness_minutes/grouped"
 ---
 

diff --git a/docs/api-reference/data/timeseries/note.mdx b/docs/api-reference/data/timeseries/note.mdx
@@ -1,5 +1,6 @@
 ---
 title: "Note"
+description: "Retrieve user-logged health note time-series entries for a specific user from their connected health tracking provider."
 openapi: "GET /v2/timeseries/{user_id}/note/grouped"
 ---
 

diff --git a/docs/api-reference/data/timeseries/peak-expiratory-flow-rate.mdx b/docs/api-reference/data/timeseries/peak-expiratory-flow-rate.mdx
@@ -1,5 +1,6 @@
 ---
 title: "Peak Expiratory Flow Rate"
+description: "Retrieve peak expiratory flow rate time-series data for a specific user from their connected health provider."
 openapi: "GET /v2/timeseries/{user_id}/peak_expiratory_flow_rate/grouped"
 ---
 

diff --git a/docs/api-reference/data/timeseries/respiratory-rate.mdx b/docs/api-reference/data/timeseries/respiratory-rate.mdx
@@ -1,5 +1,6 @@
 ---
 title: "Respiratory Rate"
+description: "Retrieve respiratory rate time-series measurements for a specific user from their connected wearable provider."
 openapi: "GET /v2/timeseries/{user_id}/respiratory_rate/grouped"
 ---
 

diff --git a/docs/api-reference/data/timeseries/sleep-apnea-alert.mdx b/docs/api-reference/data/timeseries/sleep-apnea-alert.mdx
@@ -1,5 +1,6 @@
 ---
 title: "Sleep Apnea Alert"
+description: "Retrieve sleep apnea alert time-series events for a specific user from their connected wearable provider."
 openapi: "GET /v2/timeseries/{user_id}/sleep_apnea_alert/grouped"
 ---
 

diff --git a/docs/api-reference/data/timeseries/sleep-breathing-disturbance.mdx b/docs/api-reference/data/timeseries/sleep-breathing-disturbance.mdx
@@ -1,5 +1,6 @@
 ---
 title: "Sleep Breathing Disturbance"
+description: "Retrieve sleep breathing disturbance time-series measurements for a specific user from their connected wearable provider."
 openapi: "GET /v2/timeseries/{user_id}/sleep_breathing_disturbance/grouped"
 ---
 

diff --git a/docs/api-reference/data/timeseries/stand-duration.mdx b/docs/api-reference/data/timeseries/stand-duration.mdx
@@ -1,5 +1,6 @@
 ---
 title: "Stand Duration"
+description: "Retrieve time-spent-standing time-series data for a specific user from their connected wearable provider."
 openapi: "GET /v2/timeseries/{user_id}/stand_duration/grouped"
 ---
 

diff --git a/docs/api-reference/data/timeseries/stand-hour.mdx b/docs/api-reference/data/timeseries/stand-hour.mdx
@@ -1,5 +1,6 @@
 ---
 title: "Stand Hour"
+description: "Retrieve stand hour time-series records for a specific user from their connected wearable provider."
 openapi: "GET /v2/timeseries/{user_id}/stand_hour/grouped"
 ---
 

diff --git a/docs/api-reference/data/timeseries/steps.mdx b/docs/api-reference/data/timeseries/steps.mdx
@@ -1,5 +1,6 @@
 ---
 title: "Steps"
+description: "Retrieve step count time-series data for a specific user from their connected wearable provider."
 openapi: "GET /v2/timeseries/{user_id}/steps/grouped"
 ---
 

diff --git a/docs/api-reference/data/timeseries/stress-level.mdx b/docs/api-reference/data/timeseries/stress-level.mdx
@@ -1,5 +1,6 @@
 ---
 title: "Stress Level"
+description: "Retrieve stress level time-series measurements for a specific user from their connected wearable provider."
 openapi: "GET /v2/timeseries/{user_id}/stress_level/grouped"
 ---
 

diff --git a/docs/api-reference/data/timeseries/uv-exposure.mdx b/docs/api-reference/data/timeseries/uv-exposure.mdx
@@ -1,5 +1,6 @@
 ---
 title: "Uv Exposure"
+description: "Retrieve ultraviolet (UV) light exposure time-series data for a specific user from their connected wearable provider."
 openapi: "GET /v2/timeseries/{user_id}/uv_exposure/grouped"
 ---
 

diff --git a/docs/api-reference/data/timeseries/vo2-max.mdx b/docs/api-reference/data/timeseries/vo2-max.mdx
@@ -1,5 +1,6 @@
 ---
 title: "Vo2 Max"
+description: "Retrieve VO2 max cardiorespiratory fitness time-series measurements for a specific user from their connected wearable provider."
 openapi: "GET /v2/timeseries/{user_id}/vo2_max/grouped"
 ---
 

diff --git a/docs/api-reference/data/timeseries/waist-circumference.mdx b/docs/api-reference/data/timeseries/waist-circumference.mdx
@@ -1,5 +1,6 @@
 ---
 title: "Waist Circumference"
+description: "Retrieve waist circumference time-series measurements for a specific user from their connected health provider."
 openapi: "GET /v2/timeseries/{user_id}/waist_circumference/grouped"
 ---
 

diff --git a/docs/api-reference/data/timeseries/water.mdx b/docs/api-reference/data/timeseries/water.mdx
@@ -1,5 +1,6 @@
 ---
 title: "Water"
+description: "Retrieve water intake time-series records for a specific user from their connected nutrition tracking provider."
 openapi: "GET /v2/timeseries/{user_id}/water/grouped"
 ---
 

diff --git a/docs/api-reference/data/timeseries/wheelchair-push.mdx b/docs/api-reference/data/timeseries/wheelchair-push.mdx
@@ -1,5 +1,6 @@
 ---
 title: "Wheelchair Push"
+description: "Retrieve wheelchair push time-series data for a specific user from their connected wearable provider."
 openapi: "GET /v2/timeseries/{user_id}/wheelchair_push/grouped"
 ---
 

diff --git a/docs/api-reference/data/timeseries/workout-distance.mdx b/docs/api-reference/data/timeseries/workout-distance.mdx
@@ -1,5 +1,6 @@
 ---
 title: "Workout Distance"
+description: "Retrieve per-workout distance time-series samples for a specific user from their connected wearable provider."
 openapi: "GET /v2/timeseries/{user_id}/workout_distance/grouped"
 ---
 

diff --git a/docs/api-reference/data/timeseries/workout-duration.mdx b/docs/api-reference/data/timeseries/workout-duration.mdx
@@ -1,5 +1,6 @@
 ---
 title: "Workout Duration"
+description: "Retrieve per-workout duration time-series samples for a specific user from their connected wearable provider."
 openapi: "GET /v2/timeseries/{user_id}/workout_duration/grouped"
 ---
 

diff --git a/docs/api-reference/data/timeseries/workout-swimming-stroke.mdx b/docs/api-reference/data/timeseries/workout-swimming-stroke.mdx
@@ -1,5 +1,6 @@
 ---
 title: "Workout Swimming Stroke"
+description: "Retrieve swimming stroke time-series data captured during workouts for a specific user from their connected provider."
 openapi: "GET /v2/timeseries/{user_id}/workout_swimming_stroke/grouped"
 ---
 

diff --git a/docs/event-catalog/continuous_query.result_table.changed.mdx b/docs/event-catalog/continuous_query.result_table.changed.mdx
@@ -1,4 +1,5 @@
 ---
 title: continuous_query.result_table.changed
+description: "Webhook event fired when a continuous query's result table changes, signaling new aggregated rows are available to download."
 openapi-schema: ClientFacingContinuousQueryResultTableChanged
 ---
diff --git a/docs/event-catalog/daily.data.activity.created.mdx b/docs/event-catalog/daily.data.activity.created.mdx
@@ -1,4 +1,5 @@
 ---
 title: daily.data.activity.created
+description: "Webhook event fired when new daily activity summary data such as steps, calories, and distance are ingested for a user from a connected provider."
 openapi-schema: ClientFacingActivityChanged
 ---
diff --git a/docs/event-catalog/daily.data.activity.updated.mdx b/docs/event-catalog/daily.data.activity.updated.mdx
@@ -1,4 +1,5 @@
 ---
 title: daily.data.activity.updated
+description: "Webhook event fired when previously ingested daily activity summary data such as steps, calories, and distance are updated for a user."
 openapi-schema: ClientFacingActivityChanged
 ---
diff --git a/docs/event-catalog/daily.data.afib_burden.created.mdx b/docs/event-catalog/daily.data.afib_burden.created.mdx
@@ -1,4 +1,5 @@
 ---
 title: daily.data.afib_burden.created
+description: "Webhook event fired when new daily atrial fibrillation burden measurements are ingested for a user from a connected provider."
 openapi-schema: ClientFacingAfibBurdenChanged
 ---
diff --git a/docs/event-catalog/daily.data.afib_burden.updated.mdx b/docs/event-catalog/daily.data.afib_burden.updated.mdx
@@ -1,4 +1,5 @@
 ---
 title: daily.data.afib_burden.updated
+description: "Webhook event fired when previously ingested daily atrial fibrillation burden measurements are updated for a user."
 openapi-schema: ClientFacingAfibBurdenChanged
 ---
diff --git a/docs/event-catalog/daily.data.basal_body_temperature.created.mdx b/docs/event-catalog/daily.data.basal_body_temperature.created.mdx
@@ -1,4 +1,5 @@
 ---
 title: daily.data.basal_body_temperature.created
+description: "Webhook event fired when new daily basal body temperature readings are ingested for a user from a connected provider."
 openapi-schema: ClientFacingBasalBodyTemperatureChanged
 ---
diff --git a/docs/event-catalog/daily.data.basal_body_temperature.updated.mdx b/docs/event-catalog/daily.data.basal_body_temperature.updated.mdx
@@ -1,4 +1,5 @@
 ---
 title: daily.data.basal_body_temperature.updated
+description: "Webhook event fired when previously ingested daily basal body temperature readings are updated for a user."
 openapi-schema: ClientFacingBasalBodyTemperatureChanged
 ---