Overview

Data Dictionary

This page provides a comprehensive list of all data points available across Sahha's product suite. Use this reference to quickly find the metrics you need for your application.


Scores

360° measures of health and wellness

Name Range Factors Description Requires Wearable Available Via
Wellbeing 0.0-1.0 steps, active_hours, active_calories, intense_activity_duration, extended_inactivity, floors_climbed, sleep_duration, sleep_regularity, sleep_continuity, sleep_debt, circadian_alignment, physical_recovery, mental_recovery Holistic measure combining physical, mental, and behavioral health data No API , Webhooks , getScores , UI
Activity 0.0-1.0 steps, active_hours, active_calories, intense_activity_duration, extended_inactivity, floors_climbed Evaluates daily physical activity levels and intensity No API , Webhooks , getScores , UI
Sleep 0.0-1.0 sleep_duration, sleep_regularity, sleep_continuity, sleep_debt, circadian_alignment, physical_recovery, mental_recovery Assesses sleep quality, duration, regularity, and stages No API , Webhooks , getScores , UI
Mental Wellbeing 0.0-1.0 steps, active_hours, extended_inactivity, activity_regularity, sleep_regularity, circadian_alignment Measures mental wellness through behavioral pattern analysis No API , Webhooks , getScores , UI
Readiness 0.0-1.0 sleep_duration, physical_recovery, mental_recovery, sleep_debt, walking_strain_capacity, exercise_strain_capacity, resting_heart_rate, heart_rate_variability Gauges daily readiness and recovery metrics No API , Webhooks , getScores , UI

View scores documentation →


Archetypes

Labels that capture persona and lifestyle

Name Type Periodicity Possible Values Description Requires Wearable Available Via
activity_level Ordinal Weekly, Monthly sedentary, lightly_active, moderately_active, highly_active Overall level of physical activity No API , Webhooks
exercise_frequency Ordinal Weekly, Monthly rare_exerciser, occasional_exerciser, regular_exerciser, frequent_exerciser How often the individual exercises No API , Webhooks
mental_wellness Ordinal Weekly, Monthly poor_mental_wellness, fair_mental_wellness, good_mental_wellness, optimal_mental_wellness Mental wellness and resiliency No API , Webhooks
overall_wellness Ordinal Weekly, Monthly poor_wellness, fair_wellness, good_wellness, optimal_wellness Overall wellbeing across all health aspects No API , Webhooks
primary_exercise Categorical Weekly, Monthly See possible exercise types Most frequently performed exercise No API , Webhooks
primary_exercise_type Categorical Weekly, Monthly strength_oriented, cardio_oriented, mind_body_oriented, hybrid_oriented, sport_oriented, outdoor_oriented Categorizes primary exercise type No API , Webhooks
secondary_exercise Categorical Weekly, Monthly See possible exercise types Second most frequently performed exercise No API , Webhooks
sleep_duration Ordinal Weekly, Monthly very_short_sleeper, short_sleeper, average_sleeper, long_sleeper Typical sleep duration relative to norms No API , Webhooks
sleep_efficiency Ordinal Weekly, Monthly highly_inefficient_sleeper, inefficient_sleeper, efficient_sleeper, highly_efficient_sleeper Sleep maintenance effectiveness Yes API , Webhooks
sleep_pattern Categorical Weekly, Monthly consistent_early_riser, inconsistent_early_riser, consistent_late_sleeper, inconsistent_late_sleeper, early_morning_sleeper, chronic_short_sleeper, inconsistent_short_sleeper Overall sleep behavior patterns No API , Webhooks
sleep_quality Ordinal Weekly, Monthly poor_sleep_quality, fair_sleep_quality, good_sleep_quality, optimal_sleep_quality Long-term sleep quality assessment No API , Webhooks
sleep_regularity Ordinal Weekly, Monthly highly_irregular_sleeper, irregular_sleeper, regular_sleeper, highly_regular_sleeper Consistency in sleep timings No API , Webhooks
bed_schedule Ordinal Weekly, Monthly very_early_sleeper, early_sleeper, late_sleeper, very_late_sleeper Typical bedtime patterns No API , Webhooks
wake_schedule Ordinal Weekly, Monthly very_early_riser, early_riser, late_riser, very_late_riser Typical wake-up time patterns No API , Webhooks

View archetypes documentation →


Biomarkers

