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
1 change: 1 addition & 0 deletions docs/api-reference/data/timeseries/afib-burden.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: "Afib Burden"
description: "Retrieve atrial fibrillation burden timeseries data for a user from connected wearable devices like Apple Watch or Oura."
openapi: "GET /v2/timeseries/{user_id}/afib_burden/grouped"
---

Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: "Basal Body Temperature"
description: "Retrieve basal body temperature timeseries data for a user from connected wearables and health tracking devices."
openapi: "GET /v2/timeseries/{user_id}/basal_body_temperature/grouped"
---

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,5 +1,6 @@
---
title: "Blood Oxygen"
description: "Retrieve blood oxygen saturation (SpO2) timeseries data for a user from connected wearables and pulse oximeters."
openapi: "GET /v2/timeseries/{user_id}/blood_oxygen/grouped"
---

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,5 +1,6 @@
---
title: "Blood Pressure"
description: "Retrieve systolic and diastolic blood pressure timeseries readings for a user from connected blood pressure monitors."
openapi: "GET /v2/timeseries/{user_id}/blood_pressure/grouped"
---

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,5 +1,6 @@
---
title: "Body Fat"
description: "Retrieve body fat percentage timeseries data for a user from connected smart scales and body composition devices."
openapi: "GET /v2/timeseries/{user_id}/body_fat/grouped"
---

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,5 +1,6 @@
---
title: "Body Mass Index"
description: "Retrieve body mass index (BMI) timeseries data for a user from connected smart scales and health devices."
openapi: "GET /v2/timeseries/{user_id}/body_mass_index/grouped"
---

Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: "Body Temperature Delta"
description: "Retrieve body temperature delta timeseries data showing changes from baseline for a user from connected wearables."
openapi: "GET /v2/timeseries/{user_id}/body_temperature_delta/grouped"
---

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,5 +1,6 @@
---
title: "Body Temperature"
description: "Retrieve body temperature timeseries data for a user from connected wearables and thermometers."
openapi: "GET /v2/timeseries/{user_id}/body_temperature/grouped"
---

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,5 +1,6 @@
---
title: "Body Weight"
description: "Retrieve body weight timeseries data for a user from connected smart scales and fitness devices."
openapi: "GET /v2/timeseries/{user_id}/body_weight/grouped"
---

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,5 +1,6 @@
---
title: "Caffeine"
description: "Retrieve caffeine intake timeseries data for a user from connected nutrition tracking apps and devices."
openapi: "GET /v2/timeseries/{user_id}/caffeine/grouped"
---

Expand Down
1 change: 1 addition & 0 deletions docs/api-reference/data/timeseries/calories-active.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: "Calories Active"
description: "Retrieve active calories burned timeseries data for a user from connected fitness trackers and wearables."
openapi: "GET /v2/timeseries/{user_id}/calories_active/grouped"
---

Expand Down
1 change: 1 addition & 0 deletions docs/api-reference/data/timeseries/calories-basal.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: "Calories Basal"
description: "Retrieve basal (resting) calories burned timeseries data for a user from connected wearables and fitness trackers."
openapi: "GET /v2/timeseries/{user_id}/calories_basal/grouped"
---

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,5 +1,6 @@
---
title: "Carbohydrates"
description: "Retrieve carbohydrate intake timeseries data for a user from connected nutrition tracking apps and devices."
openapi: "GET /v2/timeseries/{user_id}/carbohydrates/grouped"
---

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,5 +1,6 @@
---
title: "Cholesterol"
description: "Retrieve cholesterol level timeseries data for a user from connected health monitoring apps and devices."
openapi: "GET /v2/timeseries/{user_id}/cholesterol/grouped"
---

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,5 +1,6 @@
---
title: "Daylight Exposure"
description: "Retrieve daylight exposure timeseries data for a user from connected wearables that track time spent in daylight."
openapi: "GET /v2/timeseries/{user_id}/daylight_exposure/grouped"
---

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,5 +1,6 @@
---
title: "Distance"
description: "Retrieve distance traveled timeseries data for a user from connected fitness trackers and wearables."
openapi: "GET /v2/timeseries/{user_id}/distance/grouped"
---

Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: "Electrocardiogram Voltage"
description: "Retrieve electrocardiogram voltage timeseries data for a user from ECG-capable wearables like Apple Watch."
openapi: "GET /v2/timeseries/{user_id}/electrocardiogram_voltage/grouped"
---

