From 94fe39d91f6d1c1ff37205a8d6966671fd969e68 Mon Sep 17 00:00:00 2001 From: "mintlify[bot]" <109931778+mintlify[bot]@users.noreply.github.com> Date: Fri, 24 Apr 2026 22:36:39 +0000 Subject: [PATCH] Add SEO descriptions to timeseries API reference pages Generated-By: mintlify-agent --- docs/api-reference/data/timeseries/afib-burden.mdx | 1 + docs/api-reference/data/timeseries/basal-body-temperature.mdx | 1 + docs/api-reference/data/timeseries/blood-oxygen.mdx | 1 + docs/api-reference/data/timeseries/blood-pressure.mdx | 1 + docs/api-reference/data/timeseries/body-fat.mdx | 1 + docs/api-reference/data/timeseries/body-mass-index.mdx | 1 + docs/api-reference/data/timeseries/body-temperature-delta.mdx | 1 + docs/api-reference/data/timeseries/body-temperature.mdx | 1 + docs/api-reference/data/timeseries/body-weight.mdx | 1 + docs/api-reference/data/timeseries/caffeine.mdx | 1 + docs/api-reference/data/timeseries/calories-active.mdx | 1 + docs/api-reference/data/timeseries/calories-basal.mdx | 1 + docs/api-reference/data/timeseries/carbohydrates.mdx | 1 + docs/api-reference/data/timeseries/cholesterol.mdx | 1 + docs/api-reference/data/timeseries/daylight-exposure.mdx | 1 + docs/api-reference/data/timeseries/distance.mdx | 1 + docs/api-reference/data/timeseries/electrocardiogram-voltage.mdx | 1 + docs/api-reference/data/timeseries/fall.mdx | 1 + docs/api-reference/data/timeseries/floors-climbed.mdx | 1 + .../api-reference/data/timeseries/forced-expiratory-volume-1.mdx | 1 + docs/api-reference/data/timeseries/forced-vital-capacity.mdx | 1 + docs/api-reference/data/timeseries/glucose.mdx | 1 + docs/api-reference/data/timeseries/handwashing.mdx | 1 + docs/api-reference/data/timeseries/heart-rate-alert.mdx | 1 + .../data/timeseries/heart-rate-recovery-one-minute.mdx | 1 + docs/api-reference/data/timeseries/heartrate.mdx | 1 + docs/api-reference/data/timeseries/hrv.mdx | 1 + docs/api-reference/data/timeseries/hypnogram.mdx | 1 + docs/api-reference/data/timeseries/ige.mdx | 1 + docs/api-reference/data/timeseries/igg.mdx | 1 + docs/api-reference/data/timeseries/inhaler-usage.mdx | 1 + docs/api-reference/data/timeseries/insulin-injection.mdx | 1 + docs/api-reference/data/timeseries/lean-body-mass.mdx | 1 + docs/api-reference/data/timeseries/mindfulness-minutes.mdx | 1 + docs/api-reference/data/timeseries/note.mdx | 1 + docs/api-reference/data/timeseries/peak-expiratory-flow-rate.mdx | 1 + docs/api-reference/data/timeseries/respiratory-rate.mdx | 1 + docs/api-reference/data/timeseries/sleep-apnea-alert.mdx | 1 + .../data/timeseries/sleep-breathing-disturbance.mdx | 1 + docs/api-reference/data/timeseries/stand-duration.mdx | 1 + docs/api-reference/data/timeseries/stand-hour.mdx | 1 + docs/api-reference/data/timeseries/steps.mdx | 1 + docs/api-reference/data/timeseries/stress-level.mdx | 1 + docs/api-reference/data/timeseries/uv-exposure.mdx | 1 + docs/api-reference/data/timeseries/vo2-max.mdx | 1 + docs/api-reference/data/timeseries/waist-circumference.mdx | 1 + docs/api-reference/data/timeseries/water.mdx | 1 + docs/api-reference/data/timeseries/wheelchair-push.mdx | 1 + docs/api-reference/data/timeseries/workout-distance.mdx | 1 + docs/api-reference/data/timeseries/workout-duration.mdx | 1 + docs/api-reference/data/timeseries/workout-swimming-stroke.mdx | 1 + 51 files changed, 51 insertions(+) diff --git a/docs/api-reference/data/timeseries/afib-burden.mdx b/docs/api-reference/data/timeseries/afib-burden.mdx index 1090174e2..368a2b178 100644 --- 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 grouped atrial fibrillation (AFib) burden timeseries data for a user, showing the percentage of time the heart was in AFib." 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 index 5785c0f7f..63fa89c43 100644 --- 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 grouped basal body temperature timeseries data for a user, typically measured at rest and used to track reproductive cycles." 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 index eaab46786..5bc435b0a 100644 --- 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 grouped blood oxygen saturation (SpO2) timeseries data for a user, showing the percentage of oxygen carried in the blood." 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 index 7abf4623d..b9bfd4db1 100644 --- 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 grouped blood pressure timeseries data for a user, including systolic and diastolic measurements from connected wearables or devices." 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 index f179980f9..a8b1ab44c 100644 --- 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 grouped body fat percentage timeseries data for a user, sourced from connected smart scales or health tracking devices." 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 index 6e7c59975..5b1610460 100644 --- 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 grouped body mass index (BMI) timeseries data for a user, calculated from height and weight measurements over time." 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 index 09bfead70..2d7fe75a4 100644 --- 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 grouped body temperature delta timeseries data for a user, showing deviations from a personalized baseline temperature." 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 index ce08f4def..350dd25a7 100644 --- 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 grouped body temperature timeseries data for a user, measured in degrees Celsius or Fahrenheit from connected devices." 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 index 562de1373..198a43b72 100644 --- 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 grouped body weight timeseries data for a user, sourced from connected smart scales, wearables, or manual entries." 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 index 1ac0c9c15..d01eda3cf 100644 --- a/docs/api-reference/data/timeseries/caffeine.mdx +++ b/docs/api-reference/data/timeseries/caffeine.mdx @@ -1,5 +1,6 @@ --- title: "Caffeine" +description: "Retrieve grouped caffeine intake timeseries data for a user, measured in milligrams and sourced from tracking apps or manual logs." 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 index b1350648e..674e620eb 100644 --- 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 grouped active calories timeseries data for a user, representing energy burned through movement and physical activity." 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 index 296b3902a..3da27179e 100644 --- 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 grouped basal calories timeseries data for a user, representing the baseline energy burned at rest to maintain vital functions." 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 index 481ebaea5..452625f91 100644 --- a/docs/api-reference/data/timeseries/carbohydrates.mdx +++ b/docs/api-reference/data/timeseries/carbohydrates.mdx @@ -1,5 +1,6 @@ --- title: "Carbohydrates" +description: "Retrieve grouped carbohydrate intake timeseries data for a user, measured in grams and sourced from connected nutrition and tracking apps." 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 index 8264d78a1..de6ace182 100644 --- a/docs/api-reference/data/timeseries/cholesterol.mdx +++ b/docs/api-reference/data/timeseries/cholesterol.mdx @@ -1,5 +1,6 @@ --- title: "Cholesterol" +description: "Retrieve grouped cholesterol timeseries data for a user, including total, LDL, and HDL measurements from lab results or health devices." 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 index 66dbcda8c..89eb3fa80 100644 --- 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 grouped daylight exposure timeseries data for a user, measuring the duration spent in outdoor light from Apple Health or similar." 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 index 4c9de296d..4a341d958 100644 --- a/docs/api-reference/data/timeseries/distance.mdx +++ b/docs/api-reference/data/timeseries/distance.mdx @@ -1,5 +1,6 @@ --- title: "Distance" +description: "Retrieve grouped distance timeseries data for a user, measured in meters from connected wearables, fitness trackers, or smartphones." 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 index a9d5b87f5..39077fb26 100644 --- 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 grouped electrocardiogram (ECG) voltage timeseries data for a user, capturing high-frequency heart electrical activity readings." 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 index 0dcde1922..f3c05af67 100644 --- a/docs/api-reference/data/timeseries/fall.mdx +++ b/docs/api-reference/data/timeseries/fall.mdx @@ -1,5 +1,6 @@ --- title: "Fall" +description: "Retrieve grouped fall event timeseries data for a user, detected by supported wearables such as Apple Watch fall detection." 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 index f5266f874..3c0d86605 100644 --- 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 grouped floors-climbed timeseries data for a user, tracking vertical ascents recorded by connected wearables and phones." 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 index bc5f4544c..fe40715c2 100644 --- 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 grouped forced expiratory volume in one second (FEV1) timeseries data for a user, used for respiratory health tracking." 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 index 2651150df..a9b764b3d 100644 --- 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 grouped forced vital capacity (FVC) timeseries data for a user, measuring the total air exhaled in a forced breath test." 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 index 97b1e8283..d0afd2f54 100644 --- a/docs/api-reference/data/timeseries/glucose.mdx +++ b/docs/api-reference/data/timeseries/glucose.mdx @@ -1,5 +1,6 @@ --- title: "Glucose" +description: "Retrieve grouped blood glucose timeseries data for a user, measured in mg/dL from continuous glucose monitors or manual readings." 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 index 27831bda3..98b31d8da 100644 --- a/docs/api-reference/data/timeseries/handwashing.mdx +++ b/docs/api-reference/data/timeseries/handwashing.mdx @@ -1,5 +1,6 @@ --- title: "Handwashing" +description: "Retrieve grouped handwashing event timeseries data for a user, detected by Apple Watch and similar wearables." 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 index 2a0a495a1..35b839d31 100644 --- 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 grouped heart rate alert timeseries data for a user, such as high, low, or irregular heart rate notifications from wearables." 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 index faeb40732..95f28a57c 100644 --- 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 grouped one-minute heart rate recovery timeseries data for a user, measuring how quickly heart rate drops after exercise." 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 index 0359f2718..f0af29570 100644 --- 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 grouped heart rate timeseries data for a user, measured in beats per minute from connected wearables and health devices." 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 index fdd14d150..7a9c35882 100644 --- 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 grouped heart rate variability (HRV) timeseries data for a user, measured in milliseconds from wearables like Oura or Whoop." 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 index 4b6f9d6fa..d71587e23 100644 --- a/docs/api-reference/data/timeseries/hypnogram.mdx +++ b/docs/api-reference/data/timeseries/hypnogram.mdx @@ -1,5 +1,6 @@ --- title: "Hypnogram" +description: "Retrieve grouped hypnogram timeseries data for a user, showing sleep stage transitions (awake, light, deep, REM) over time." 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 index bbad9e60a..973da838d 100644 --- a/docs/api-reference/data/timeseries/ige.mdx +++ b/docs/api-reference/data/timeseries/ige.mdx @@ -1,5 +1,6 @@ --- title: "Ige" +description: "Retrieve grouped immunoglobulin E (IgE) timeseries data for a user, used to track allergy-related antibody levels from lab results." 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 index 68c97f8e9..fe15904a3 100644 --- a/docs/api-reference/data/timeseries/igg.mdx +++ b/docs/api-reference/data/timeseries/igg.mdx @@ -1,5 +1,6 @@ --- title: "Igg" +description: "Retrieve grouped immunoglobulin G (IgG) timeseries data for a user, used to track antibody levels from lab results and health records." 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 index 27ad8d465..4f8522efb 100644 --- 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 grouped inhaler usage event timeseries data for a user, useful for tracking asthma or respiratory medication adherence." 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 index 090f0c01c..e3963a592 100644 --- 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 grouped insulin injection event timeseries data for a user, logged from connected diabetes-management apps or devices." 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 index 44e83ee05..2a248f232 100644 --- 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 grouped lean body mass timeseries data for a user, sourced from smart scales and body composition tracking devices." 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 index 8d2435af2..1a47d38c8 100644 --- 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 grouped mindfulness minutes timeseries data for a user, tracking time spent in meditation or mindful breathing sessions." 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 index a35c3c57d..8e5db9631 100644 --- a/docs/api-reference/data/timeseries/note.mdx +++ b/docs/api-reference/data/timeseries/note.mdx @@ -1,5 +1,6 @@ --- title: "Note" +description: "Retrieve grouped health-related note timeseries data for a user, capturing freeform annotations logged from Apple Health or similar apps." 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 index 1d4279079..3285cdbb2 100644 --- 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 grouped peak expiratory flow rate timeseries data for a user, a respiratory metric useful for monitoring asthma and lung function." 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 index bf6d79043..65988fa93 100644 --- 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 grouped respiratory rate timeseries data for a user, measured in breaths per minute from wearables and health devices." 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 index aa05a0337..ccdc327f9 100644 --- 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 grouped sleep apnea alert timeseries data for a user, flagging possible breathing disturbances detected during sleep." 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 index b856fd1ff..45e77db89 100644 --- 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 grouped sleep breathing disturbance timeseries data for a user, indicating irregular breathing patterns during sleep." 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 index 1cb7f37bf..a1cbccadc 100644 --- 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 grouped stand duration timeseries data for a user, measuring the total time spent standing as recorded by Apple Watch and similar." 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 index 1a3d8c6af..9e4a11d98 100644 --- 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 grouped stand-hour timeseries data for a user, counting hours in which the user stood and moved for at least one minute." 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 index 09d1be3a2..86c640141 100644 --- a/docs/api-reference/data/timeseries/steps.mdx +++ b/docs/api-reference/data/timeseries/steps.mdx @@ -1,5 +1,6 @@ --- title: "Steps" +description: "Retrieve grouped step count timeseries data for a user, aggregated from connected wearables, fitness trackers, and smartphones." 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 index 369ba2d45..60a65f551 100644 --- 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 grouped stress level timeseries data for a user, typically derived from heart rate variability by connected wearables." 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 index f84914b62..924306c60 100644 --- 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 grouped UV exposure timeseries data for a user, measuring ultraviolet radiation exposure recorded by wearables and phones." 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 index 20df86943..717dab63a 100644 --- 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 grouped VO2 max timeseries data for a user, indicating aerobic fitness level as estimated by wearables and fitness trackers." 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 index d5570319e..e86c4fd27 100644 --- 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 grouped waist circumference timeseries data for a user, sourced from manual entries or connected body measurement devices." 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 index 66e298f35..cb097dbbc 100644 --- a/docs/api-reference/data/timeseries/water.mdx +++ b/docs/api-reference/data/timeseries/water.mdx @@ -1,5 +1,6 @@ --- title: "Water" +description: "Retrieve grouped water intake timeseries data for a user, measured in milliliters and sourced from hydration and nutrition tracking apps." 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 index bef27881b..e2e8c4092 100644 --- 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 grouped wheelchair push timeseries data for a user, tracking pushes recorded by Apple Watch accessibility features." 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 index d7be9faea..27a9d0e45 100644 --- 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 grouped workout distance timeseries data for a user, capturing per-workout distance values from connected fitness trackers." 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 index b43ca507e..1fa6f5903 100644 --- 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 grouped workout duration timeseries data for a user, capturing the length of exercise sessions from connected wearables." 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 index 88df51413..d51cc8ef0 100644 --- 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 grouped swimming stroke count timeseries data for a user, recorded during swim workouts by supported wearables." openapi: "GET /v2/timeseries/{user_id}/workout_swimming_stroke/grouped" ---