Granular metrics that track physiology and state

Activity

Name Unit Periodicity Aggregation Description Requires Wearable Available Via
steps count daily total Total number of steps taken No API , Webhooks , getBiomarkers , UI
floors_climbed count daily total Total number of floors climbed No API , Webhooks , getBiomarkers , UI
active_hours hour daily total Hours with any physical activity No API , Webhooks , getBiomarkers , UI
active_duration minute daily total Total duration of all physical activities No API , Webhooks , getBiomarkers , UI
activity_low_intensity_duration minute daily total Duration in low-intensity activities (1.5-2.9 METs) No API , Webhooks , getBiomarkers , UI
activity_medium_intensity_duration minute daily total Duration in moderate-intensity activities (3-5.9 METs) No API , Webhooks , getBiomarkers , UI
activity_high_intensity_duration minute daily total Time in high-intensity activities (>6 METs) No API , Webhooks , getBiomarkers , UI
activity_sedentary_duration minute daily total Time spent inactive No API , Webhooks , getBiomarkers , UI
active_energy_burned kcal daily total Energy expended during active phases No API , Webhooks , getBiomarkers , UI
total_energy_burned kcal daily total Overall energy expenditure No API , Webhooks , getBiomarkers , UI

Body

Name Unit Periodicity Aggregation Description Requires Wearable Available Via
height meter none none Individual's stature measurement No API , Webhooks , SDK , UI
weight kilogram none none Total body mass No API , Webhooks , getBiomarkers , UI
body_mass_index kg/m² none none Body fat computation from weight and height No API , Webhooks , getBiomarkers , UI
body_fat percentage none none Proportion of body weight that is fat Yes API , Webhooks , getBiomarkers , UI
fat_mass kilogram none none Total weight of fat in the body Yes API , Webhooks , getBiomarkers , UI
lean_mass kilogram none none Weight of non-fat body components Yes API , Webhooks , getBiomarkers , UI
waist_circumference meter none none Circumference measurement around waist No API , Webhooks , getBiomarkers , UI
resting_energy_burned kcal daily total Energy expended at rest No API , Webhooks , getBiomarkers , UI

Sleep

Name Unit Periodicity Aggregation Description Requires Wearable Available Via
sleep_start_time datetime daily none Time when individual falls asleep No API , Webhooks , getBiomarkers , UI
sleep_mid_time datetime daily none Midpoint time in the sleep cycle No API , Webhooks , getBiomarkers , UI
sleep_end_time datetime daily none Time when individual wakes up No API , Webhooks , getBiomarkers , UI
sleep_duration minute daily total Total time spent sleeping No API , Webhooks , getBiomarkers , UI
sleep_debt hour weekly average Discrepancy between required and actual sleep No API , Webhooks , getBiomarkers , UI
sleep_interruptions count daily total Count of awakenings during night Yes API , Webhooks , getBiomarkers , UI
sleep_in_bed_duration minute daily total Total time spent in bed No API , Webhooks , getBiomarkers , UI
sleep_awake_duration minute daily total Time awake after initially falling asleep Yes API , Webhooks , getBiomarkers , UI
sleep_light_duration minute daily total Time spent in light sleep phase Yes API , Webhooks , getBiomarkers , UI
sleep_rem_duration minute daily total Time spent in REM sleep phase Yes API , Webhooks , getBiomarkers , UI
sleep_deep_duration minute daily total Time spent in deep sleep phase Yes API , Webhooks , getBiomarkers , UI
sleep_regularity index weekly average Consistency of sleep patterns over time No API , Webhooks , getBiomarkers , UI
sleep_latency minute daily none Time to fall asleep after going to bed Yes API , Webhooks , getBiomarkers , UI
sleep_efficiency percentage daily none Ratio of sleep time to time in bed Yes API , Webhooks , getBiomarkers , UI

Vitals