Expand Down
1 change: 1 addition & 0 deletions docs/api-reference/data/timeseries/fall.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: "Fall"
description: "Retrieve fall detection event timeseries data for a user from connected wearables with fall detection capabilities."
openapi: "GET /v2/timeseries/{user_id}/fall/grouped"
---

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,5 +1,6 @@
---
title: "Floors Climbed"
description: "Retrieve floors climbed timeseries data for a user from connected fitness trackers and smartphone sensors."
openapi: "GET /v2/timeseries/{user_id}/floors_climbed/grouped"
---

Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: "Forced Expiratory Volume 1"
description: "Retrieve forced expiratory volume in one second (FEV1) timeseries data for a user from connected spirometers."
openapi: "GET /v2/timeseries/{user_id}/forced_expiratory_volume_1/grouped"
---

Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: "Forced Vital Capacity"
description: "Retrieve forced vital capacity (FVC) lung function timeseries data for a user from connected spirometers."
openapi: "GET /v2/timeseries/{user_id}/forced_vital_capacity/grouped"
---

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,5 +1,6 @@
---
title: "Glucose"
description: "Retrieve blood glucose timeseries data for a user from connected continuous glucose monitors (CGMs) and glucose meters."
openapi: "GET /v2/timeseries/{user_id}/glucose/grouped"
---

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,5 +1,6 @@
---
title: "Handwashing"
description: "Retrieve handwashing event timeseries data for a user from connected wearables that detect handwashing activity."
openapi: "GET /v2/timeseries/{user_id}/handwashing/grouped"
---

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,5 +1,6 @@
---
title: "Heart Rate Alert"
description: "Retrieve heart rate alert event timeseries data for a user from connected wearables that monitor abnormal heart rates."
openapi: "GET /v2/timeseries/{user_id}/heart_rate_alert/grouped"
---

Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: "Heart Rate Recovery One Minute"
description: "Retrieve one-minute heart rate recovery timeseries data for a user from connected fitness trackers and wearables."
openapi: "GET /v2/timeseries/{user_id}/heart_rate_recovery_one_minute/grouped"
---

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,5 +1,6 @@
---
title: "Heart Rate"
description: "Retrieve heart rate timeseries data for a user from connected wearables, fitness trackers, and heart rate monitors."
openapi: "GET /v2/timeseries/{user_id}/heartrate/grouped"
---

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,5 +1,6 @@
---
title: "Heart Rate Variability"
description: "Retrieve heart rate variability (HRV) timeseries data for a user from connected wearables and fitness trackers."
openapi: "GET /v2/timeseries/{user_id}/hrv/grouped"
---

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 hypnogram (sleep stage) timeseries data for a user from connected sleep tracking wearables and devices."
openapi: "GET /v2/timeseries/{user_id}/hypnogram/grouped"
---

Expand Down
1 change: 1 addition & 0 deletions docs/api-reference/data/timeseries/ige.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: "Ige"
description: "Retrieve immunoglobulin E (IgE) allergy biomarker timeseries data for a user from connected health tracking sources."
openapi: "GET /v2/timeseries/{user_id}/ige/grouped"
---

