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
Actionable measures of health and wellness
| Name | Description | Requires Wearable | Available Via |
|---|---|---|---|
| Wellbeing | Holistic measure combining physical, mental, and behavioral health data | No | API , Webhooks , getScores , UI |
| Activity | Evaluates daily physical activity levels and intensity | No | API , Webhooks , getScores , UI |
| Sleep | Assesses sleep quality, duration, regularity, and stages | No | API , Webhooks , getScores , UI |
| Mental Wellbeing | Measures mental wellness through behavioral pattern analysis | No | API , Webhooks , getScores , UI |
| Readiness | Gauges daily readiness and recovery metrics | No | API , Webhooks , getScores , UI |
Archetypes
Labels that capture traits and persona. All archetypes are available at weekly and monthly periodicity.
| Name | Type | Description | Requires Wearable | Available Via |
|---|---|---|---|---|
| activity_level | Ordinal | Overall level of physical activity | No | API , Webhooks |
| exercise_frequency | Ordinal | How often the individual exercises | No | API , Webhooks |
| mental_wellness | Ordinal | Mental wellness and resiliency | No | API , Webhooks |
| overall_wellness | Ordinal | Overall wellbeing across all health aspects | No | API , Webhooks |
| primary_exercise | Categorical | Most frequently performed exercise | No | API , Webhooks |
| primary_exercise_type | Categorical | Categorizes primary exercise type | No | API , Webhooks |
| secondary_exercise | Categorical | Second most frequently performed exercise | No | API , Webhooks |
| sleep_duration | Ordinal | Typical sleep duration relative to norms | No | API , Webhooks |
| sleep_efficiency | Ordinal | Sleep maintenance effectiveness | Yes | API , Webhooks |
| sleep_pattern | Categorical | Overall sleep behavior patterns | No | API , Webhooks |
| sleep_quality | Ordinal | Long-term sleep quality assessment | No | API , Webhooks |
| sleep_regularity | Ordinal | Consistency in sleep timings | No | API , Webhooks |
| bed_schedule | Ordinal | Typical bedtime patterns | No | API , Webhooks |
| wake_schedule | Ordinal | Typical wake-up time patterns | No | API , Webhooks |
View archetypes documentation →
Biomarkers
Granular metrics that track physiology and state
Activity
| Name | Unit | Periodicity | Description | Requires Wearable | Available Via |
|---|---|---|---|---|---|
| steps | count | daily | Total number of steps taken | No | API , Webhooks , getBiomarkers , UI |
| floors_climbed | count | daily | Total number of floors climbed | No | API , Webhooks , getBiomarkers , UI |
| active_hours | hour | daily | Hours with any physical activity | No | API , Webhooks , getBiomarkers , UI |
| active_duration | minute | daily | Total duration of all physical activities | No | API , Webhooks , getBiomarkers , UI |
| activity_low_intensity_duration | minute | daily | Duration in low-intensity activities (1.5-2.9 METs) | No | API , Webhooks , getBiomarkers , UI |
| activity_medium_intensity_duration | minute | daily | Duration in moderate-intensity activities (3-5.9 METs) | No | API , Webhooks , getBiomarkers , UI |
| activity_high_intensity_duration | minute | daily | Time in high-intensity activities (>6 METs) | No | API , Webhooks , getBiomarkers , UI |
| activity_sedentary_duration | minute | daily | Time spent inactive | No | API , Webhooks , getBiomarkers , UI |
| active_energy_burned | kcal | daily | Energy expended during active phases | No | API , Webhooks , getBiomarkers , UI |
| total_energy_burned | kcal | daily | Overall energy expenditure | No | API , Webhooks , getBiomarkers , UI |
Body
| Name | Unit | Periodicity | Description | Requires Wearable | Available Via |
|---|---|---|---|---|---|
| height | meter | none | Individual's stature measurement | No | API , Webhooks , SDK , UI |
| weight | kilogram | none | Total body mass | No | API , Webhooks , getBiomarkers , UI |
| body_mass_index | kg/m² | none | Body fat computation from weight and height | No | API , Webhooks , getBiomarkers , UI |
| body_fat | percentage | none | Proportion of body weight that is fat | Yes | API , Webhooks , getBiomarkers , UI |
| fat_mass | kilogram | none | Total weight of fat in the body | Yes | API , Webhooks , getBiomarkers , UI |
| lean_mass | kilogram | none | Weight of non-fat body components | Yes | API , Webhooks , getBiomarkers , UI |
| waist_circumference | meter | none | Circumference measurement around waist | No | API , Webhooks , getBiomarkers , UI |
| resting_energy_burned | kcal | daily | Energy expended at rest | No | API , Webhooks , getBiomarkers , UI |
Engagement
| Name | Unit | Periodicity | Description | Requires Wearable | Available Via |
|---|---|---|---|---|---|
| app_sessions | count | daily | Total number of app sessions opened | No | API , Webhooks , getBiomarkers , UI |
| app_session_duration | second | daily | Total time spent across all app sessions | No | API , Webhooks , getBiomarkers , UI |
| app_session_average_duration | second | daily | Average duration of each app session | No | API , Webhooks , getBiomarkers , UI |
Nutrition
| Name | Unit | Periodicity | Description | Requires Wearable | Available Via |
|---|---|---|---|---|---|
| energy_intake | kcal | daily | Total energy consumed from food and beverages | No | API , Webhooks , getBiomarkers , UI |
| water_intake | liter | daily | Total water consumed | No | API , Webhooks , getBiomarkers , UI |
| protein_intake | gram | daily | Total protein consumed | No | API , Webhooks , getBiomarkers , UI |
| fat_intake | gram | daily | Total dietary fat consumed | No | API , Webhooks , getBiomarkers , UI |
| fat_saturated_intake | gram | daily | Saturated fat consumed | No | API , Webhooks , getBiomarkers , UI |
| fat_monounsaturated_intake | gram | daily | Monounsaturated fat consumed | No | API , Webhooks , getBiomarkers , UI |
| fat_polyunsaturated_intake | gram | daily | Polyunsaturated fat consumed | No | API , Webhooks , getBiomarkers , UI |
| fat_trans_intake | gram | daily | Trans fat consumed (Android only) | No | API , Webhooks , getBiomarkers , UI |
| cholesterol_intake | milligram | daily | Total dietary cholesterol consumed | No | API , Webhooks , getBiomarkers , UI |
| carbohydrate_intake | gram | daily | Total carbohydrates consumed | No | API , Webhooks , getBiomarkers , UI |
| sugar_intake | gram | daily | Total sugars consumed | No | API , Webhooks , getBiomarkers , UI |
| fiber_intake | gram | daily | Total dietary fiber consumed | No | API , Webhooks , getBiomarkers , UI |
| vitamin_a_intake | microgram | daily | Total vitamin A consumed | No | API , Webhooks , getBiomarkers , UI |
| vitamin_c_intake | milligram | daily | Total vitamin C consumed | No | API , Webhooks , getBiomarkers , UI |
| vitamin_d_intake | microgram | daily | Total vitamin D consumed | No | API , Webhooks , getBiomarkers , UI |
| vitamin_e_intake | milligram | daily | Total vitamin E consumed | No | API , Webhooks , getBiomarkers , UI |
| vitamin_k_intake | microgram | daily | Total vitamin K consumed | No | API , Webhooks , getBiomarkers , UI |
| thiamin_intake | milligram | daily | Total thiamin (vitamin B1) consumed | No | API , Webhooks , getBiomarkers , UI |
| riboflavin_intake | milligram | daily | Total riboflavin (vitamin B2) consumed | No | API , Webhooks , getBiomarkers , UI |
| niacin_intake | milligram | daily | Total niacin (vitamin B3) consumed | No | API , Webhooks , getBiomarkers , UI |
| pantothenic_acid_intake | milligram | daily | Total pantothenic acid (vitamin B5) consumed | No | API , Webhooks , getBiomarkers , UI |
| vitamin_b6_intake | milligram | daily | Total vitamin B6 consumed | No | API , Webhooks , getBiomarkers , UI |
| biotin_intake | microgram | daily | Total biotin (vitamin B7) consumed | No | API , Webhooks , getBiomarkers , UI |
| folate_intake | microgram | daily | Total folate (vitamin B9) consumed | No | API , Webhooks , getBiomarkers , UI |
| vitamin_b12_intake | microgram | daily | Total vitamin B12 consumed | No | API , Webhooks , getBiomarkers , UI |
| calcium_intake | milligram | daily | Total calcium consumed | No | API , Webhooks , getBiomarkers , UI |
| iron_intake | milligram | daily | Total iron consumed | No | API , Webhooks , getBiomarkers , UI |
| magnesium_intake | milligram | daily | Total magnesium consumed | No | API , Webhooks , getBiomarkers , UI |
| phosphorus_intake | milligram | daily | Total phosphorus consumed | No | API , Webhooks , getBiomarkers , UI |
| potassium_intake | milligram | daily | Total potassium consumed | No | API , Webhooks , getBiomarkers , UI |
| sodium_intake | milligram | daily | Total sodium consumed | No | API , Webhooks , getBiomarkers , UI |
| zinc_intake | milligram | daily | Total zinc consumed | No | API , Webhooks , getBiomarkers , UI |
| chloride_intake | milligram | daily | Total chloride consumed | No | API , Webhooks , getBiomarkers , UI |
| copper_intake | milligram | daily | Total copper consumed | No | API , Webhooks , getBiomarkers , UI |
| manganese_intake | milligram | daily | Total manganese consumed | No | API , Webhooks , getBiomarkers , UI |
| chromium_intake | microgram | daily | Total chromium consumed | No | API , Webhooks , getBiomarkers , UI |
| molybdenum_intake | microgram | daily | Total molybdenum consumed | No | API , Webhooks , getBiomarkers , UI |
| selenium_intake | microgram | daily | Total selenium consumed | No | API , Webhooks , getBiomarkers , UI |
| iodine_intake | microgram | daily | Total iodine consumed | No | API , Webhooks , getBiomarkers , UI |
| caffeine_intake | milligram | daily | Total caffeine consumed | No | API , Webhooks , getBiomarkers , UI |
Sleep
| Name | Unit | Periodicity | Description | Requires Wearable | Available Via |
|---|---|---|---|---|---|
| sleep_start_time | datetime | daily | Time when individual falls asleep | No | API , Webhooks , getBiomarkers , UI |
| sleep_mid_time | datetime | daily | Midpoint time in the sleep cycle | No | API , Webhooks , getBiomarkers , UI |
| sleep_end_time | datetime | daily | Time when individual wakes up | No | API , Webhooks , getBiomarkers , UI |
| sleep_duration | minute | daily | Total time spent sleeping | No | API , Webhooks , getBiomarkers , UI |
| sleep_debt | hour | weekly | Discrepancy between required and actual sleep | No | API , Webhooks , getBiomarkers , UI |
| sleep_interruptions | count | daily | Count of awakenings during night | Yes | API , Webhooks , getBiomarkers , UI |
| sleep_in_bed_duration | minute | daily | Total time spent in bed | No | API , Webhooks , getBiomarkers , UI |
| sleep_awake_duration | minute | daily | Time awake after initially falling asleep | Yes | API , Webhooks , getBiomarkers , UI |
| sleep_light_duration | minute | daily | Time spent in light sleep phase | Yes | API , Webhooks , getBiomarkers , UI |
| sleep_rem_duration | minute | daily | Time spent in REM sleep phase | Yes | API , Webhooks , getBiomarkers , UI |
| sleep_deep_duration | minute | daily | Time spent in deep sleep phase | Yes | API , Webhooks , getBiomarkers , UI |
| sleep_regularity | index | weekly | Consistency of sleep patterns over time | No | API , Webhooks , getBiomarkers , UI |
| sleep_latency | minute | daily | Time to fall asleep after going to bed | Yes | API , Webhooks , getBiomarkers , UI |
| sleep_efficiency | ratio | daily | Ratio of sleep time to time in bed (0-1) | Yes | API , Webhooks , getBiomarkers , UI |
Vitals
| Name | Unit | Periodicity | Description | Requires Wearable | Available Via |
|---|---|---|---|---|---|
| heart_rate_resting | bpm | daily | Heart rate when at rest | Yes | API , Webhooks , getBiomarkers , UI |
| heart_rate_sleep | bpm | daily | Average heart rate during sleep | Yes | API , Webhooks , getBiomarkers , UI |
| heart_rate_variability_sdnn | millisecond | daily | Standard deviation of NN intervals | Yes | API , Webhooks , getBiomarkers , UI |
| heart_rate_variability_rmssd | millisecond | daily | Root mean square of successive differences | Yes | API , Webhooks , getBiomarkers , UI |
| respiratory_rate | count/minute | daily | Frequency of breaths per minute at rest | Yes | API , Webhooks , getBiomarkers , UI |
| respiratory_rate_sleep | count/minute | daily | Average respiratory rate during sleep | Yes | API , Webhooks , getBiomarkers , UI |
| oxygen_saturation | percentage | daily | Proportion of oxygen-saturated hemoglobin | Yes | API , Webhooks , getBiomarkers , UI |
| oxygen_saturation_sleep | percentage | daily | Average oxygen saturation during sleep | Yes | API , Webhooks , getBiomarkers , UI |
| vo2_max | mL/kg/min | daily | Maximum oxygen utilization during exercise | Yes | API , Webhooks , getBiomarkers , UI |
| blood_glucose | mg/dL | daily | Level of glucose in blood | Yes | API , Webhooks , getBiomarkers , UI |
| blood_pressure_systolic | mmHg | daily | Peak arterial pressure during heartbeats | Yes | API , Webhooks , getBiomarkers , UI |
| blood_pressure_diastolic | mmHg | daily | Lowest arterial pressure during heart relaxation | Yes | API , Webhooks , getBiomarkers , UI |
| body_temperature_basal | celsius | daily | Body temperature at rest | Yes | API , Webhooks , getBiomarkers , UI |
| skin_temperature_sleep | celsius | daily | Skin temperature during sleep | Yes | API , Webhooks , getBiomarkers , UI |
View biomarkers documentation →
Tags
Labels for events, states, and context
Symptom
Every symptom is logged as a point-in-time event with the same five-level severity value set: unknown, not_present, mild, moderate, severe.
| Name | Type | Possible Values | Available Via |
|---|---|---|---|
| abdominal_cramps | event | unknown, not_present, mild, moderate, severe | API , Webhooks |
| acne | event | unknown, not_present, mild, moderate, severe | API , Webhooks |
| appetite_changes | event | unknown, not_present, mild, moderate, severe | API , Webhooks |
| bladder_incontinence | event | unknown, not_present, mild, moderate, severe | API , Webhooks |
| bloating | event | unknown, not_present, mild, moderate, severe | API , Webhooks |
| breast_pain | event | unknown, not_present, mild, moderate, severe | API , Webhooks |
| chills | event | unknown, not_present, mild, moderate, severe | API , Webhooks |
| constipation | event | unknown, not_present, mild, moderate, severe | API , Webhooks |
| coughing | event | unknown, not_present, mild, moderate, severe | API , Webhooks |
| diarrhea | event | unknown, not_present, mild, moderate, severe | API , Webhooks |
| dizziness | event | unknown, not_present, mild, moderate, severe | API , Webhooks |
| dry_skin | event | unknown, not_present, mild, moderate, severe | API , Webhooks |
| fainting | event | unknown, not_present, mild, moderate, severe | API , Webhooks |
| fatigue | event | unknown, not_present, mild, moderate, severe | API , Webhooks |
| fever | event | unknown, not_present, mild, moderate, severe | API , Webhooks |
| generalized_body_ache | event | unknown, not_present, mild, moderate, severe | API , Webhooks |
| hair_loss | event | unknown, not_present, mild, moderate, severe | API , Webhooks |
| headache | event | unknown, not_present, mild, moderate, severe | API , Webhooks |
| heartburn | event | unknown, not_present, mild, moderate, severe | API , Webhooks |
| hot_flashes | event | unknown, not_present, mild, moderate, severe | API , Webhooks |
| loss_of_smell | event | unknown, not_present, mild, moderate, severe | API , Webhooks |
| loss_of_taste | event | unknown, not_present, mild, moderate, severe | API , Webhooks |
| lower_back_pain | event | unknown, not_present, mild, moderate, severe | API , Webhooks |
| memory_lapse | event | unknown, not_present, mild, moderate, severe | API , Webhooks |
| mood_changes | event | unknown, not_present, mild, moderate, severe | API , Webhooks |
| nausea | event | unknown, not_present, mild, moderate, severe | API , Webhooks |
| night_sweats | event | unknown, not_present, mild, moderate, severe | API , Webhooks |
| pelvic_pain | event | unknown, not_present, mild, moderate, severe | API , Webhooks |
| rapid_pounding_or_fluttering_heartbeat | event | unknown, not_present, mild, moderate, severe | API , Webhooks |
| runny_nose | event | unknown, not_present, mild, moderate, severe | API , Webhooks |
| shortness_of_breath | event | unknown, not_present, mild, moderate, severe | API , Webhooks |
| sinus_congestion | event | unknown, not_present, mild, moderate, severe | API , Webhooks |
| skipped_heartbeat | event | unknown, not_present, mild, moderate, severe | API , Webhooks |
| sleep_changes | event | unknown, not_present, mild, moderate, severe | API , Webhooks |
| sore_throat | event | unknown, not_present, mild, moderate, severe | API , Webhooks |
| vaginal_dryness | event | unknown, not_present, mild, moderate, severe | API , Webhooks |
| vomiting | event | unknown, not_present, mild, moderate, severe | API , Webhooks |
| wheezing | event | unknown, not_present, mild, moderate, severe | API , Webhooks |
Reproductive
Reproductive tags use a mix of event and state types, each with its own closed value set (or no value for presence-only flags).
| Name | Type | Possible Values | Available Via |
|---|---|---|---|
| menstrual_flow | event | unknown, not_present, light, medium, heavy | API , Webhooks |
| intermenstrual_bleeding | event | — | API , Webhooks |
| infrequent_menstrual_cycles | event | — | API , Webhooks |
| irregular_menstrual_cycles | event | — | API , Webhooks |
| persistent_intermenstrual_bleeding | event | — | API , Webhooks |
| prolonged_menstrual_periods | event | — | API , Webhooks |
| pregnancy | state | — | API , Webhooks |
| lactation | state | — | API , Webhooks |
| ovulation_test | event | inconclusive, negative, high, positive | API , Webhooks |
| cervical_mucus | event | unknown, dry, sticky, creamy, watery, egg_white, unusual | API , Webhooks |
| sexual_activity | event | unknown, protected, unprotected | API , Webhooks |
| contraceptive | state | unknown, implant, injection, intravaginal_ring, iud, oral, patch | API , Webhooks |
| pregnancy_test | event | inconclusive, negative, positive | API , Webhooks |
| progesterone_test | event | inconclusive, negative, positive | API , Webhooks |
Data Logs
Raw events from source, streamed in real time
Activity Logs
Blood Logs
Body Logs
Device Logs
| Name | Unit | Description | Requires Wearable | Available Via |
|---|---|---|---|---|
| device_lock | boolean | Indicates if device is locked | No | Webhooks |
Energy Logs
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 |
Nutrition Logs
Per-record dietary entries from HealthKit and Health Connect.
| Name | Unit | Description | Requires Wearable | Available Via |
|---|---|---|---|---|
| energy_intake | kcal | Energy consumed from food and beverages | No | Webhooks |
| water_intake | L | Volume of water consumed | No | Webhooks |
| protein_intake | g | Protein consumed | No | Webhooks |
| fat_intake | g | Total dietary fat consumed | No | Webhooks |
| fat_saturated_intake | g | Saturated fat consumed | No | Webhooks |
| fat_monounsaturated_intake | g | Monounsaturated fat consumed | No | Webhooks |
| fat_polyunsaturated_intake | g | Polyunsaturated fat consumed | No | Webhooks |
| fat_trans_intake | g | Trans fat consumed (Android only) | No | Webhooks |
| cholesterol_intake | mg | Dietary cholesterol consumed | No | Webhooks |
| carbohydrate_intake | g | Total carbohydrates consumed | No | Webhooks |
| sugar_intake | g | Sugars consumed | No | Webhooks |
| fiber_intake | g | Dietary fiber consumed | No | Webhooks |
| vitamin_a_intake | µg | Vitamin A consumed | No | Webhooks |
| vitamin_c_intake | mg | Vitamin C consumed | No | Webhooks |
| vitamin_d_intake | µg | Vitamin D consumed | No | Webhooks |
| vitamin_e_intake | mg | Vitamin E consumed | No | Webhooks |
| vitamin_k_intake | µg | Vitamin K consumed | No | Webhooks |
| thiamin_intake | mg | Thiamin (vitamin B1) consumed | No | Webhooks |
| riboflavin_intake | mg | Riboflavin (vitamin B2) consumed | No | Webhooks |
| niacin_intake | mg | Niacin (vitamin B3) consumed | No | Webhooks |
| pantothenic_acid_intake | mg | Pantothenic acid (vitamin B5) consumed | No | Webhooks |
| vitamin_b6_intake | mg | Vitamin B6 consumed | No | Webhooks |
| biotin_intake | µg | Biotin (vitamin B7) consumed | No | Webhooks |
| folate_intake | µg | Folate (vitamin B9) consumed | No | Webhooks |
| vitamin_b12_intake | µg | Vitamin B12 consumed | No | Webhooks |
| calcium_intake | mg | Calcium consumed | No | Webhooks |
| iron_intake | mg | Iron consumed | No | Webhooks |
| magnesium_intake | mg | Magnesium consumed | No | Webhooks |
| phosphorus_intake | mg | Phosphorus consumed | No | Webhooks |
| potassium_intake | mg | Potassium consumed | No | Webhooks |
| sodium_intake | mg | Sodium consumed | No | Webhooks |
| zinc_intake | mg | Zinc consumed | No | Webhooks |
| chloride_intake | mg | Chloride consumed | No | Webhooks |
| copper_intake | mg | Copper consumed | No | Webhooks |
| manganese_intake | mg | Manganese consumed | No | Webhooks |
| chromium_intake | µg | Chromium consumed | No | Webhooks |
| molybdenum_intake | µg | Molybdenum consumed | No | Webhooks |
| selenium_intake | µg | Selenium consumed | No | Webhooks |
| iodine_intake | µg | Iodine consumed | No | Webhooks |
| caffeine_intake | mg | Caffeine consumed | No | Webhooks |
Oxygen Logs
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
View data logs documentation →
Insights
Signals of change and consistency
Trends
| Name | Category | Description | Higher Better | Available Via |
|---|---|---|---|---|
| sleep | score | Overall sleep quality | true | API |
| activity | score | Physical activity and movement levels | true | API |
| readiness | score | Body's recovery state and preparedness | true | API |
| wellbeing | score | Holistic health combining sleep and activity | true | API |
| mental_wellbeing | score | Mental wellbeing state based on behavioral patterns | true | API |
| sleep_duration | factor | Total time spent asleep | true | API |
| sleep_regularity | factor | Consistency of sleep schedule | true | API |
| sleep_continuity | factor | Uninterrupted sleep with minimal awakenings | true | API |
| sleep_debt | factor | Accumulated sleep deficit | true | API |
| circadian_alignment | factor | Alignment with natural sleep-wake cycle | true | API |
| physical_recovery | factor | Deep sleep phase duration | true | API |
| mental_recovery | factor | REM sleep phase duration | true | API |
| steps | factor | Daily step count | true | API |
| active_hours | factor | Hours with significant physical activity | true | API |
| active_calories | factor | Calories burned during activity | true | API |
| intense_activity_duration | factor | Time spent in high-intensity activity | true | API |
| extended_inactivity | factor | Prolonged sedentary periods | true | API |
| floors_climbed | factor | Vertical movement measurement | true | API |
| activity_regularity | factor | Consistency of daily activity patterns | true | API |
| walking_strain_capacity | factor | Capacity to do low-intensity activities | null | API |
| exercise_strain_capacity | factor | Capacity to do high-intensity exercises | null | API |
| resting_heart_rate | factor | Heart rate during rest | true | API |
| heart_rate_variability | factor | Variation in time between heartbeats | true | API |
Comparisons
| Name | Category | Unit | Description | Higher Better | Available Via |
|---|---|---|---|---|---|
| sleep | score | index | Overall sleep quality | true | API |
| activity | score | index | Physical activity and movement levels | true | API |
| readiness | score | index | Body's recovery state and preparedness | true | API |
| wellbeing | score | index | Holistic health combining sleep and activity | true | API |
| mental_wellbeing | score | index | Mental wellbeing state based on behavioral patterns | true | API |
| steps | biomarker | count | Daily step count | true | API |
| sleep_duration | biomarker | minute | Total time spent asleep | true | API |
| heart_rate_resting | biomarker | bpm | Resting heart rate | false | API |
| heart_rate_variability_sdnn | biomarker | ms | HRV measured as SDNN | true | API |
| heart_rate_variability_rmssd | biomarker | ms | HRV measured as RMSSD | true | API |
| vo2_max | biomarker | ml/kg/min | Maximum oxygen uptake | true | API |
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 |
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 |
Nutrition
Granular dietary intake sensors map directly to HealthKit dietary types and are queryable per-nutrient on iOS. On Android, these data points are collected as Data Logs under the umbrella NUTRITION sensor and are not individually queryable via getSamples / getStats.
| Name | Unit | Description | Platform Support | Available Via |
|---|---|---|---|---|
| energy_intake | kcal | Energy consumed from food and beverages | iOS only | getSamples , getStats |
| water_intake | L | Volume of water consumed | iOS only | getSamples , getStats |
| protein_intake | g | Protein consumed | iOS only | getSamples , getStats |
| fat_intake | g | Total dietary fat consumed | iOS only | getSamples , getStats |
| fat_saturated_intake | g | Saturated fat consumed | iOS only | getSamples , getStats |
| fat_monounsaturated_intake | g | Monounsaturated fat consumed | iOS only | getSamples , getStats |
| fat_polyunsaturated_intake | g | Polyunsaturated fat consumed | iOS only | getSamples , getStats |
| cholesterol_intake | mg | Dietary cholesterol consumed | iOS only | getSamples , getStats |
| carbohydrate_intake | g | Total carbohydrates consumed | iOS only | getSamples , getStats |
| sugar_intake | g | Sugars consumed | iOS only | getSamples , getStats |
| fiber_intake | g | Dietary fiber consumed | iOS only | getSamples , getStats |
| vitamin_a_intake | µg | Vitamin A consumed | iOS only | getSamples , getStats |
| vitamin_c_intake | mg | Vitamin C consumed | iOS only | getSamples , getStats |
| vitamin_d_intake | µg | Vitamin D consumed | iOS only | getSamples , getStats |
| vitamin_e_intake | mg | Vitamin E consumed | iOS only | getSamples , getStats |
| vitamin_k_intake | µg | Vitamin K consumed | iOS only | getSamples , getStats |
| thiamin_intake | mg | Thiamin (vitamin B1) consumed | iOS only | getSamples , getStats |
| riboflavin_intake | mg | Riboflavin (vitamin B2) consumed | iOS only | getSamples , getStats |
| niacin_intake | mg | Niacin (vitamin B3) consumed | iOS only | getSamples , getStats |
| pantothenic_acid_intake | mg | Pantothenic acid (vitamin B5) consumed | iOS only | getSamples , getStats |
| vitamin_b6_intake | mg | Vitamin B6 consumed | iOS only | getSamples , getStats |
| biotin_intake | µg | Biotin (vitamin B7) consumed | iOS only | getSamples , getStats |
| folate_intake | µg | Folate (vitamin B9) consumed | iOS only | getSamples , getStats |
| vitamin_b12_intake | µg | Vitamin B12 consumed | iOS only | getSamples , getStats |
| calcium_intake | mg | Calcium consumed | iOS only | getSamples , getStats |
| iron_intake | mg | Iron consumed | iOS only | getSamples , getStats |
| magnesium_intake | mg | Magnesium consumed | iOS only | getSamples , getStats |
| phosphorus_intake | mg | Phosphorus consumed | iOS only | getSamples , getStats |
| potassium_intake | mg | Potassium consumed | iOS only | getSamples , getStats |
| sodium_intake | mg | Sodium consumed | iOS only | getSamples , getStats |
| zinc_intake | mg | Zinc consumed | iOS only | getSamples , getStats |
| chloride_intake | mg | Chloride consumed | iOS only | getSamples , getStats |
| copper_intake | mg | Copper consumed | iOS only | getSamples , getStats |
| manganese_intake | mg | Manganese consumed | iOS only | getSamples , getStats |
| chromium_intake | µg | Chromium consumed | iOS only | getSamples , getStats |
| molybdenum_intake | µg | Molybdenum consumed | iOS only | getSamples , getStats |
| selenium_intake | µg | Selenium consumed | iOS only | getSamples , getStats |
| iodine_intake | µg | Iodine consumed | iOS only | getSamples , getStats |
| caffeine_intake | mg | Caffeine consumed | iOS only | getSamples , getStats |
Support
For assistance contact support@sahha.ai or join our Slack Community .
- Previous
- Quickstart
- Next
- SDK