Name Unit Periodicity Aggregation Description Requires Wearable Available Via
heart_rate_resting bpm daily average Heart rate when at rest Yes API , Webhooks , getBiomarkers , UI
heart_rate_sleep bpm daily average Average heart rate during sleep Yes API , Webhooks , getBiomarkers , UI
heart_rate_variability_sdnn millisecond daily average Standard deviation of NN intervals Yes API , Webhooks , getBiomarkers , UI
heart_rate_variability_rmssd millisecond daily average Root mean square of successive differences Yes API , Webhooks , getBiomarkers , UI
respiratory_rate count/minute daily average Frequency of breaths per minute at rest Yes API , Webhooks , getBiomarkers , UI
respiratory_rate_sleep count/minute daily average Average respiratory rate during sleep Yes API , Webhooks , getBiomarkers , UI
oxygen_saturation percentage daily average Proportion of oxygen-saturated hemoglobin Yes API , Webhooks , getBiomarkers , UI
oxygen_saturation_sleep percentage daily average Average oxygen saturation during sleep Yes API , Webhooks , getBiomarkers , UI
vo2_max mL/kg/min daily average Maximum oxygen utilization during exercise Yes API , Webhooks , getBiomarkers , UI
blood_glucose mg/dL daily average Level of glucose in blood Yes API , Webhooks , getBiomarkers , UI
blood_pressure_systolic mmHg daily average Peak arterial pressure during heartbeats Yes API , Webhooks , getBiomarkers , UI
blood_pressure_diastolic mmHg daily average Lowest arterial pressure during heart relaxation Yes API , Webhooks , getBiomarkers , UI
body_temperature_basal celsius daily average Body temperature at rest Yes API , Webhooks , getBiomarkers , UI
skin_temperature_sleep celsius daily average Skin temperature during sleep Yes API , Webhooks , getBiomarkers , UI

Reproductive

Name Unit Periodicity Aggregation Description Requires Wearable Available Via
menstrual_cycle_start_date date monthly none Date when current menstrual cycle started No API , Webhooks , getBiomarkers , UI
menstrual_cycle_end_date date monthly none Date when current menstrual cycle ended No API , Webhooks , getBiomarkers , UI
menstrual_cycle_length day monthly none Length of current menstrual cycle No API , Webhooks , getBiomarkers , UI
menstrual_cycle_day_number day daily none Current day number within menstrual cycle No API , Webhooks , getBiomarkers , UI
menstrual_phase none weekly none Current phase of menstrual cycle No API , Webhooks , getBiomarkers , UI
menstrual_phase_start_date date weekly none Date when current phase started No API , Webhooks , getBiomarkers , UI
menstrual_phase_end_date date weekly none Date when current phase ended No API , Webhooks , getBiomarkers , UI
menstrual_phase_length day weekly none Length of current menstrual phase No API , Webhooks , getBiomarkers , UI
menstrual_phase_day_number day daily none Current day number within phase No API , Webhooks , getBiomarkers , UI
menstrual_phase_days_to_next_phase day daily none Days remaining until next phase No API , Webhooks , getBiomarkers , UI
fertile_window_start_date date monthly none Start date of fertile window No API , Webhooks , getBiomarkers , UI
fertile_window_end_date date monthly none End date of fertile window No API , Webhooks , getBiomarkers , UI
menstruation_period_start_date date monthly none Start date of menstruation period No API , Webhooks , getBiomarkers , UI
menstruation_period_end_date date monthly none End date of menstruation period No API , Webhooks , getBiomarkers , UI

View biomarkers documentation →


Data Logs

Raw events from source, streamed in real time

Activity Logs

Name Unit Description Requires Wearable Available Via
steps count Total steps taken No Webhooks
exercise_time minute Duration of physical exercise No Webhooks
floors_climbed count Number of floors climbed No Webhooks
stand_time minute Time spent standing No Webhooks

Blood Logs

Name Unit Description Requires Wearable Available Via
blood_glucose mg/dL Glucose levels in the blood Yes Webhooks
blood_pressure_diastolic mmHg Diastolic blood pressure Yes Webhooks
blood_pressure_systolic mmHg Systolic blood pressure Yes Webhooks

Body Logs

Name Unit Description Requires Wearable Available Via
body_fat percent Percentage of body fat Yes Webhooks
body_mass_index count Body Mass Index (BMI) No Webhooks
lean_body_mass kg Weight of lean body mass Yes Webhooks
weight kg Total body weight No Webhooks

Device Logs

Name Unit Description Requires Wearable Available Via
device_lock boolean Indicates if device is locked No Webhooks

Energy Logs

Name Unit Description Requires Wearable Available Via
active_energy_burned kcal Calories burned through activity No Webhooks
basal_energy_burned kcal Calories burned at rest No Webhooks
time_in_daylight minute Time spent in natural daylight No Webhooks

