Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion docs/api-reference/data/timeseries/afib-burden.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: "Afib Burden"
title: "AFib Burden"
openapi: "GET /v2/timeseries/{user_id}/afib_burden/grouped"
description: "Retrieve time-series atrial fibrillation burden percentages detected by wearable devices for a user from the Vital API."
---

<Card
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: "Basal Body Temperature"
openapi: "GET /v2/timeseries/{user_id}/basal_body_temperature/grouped"
description: "Retrieve time-series basal body temperature readings for a user from the Vital API."
---

<Card
Expand Down
1 change: 1 addition & 0 deletions docs/api-reference/data/timeseries/blood-oxygen.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: "Blood Oxygen"
openapi: "GET /v2/timeseries/{user_id}/blood_oxygen/grouped"
description: "Retrieve time-series blood oxygen saturation (SpO2) readings for a user from the Vital API."
---

<Card
Expand Down
1 change: 1 addition & 0 deletions docs/api-reference/data/timeseries/blood-pressure.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: "Blood Pressure"
openapi: "GET /v2/timeseries/{user_id}/blood_pressure/grouped"
description: "Retrieve time-series systolic and diastolic blood pressure readings for a user from the Vital API."
---

<Card
Expand Down
1 change: 1 addition & 0 deletions docs/api-reference/data/timeseries/body-fat.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: "Body Fat"
openapi: "GET /v2/timeseries/{user_id}/body_fat/grouped"
description: "Retrieve time-series body fat percentage readings for a user from the Vital API."
---

<Card
Expand Down
1 change: 1 addition & 0 deletions docs/api-reference/data/timeseries/body-mass-index.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: "Body Mass Index"
openapi: "GET /v2/timeseries/{user_id}/body_mass_index/grouped"
description: "Retrieve time-series body mass index (BMI) measurements for a user from the Vital API."
---

<Card
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: "Body Temperature Delta"
openapi: "GET /v2/timeseries/{user_id}/body_temperature_delta/grouped"
description: "Retrieve time-series body temperature deviation from baseline readings for a user from the Vital API."
---

<Card
Expand Down
1 change: 1 addition & 0 deletions docs/api-reference/data/timeseries/body-temperature.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: "Body Temperature"
openapi: "GET /v2/timeseries/{user_id}/body_temperature/grouped"
description: "Retrieve time-series core body temperature readings for a user from the Vital API."
---

<Card
Expand Down
1 change: 1 addition & 0 deletions docs/api-reference/data/timeseries/body-weight.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: "Body Weight"
openapi: "GET /v2/timeseries/{user_id}/body_weight/grouped"
description: "Retrieve time-series body weight measurements for a user from the Vital API."
---

<Card
Expand Down
1 change: 1 addition & 0 deletions docs/api-reference/data/timeseries/caffeine.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: "Caffeine"
openapi: "GET /v2/timeseries/{user_id}/caffeine/grouped"
description: "Retrieve time-series caffeine intake measurements for a user from the Vital API."
---

<Card
Expand Down
3 changes: 2 additions & 1 deletion docs/api-reference/data/timeseries/calories-active.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: "Calories Active"
title: "Active Calories"
openapi: "GET /v2/timeseries/{user_id}/calories_active/grouped"
description: "Retrieve time-series active calories burned through movement and exercise for a user from the Vital API."
---

<Card
Expand Down
3 changes: 2 additions & 1 deletion docs/api-reference/data/timeseries/calories-basal.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: "Calories Basal"
title: "Basal Calories"
openapi: "GET /v2/timeseries/{user_id}/calories_basal/grouped"
description: "Retrieve time-series basal calories burned at rest by the body for a user from the Vital API."
---

<Card
Expand Down
1 change: 1 addition & 0 deletions docs/api-reference/data/timeseries/carbohydrates.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: "Carbohydrates"
openapi: "GET /v2/timeseries/{user_id}/carbohydrates/grouped"
description: "Retrieve time-series dietary carbohydrate intake measurements for a user from the Vital API."
---

<Card
Expand Down
1 change: 1 addition & 0 deletions docs/api-reference/data/timeseries/cholesterol.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: "Cholesterol"
openapi: "GET /v2/timeseries/{user_id}/cholesterol/grouped"
description: "Retrieve time-series dietary cholesterol intake measurements for a user from the Vital API."
---

<Card
Expand Down
1 change: 1 addition & 0 deletions docs/api-reference/data/timeseries/daylight-exposure.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: "Daylight Exposure"
openapi: "GET /v2/timeseries/{user_id}/daylight_exposure/grouped"
description: "Retrieve time-series time spent exposed to daylight for a user from the Vital API."
---

<Card
Expand Down
1 change: 1 addition & 0 deletions docs/api-reference/data/timeseries/distance.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: "Distance"
openapi: "GET /v2/timeseries/{user_id}/distance/grouped"
description: "Retrieve time-series distance traveled during daily activity for a user from the Vital API."
---