Expand Down
1 change: 1 addition & 0 deletions docs/api-reference/data/timeseries/igg.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: "Igg"
description: "Retrieve immunoglobulin G (IgG) biomarker timeseries data for a user from connected health tracking sources."
openapi: "GET /v2/timeseries/{user_id}/igg/grouped"
---

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,5 +1,6 @@
---
title: "Inhaler Usage"
description: "Retrieve inhaler usage event timeseries data for a user from connected smart inhalers and respiratory health devices."
openapi: "GET /v2/timeseries/{user_id}/inhaler_usage/grouped"
---

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,5 +1,6 @@
---
title: "Insulin Injection"
description: "Retrieve insulin injection event timeseries data for a user from connected insulin pens, pumps, and diabetes apps."
openapi: "GET /v2/timeseries/{user_id}/insulin_injection/grouped"
---

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,5 +1,6 @@
---
title: "Lean Body Mass"
description: "Retrieve lean body mass timeseries data for a user from connected smart scales and body composition devices."
openapi: "GET /v2/timeseries/{user_id}/lean_body_mass/grouped"
---

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,5 +1,6 @@
---
title: "Mindfulness Minutes"
description: "Retrieve mindfulness minutes timeseries data for a user from connected meditation and mindfulness tracking apps."
openapi: "GET /v2/timeseries/{user_id}/mindfulness_minutes/grouped"
---

Expand Down
1 change: 1 addition & 0 deletions docs/api-reference/data/timeseries/note.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: "Note"
description: "Retrieve user-recorded note timeseries data for a user from connected health and wellness tracking apps."
openapi: "GET /v2/timeseries/{user_id}/note/grouped"
---

Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: "Peak Expiratory Flow Rate"
description: "Retrieve peak expiratory flow rate timeseries data for a user from connected spirometers and respiratory devices."
openapi: "GET /v2/timeseries/{user_id}/peak_expiratory_flow_rate/grouped"
---

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,5 +1,6 @@
---
title: "Respiratory Rate"
description: "Retrieve respiratory rate timeseries data for a user from connected wearables and respiratory monitoring devices."
openapi: "GET /v2/timeseries/{user_id}/respiratory_rate/grouped"
---

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,5 +1,6 @@
---
title: "Sleep Apnea Alert"
description: "Retrieve sleep apnea alert event timeseries data for a user from connected wearables that monitor sleep breathing."
openapi: "GET /v2/timeseries/{user_id}/sleep_apnea_alert/grouped"
---

Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: "Sleep Breathing Disturbance"
description: "Retrieve sleep breathing disturbance timeseries data for a user from connected sleep tracking wearables."
openapi: "GET /v2/timeseries/{user_id}/sleep_breathing_disturbance/grouped"
---

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,5 +1,6 @@
---
title: "Stand Duration"
description: "Retrieve standing duration timeseries data for a user from connected fitness trackers and wearables."
openapi: "GET /v2/timeseries/{user_id}/stand_duration/grouped"
---

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,5 +1,6 @@
---
title: "Stand Hour"
description: "Retrieve stand hour event timeseries data for a user from connected wearables like Apple Watch."
openapi: "GET /v2/timeseries/{user_id}/stand_hour/grouped"
---

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,5 +1,6 @@
---
title: "Steps"
description: "Retrieve daily step count timeseries data for a user from connected fitness trackers, wearables, and smartphones."
openapi: "GET /v2/timeseries/{user_id}/steps/grouped"
---

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,5 +1,6 @@
---
title: "Stress Level"
description: "Retrieve stress level timeseries data for a user from connected wearables that calculate stress scores."
openapi: "GET /v2/timeseries/{user_id}/stress_level/grouped"
---

Expand Down
1 change: 1 addition & 0 deletions docs/api-reference/data/timeseries/uv-exposure.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: "Uv Exposure"
description: "Retrieve ultraviolet (UV) exposure timeseries data for a user from connected wearables that track sun exposure."
openapi: "GET /v2/timeseries/{user_id}/uv_exposure/grouped"
---