Exercise Logs

Name Unit Description Requires Wearable Available Via
exercise_session_* minute Duration spent doing specified exercise type. See all supported exercise types No Webhooks
exercise_session_biking minute Duration spent cycling or biking No Webhooks
exercise_session_running minute Duration spent running or jogging No Webhooks
exercise_session_walking minute Duration spent walking for exercise No Webhooks

Heart Logs

Name Unit Description Requires Wearable Available Via
heart_rate bpm Beats per minute Yes Webhooks
heart_rate_variability ms Variation in intervals between heartbeats Yes Webhooks
heart_rate_variability_sdnn ms Standard deviation of NN intervals Yes Webhooks
resting_heart_rate bpm Heart rate at rest Yes Webhooks
walking_heart_rate_average bpm Average heart rate while walking Yes Webhooks

Oxygen Logs

Name Unit Description Requires Wearable Available Via
oxygen_saturation percent Percentage of oxygen-saturated hemoglobin Yes Webhooks
respiratory_rate bps Breaths per second Yes Webhooks
vo2_max ml/kg/min Maximum rate of oxygen consumption during exercise Yes Webhooks

Sleep Logs

Name Unit Description Requires Wearable Available Via
sleep_stage_awake minute Duration in awake stage Yes Webhooks
sleep_stage_deep minute Duration in deep sleep stage Yes Webhooks
sleep_stage_in_bed minute Duration in bed, not necessarily asleep No Webhooks
sleep_stage_light minute Duration in light sleep stage Yes Webhooks
sleep_stage_rem minute Duration in REM sleep stage Yes Webhooks
sleep_stage_sleeping minute Duration actually spent asleep/sleeping No Webhooks

Temperature Logs

Name Unit Description Requires Wearable Available Via
basal_body_temperature degC Body temperature at rest Yes Webhooks
sleeping_wrist_temperature degC Temperature measured at wrist during sleep Yes Webhooks

View data logs documentation →


Insights

Signals of change and consistency

Name Category Unit Higher Better Description Available Via
sleep score index true Overall sleep quality API
activity score index true Physical activity and movement levels API
readiness score index true Body's recovery state and preparedness API
wellbeing score index true Holistic health combining sleep and activity API
mental_wellbeing score index true Mental wellbeing state based on behavioral patterns API
sleep_duration factor index true Total time spent asleep API
sleep_regularity factor index true Consistency of sleep schedule API
sleep_continuity factor index true Uninterrupted sleep with minimal awakenings API
sleep_debt factor index true Accumulated sleep deficit API
circadian_alignment factor index true Alignment with natural sleep-wake cycle API
physical_recovery factor index true Deep sleep phase duration API
mental_recovery factor index true REM sleep phase duration API
steps factor index true Daily step count API
active_hours factor index true Hours with significant physical activity API
active_calories factor index true Calories burned during activity API
intense_activity_duration factor index true Time spent in high-intensity activity API
extended_inactivity factor index true Prolonged sedentary periods API
floors_climbed factor index true Vertical movement measurement API
activity_regularity factor index true Consistency of daily activity patterns API
walking_strain_capacity factor index null Capacity to do low-intensity activities API
exercise_strain_capacity factor index null Capacity to do high-intensity exercises API
resting_heart_rate factor index true Heart rate during rest API
heart_rate_variability factor index true Variation in time between heartbeats API

Comparisons

Name Category Unit Higher Better Description Available Via
sleep score index true Overall sleep quality API
activity score index true Physical activity and movement levels API
readiness score index true Body's recovery state and preparedness API
wellbeing score index true Holistic health combining sleep and activity API
mental_wellbeing score index true Mental wellbeing state based on behavioral patterns API
steps biomarker count true Daily step count API
sleep_duration biomarker minute true Total time spent asleep API
heart_rate_resting biomarker bpm false Resting heart rate API
heart_rate_variability_sdnn biomarker ms true HRV measured as SDNN API
heart_rate_variability_rmssd biomarker ms true HRV measured as RMSSD API
vo2_max biomarker ml/kg/min true Maximum oxygen uptake API

View insights documentation →


Direct Device Data (via SDK)

Raw sensor data from Apple Health and Google Health Connect, available directly via SDK

Demographics