<Card
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: "Electrocardiogram Voltage"
openapi: "GET /v2/timeseries/{user_id}/electrocardiogram_voltage/grouped"
description: "Retrieve time-series high-resolution electrocardiogram voltage samples for a user from the Vital API."
---

<Card
Expand Down
3 changes: 2 additions & 1 deletion docs/api-reference/data/timeseries/fall.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: "Fall"
title: "Falls"
openapi: "GET /v2/timeseries/{user_id}/fall/grouped"
description: "Retrieve time-series detected fall events from wearable devices for a user from the Vital API."
---

<Card
Expand Down
1 change: 1 addition & 0 deletions docs/api-reference/data/timeseries/floors-climbed.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: "Floors Climbed"
openapi: "GET /v2/timeseries/{user_id}/floors_climbed/grouped"
description: "Retrieve time-series flights of stairs climbed for a user from the Vital API."
---

<Card
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: "Forced Expiratory Volume 1"
title: "Forced Expiratory Volume"
openapi: "GET /v2/timeseries/{user_id}/forced_expiratory_volume_1/grouped"
description: "Retrieve time-series forced expiratory volume in one second (FEV1) spirometry readings for a user from the Vital API."
---

<Card
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: "Forced Vital Capacity"
openapi: "GET /v2/timeseries/{user_id}/forced_vital_capacity/grouped"
description: "Retrieve time-series forced vital capacity (FVC) spirometry readings for a user from the Vital API."
---

<Card
Expand Down
1 change: 1 addition & 0 deletions docs/api-reference/data/timeseries/glucose.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: "Glucose"
openapi: "GET /v2/timeseries/{user_id}/glucose/grouped"
description: "Retrieve time-series blood glucose readings from CGMs and glucose meters for a user from the Vital API."
---

<Card
Expand Down
1 change: 1 addition & 0 deletions docs/api-reference/data/timeseries/handwashing.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: "Handwashing"
openapi: "GET /v2/timeseries/{user_id}/handwashing/grouped"
description: "Retrieve time-series handwashing event durations for a user from the Vital API."
---

<Card
Expand Down
1 change: 1 addition & 0 deletions docs/api-reference/data/timeseries/heart-rate-alert.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: "Heart Rate Alert"
openapi: "GET /v2/timeseries/{user_id}/heart_rate_alert/grouped"
description: "Retrieve time-series high and low heart rate alert events for a user from the Vital API."
---

<Card
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: "Heart Rate Recovery One Minute"
title: "Heart Rate Recovery"
openapi: "GET /v2/timeseries/{user_id}/heart_rate_recovery_one_minute/grouped"
description: "Retrieve time-series one-minute heart rate recovery readings after exercise for a user from the Vital API."
---

<Card
Expand Down
1 change: 1 addition & 0 deletions docs/api-reference/data/timeseries/heartrate.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: "Heart Rate"
openapi: "GET /v2/timeseries/{user_id}/heartrate/grouped"
description: "Retrieve time-series heart rate readings for a user from the Vital API."
---

<Card
Expand Down
1 change: 1 addition & 0 deletions docs/api-reference/data/timeseries/hrv.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: "Heart Rate Variability"
openapi: "GET /v2/timeseries/{user_id}/hrv/grouped"
description: "Retrieve time-series heart rate variability (HRV) readings for a user from the Vital API."
---

<Card
Expand Down
1 change: 1 addition & 0 deletions docs/api-reference/data/timeseries/hypnogram.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: "Hypnogram"
description: "Retrieve time-series hypnogram sleep stage data for a user from the Vital API."
openapi: "GET /v2/timeseries/{user_id}/hypnogram/grouped"
---

Expand Down
3 changes: 2 additions & 1 deletion docs/api-reference/data/timeseries/ige.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: "Ige"
title: "IgE"
openapi: "GET /v2/timeseries/{user_id}/ige/grouped"
description: "Retrieve time-series immunoglobulin E (IgE) lab measurements for a user from the Vital API."
---

<Card
Expand Down
3 changes: 2 additions & 1 deletion docs/api-reference/data/timeseries/igg.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: "Igg"
title: "IgG"
openapi: "GET /v2/timeseries/{user_id}/igg/grouped"
description: "Retrieve time-series immunoglobulin G (IgG) lab measurements for a user from the Vital API."
---

<Card
Expand Down
1 change: 1 addition & 0 deletions docs/api-reference/data/timeseries/inhaler-usage.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: "Inhaler Usage"
openapi: "GET /v2/timeseries/{user_id}/inhaler_usage/grouped"
description: "Retrieve time-series inhaler usage events for a user from the Vital API."
---

<Card
Expand Down
1 change: 1 addition & 0 deletions docs/api-reference/data/timeseries/insulin-injection.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: "Insulin Injection"
openapi: "GET /v2/timeseries/{user_id}/insulin_injection/grouped"
description: "Retrieve time-series insulin injection events and dosage for a user from the Vital API."
---