Expand Down
1 change: 1 addition & 0 deletions docs/api-reference/data/timeseries/vo2-max.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: "Vo2 Max"
description: "Retrieve VO2 max cardiorespiratory fitness timeseries data for a user from connected fitness trackers and wearables."
openapi: "GET /v2/timeseries/{user_id}/vo2_max/grouped"
---

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,5 +1,6 @@
---
title: "Waist Circumference"
description: "Retrieve waist circumference measurement timeseries data for a user from connected health and body measurement apps."
openapi: "GET /v2/timeseries/{user_id}/waist_circumference/grouped"
---

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,5 +1,6 @@
---
title: "Water"
description: "Retrieve water and hydration intake timeseries data for a user from connected nutrition and hydration tracking apps."
openapi: "GET /v2/timeseries/{user_id}/water/grouped"
---

Expand Down
1 change: 1 addition & 0 deletions docs/api-reference/data/timeseries/wheelchair-push.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: "Wheelchair Push"
description: "Retrieve wheelchair push event timeseries data for a user from connected wearables that support wheelchair tracking."
openapi: "GET /v2/timeseries/{user_id}/wheelchair_push/grouped"
---

Expand Down
1 change: 1 addition & 0 deletions docs/api-reference/data/timeseries/workout-distance.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: "Workout Distance"
description: "Retrieve per-workout distance timeseries data for a user from connected fitness trackers and wearables."
openapi: "GET /v2/timeseries/{user_id}/workout_distance/grouped"
---

Expand Down
1 change: 1 addition & 0 deletions docs/api-reference/data/timeseries/workout-duration.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: "Workout Duration"
description: "Retrieve per-workout duration timeseries data for a user from connected fitness trackers and wearables."
openapi: "GET /v2/timeseries/{user_id}/workout_duration/grouped"
---

Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: "Workout Swimming Stroke"
description: "Retrieve swimming stroke timeseries data for a user from connected wearables that detect swimming activity."
openapi: "GET /v2/timeseries/{user_id}/workout_swimming_stroke/grouped"
---

Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
---
title: continuous_query.result_table.changed
description: "Webhook event fired when a continuous query result table changes, signaling new processed data is available."
openapi-schema: ClientFacingContinuousQueryResultTableChanged
---
1 change: 1 addition & 0 deletions docs/event-catalog/daily.data.activity.created.mdx
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
---
title: daily.data.activity.created
description: "Webhook event fired when new daily activity data is available for a user from a connected wearable provider."
openapi-schema: ClientFacingActivityChanged
---
1 change: 1 addition & 0 deletions docs/event-catalog/daily.data.activity.updated.mdx
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
---
title: daily.data.activity.updated
description: "Webhook event fired when previously delivered daily activity data is updated by a connected wearable provider."
openapi-schema: ClientFacingActivityChanged
---
1 change: 1 addition & 0 deletions docs/event-catalog/daily.data.afib_burden.created.mdx
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
---
title: daily.data.afib_burden.created
description: "Webhook event fired when new daily atrial fibrillation burden data is available for a user from a connected wearable provider."
openapi-schema: ClientFacingAfibBurdenChanged
---
1 change: 1 addition & 0 deletions docs/event-catalog/daily.data.afib_burden.updated.mdx
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
---
title: daily.data.afib_burden.updated
description: "Webhook event fired when previously delivered daily atrial fibrillation burden data is updated by a connected wearable provider."
openapi-schema: ClientFacingAfibBurdenChanged
---
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
---
title: daily.data.basal_body_temperature.created
description: "Webhook event fired when new daily basal body temperature data is available for a user from a connected wearable provider."
openapi-schema: ClientFacingBasalBodyTemperatureChanged
---
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
---
title: daily.data.basal_body_temperature.updated
description: "Webhook event fired when previously delivered daily basal body temperature data is updated by a connected wearable provider."
openapi-schema: ClientFacingBasalBodyTemperatureChanged
---
Loading
Loading