Name Unit Description Platform Support Available Via
gender none Biological sex iOS only getSamples , getStats
date_of_birth date Date of birth iOS only getSamples , getStats

Activity

Name Unit Description Platform Support Available Via
steps count Step count iOS, Android getSamples , getStats
floors_climbed count Flights of stairs climbed iOS, Android getSamples , getStats
stand_time minute Time spent standing iOS only getSamples , getStats
move_time minute Time spent moving iOS only getSamples , getStats
exercise_time minute Time spent exercising iOS only getSamples , getStats
exercise minute Exercise sessions iOS, Android getSamples , getStats
activity_summary none Daily activity summary iOS only getSamples , getStats
running_speed m/s Running speed iOS only getSamples , getStats
running_power W Running power output iOS only getSamples , getStats
running_ground_contact_time ms Time foot is in contact with ground iOS only getSamples , getStats
running_stride_length meter Distance between consecutive foot strikes iOS only getSamples , getStats
running_vertical_oscillation cm Vertical movement during running iOS only getSamples , getStats
six_minute_walk_test_distance meter Distance covered in 6-minute walk test iOS only getSamples , getStats
stair_ascent_speed m/s Speed while climbing stairs iOS only getSamples , getStats
stair_descent_speed m/s Speed while descending stairs iOS only getSamples , getStats
walking_speed m/s Walking speed iOS only getSamples , getStats
walking_steadiness index Walking steadiness score iOS only getSamples , getStats
walking_asymmetry_percentage % Asymmetry in walking gait iOS only getSamples , getStats
walking_double_support_percentage % Percentage of time with both feet on ground iOS only getSamples , getStats
walking_step_length meter Distance between consecutive steps iOS only getSamples , getStats

Sleep

Name Unit Description Platform Support Available Via
sleep minute Sleep analysis data iOS, Android getSamples , getStats

Vitals

Name Unit Description Platform Support Available Via
heart_rate bpm Heart rate measurements iOS, Android getSamples , getStats
resting_heart_rate bpm Resting heart rate iOS, Android getSamples , getStats
walking_heart_rate_average bpm Average heart rate while walking iOS only getSamples , getStats
heart_rate_variability_sdnn ms Heart rate variability (SDNN) iOS only getSamples , getStats
heart_rate_variability_rmssd ms Heart rate variability (RMSSD) iOS, Android getSamples , getStats
blood_pressure_systolic mmHg Systolic blood pressure iOS, Android getSamples , getStats
blood_pressure_diastolic mmHg Diastolic blood pressure iOS, Android getSamples , getStats
blood_glucose mg/dL Blood glucose levels iOS, Android getSamples , getStats
vo2_max mL/kg/min Maximum oxygen uptake iOS, Android getSamples , getStats
oxygen_saturation % Blood oxygen saturation iOS, Android getSamples , getStats
respiratory_rate count/min Breathing rate iOS, Android getSamples , getStats
body_temperature °C Body temperature iOS, Android getSamples , getStats
basal_body_temperature °C Basal body temperature iOS, Android getSamples , getStats
sleeping_wrist_temperature °C Wrist temperature during sleep iOS only getSamples , getStats

Energy

Name Unit Description Platform Support Available Via
active_energy_burned kcal Calories burned through activity iOS, Android getSamples , getStats
basal_energy_burned kcal Calories burned at rest iOS only getSamples , getStats
total_energy_burned kcal Total calories burned iOS, Android getSamples , getStats
basal_metabolic_rate kcal Basal metabolic rate Android only getSamples , getStats
time_in_daylight minute Time spent in natural daylight iOS only getSamples , getStats
energy_consumed kcal Dietary energy consumed iOS, Android getSamples , getStats

Body Composition

Name Unit Description Platform Support Available Via
height meter Height measurement iOS, Android getSamples , getStats
weight kg Body weight iOS, Android getSamples , getStats
lean_body_mass kg Lean body mass iOS, Android getSamples , getStats
body_mass_index kg/m² Body Mass Index iOS only getSamples , getStats
body_fat % Body fat percentage iOS, Android getSamples , getStats
body_water_mass kg Body water mass iOS, Android getSamples , getStats
bone_mass kg Bone mass iOS, Android getSamples , getStats
waist_circumference meter Waist circumference iOS only getSamples , getStats

View sensors documentation →


Support

For assistance contact support@sahha.ai or join our Slack Community .

Previous
Get Started