<Card
Expand Down
1 change: 1 addition & 0 deletions docs/api-reference/data/timeseries/lean-body-mass.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: "Lean Body Mass"
openapi: "GET /v2/timeseries/{user_id}/lean_body_mass/grouped"
description: "Retrieve time-series lean body mass measurements for a user from the Vital API."
---

<Card
Expand Down
1 change: 1 addition & 0 deletions docs/api-reference/data/timeseries/mindfulness-minutes.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: "Mindfulness Minutes"
openapi: "GET /v2/timeseries/{user_id}/mindfulness_minutes/grouped"
description: "Retrieve time-series minutes spent in mindfulness sessions for a user from the Vital API."
---

<Card
Expand Down
3 changes: 2 additions & 1 deletion docs/api-reference/data/timeseries/note.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: "Note"
title: "Notes"
openapi: "GET /v2/timeseries/{user_id}/note/grouped"
description: "Retrieve time-series free-text notes attached to user data for a user from the Vital API."
---

<Card
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: "Peak Expiratory Flow Rate"
openapi: "GET /v2/timeseries/{user_id}/peak_expiratory_flow_rate/grouped"
description: "Retrieve time-series peak expiratory flow rate (PEFR) spirometry readings for a user from the Vital API."
---

<Card
Expand Down
1 change: 1 addition & 0 deletions docs/api-reference/data/timeseries/respiratory-rate.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: "Respiratory Rate"
openapi: "GET /v2/timeseries/{user_id}/respiratory_rate/grouped"
description: "Retrieve time-series respiratory rate readings for a user from the Vital API."
---

<Card
Expand Down
1 change: 1 addition & 0 deletions docs/api-reference/data/timeseries/sleep-apnea-alert.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: "Sleep Apnea Alert"
openapi: "GET /v2/timeseries/{user_id}/sleep_apnea_alert/grouped"
description: "Retrieve time-series sleep apnea alert events detected by wearables for a user from the Vital API."
---

<Card
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: "Sleep Breathing Disturbance"
openapi: "GET /v2/timeseries/{user_id}/sleep_breathing_disturbance/grouped"
description: "Retrieve time-series sleep breathing disturbance events for a user from the Vital API."
---

<Card
Expand Down
1 change: 1 addition & 0 deletions docs/api-reference/data/timeseries/stand-duration.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: "Stand Duration"
openapi: "GET /v2/timeseries/{user_id}/stand_duration/grouped"
description: "Retrieve time-series time spent standing throughout the day for a user from the Vital API."
---

<Card
Expand Down
1 change: 1 addition & 0 deletions docs/api-reference/data/timeseries/stand-hour.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: "Stand Hour"
openapi: "GET /v2/timeseries/{user_id}/stand_hour/grouped"
description: "Retrieve time-series hours in which the user stood and moved for a user from the Vital API."
---

<Card
Expand Down
1 change: 1 addition & 0 deletions docs/api-reference/data/timeseries/steps.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: "Steps"
openapi: "GET /v2/timeseries/{user_id}/steps/grouped"
description: "Retrieve time-series step count readings for a user from the Vital API."
---

<Card
Expand Down
1 change: 1 addition & 0 deletions docs/api-reference/data/timeseries/stress-level.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: "Stress Level"
openapi: "GET /v2/timeseries/{user_id}/stress_level/grouped"
description: "Retrieve time-series stress level readings derived from physiological signals for a user from the Vital API."
---

<Card
Expand Down
3 changes: 2 additions & 1 deletion docs/api-reference/data/timeseries/uv-exposure.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: "Uv Exposure"
title: "UV Exposure"
openapi: "GET /v2/timeseries/{user_id}/uv_exposure/grouped"
description: "Retrieve time-series ultraviolet (UV) light exposure readings for a user from the Vital API."
---

<Card
Expand Down
3 changes: 2 additions & 1 deletion docs/api-reference/data/timeseries/vo2-max.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: "Vo2 Max"
title: "VO2 Max"
openapi: "GET /v2/timeseries/{user_id}/vo2_max/grouped"
description: "Retrieve time-series VO2 max cardiorespiratory fitness measurements for a user from the Vital API."
---

<Card
Expand Down
1 change: 1 addition & 0 deletions docs/api-reference/data/timeseries/waist-circumference.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: "Waist Circumference"
openapi: "GET /v2/timeseries/{user_id}/waist_circumference/grouped"
description: "Retrieve time-series waist circumference measurements for a user from the Vital API."
---

<Card
Expand Down
1 change: 1 addition & 0 deletions docs/api-reference/data/timeseries/water.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: "Water"
openapi: "GET /v2/timeseries/{user_id}/water/grouped"
description: "Retrieve time-series water intake measurements for a user from the Vital API."
---

<Card
Expand Down
3 changes: 2 additions & 1 deletion docs/api-reference/data/timeseries/wheelchair-push.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: "Wheelchair Push"
title: "Wheelchair Pushes"
openapi: "GET /v2/timeseries/{user_id}/wheelchair_push/grouped"
description: "Retrieve time-series wheelchair push counts for accessibility tracking for a user from the Vital API."
---

<Card
Expand Down
Loading
Loading