Streaming Logs

Streaming Logs offer a detailed and unprocessed stream of data across various health metrics. This raw data is useful for in-depth health analysis, research, and discovery. It acts as the foundational layer for advanced applications.

Data Points in Streaming Logs

Below are the key data types captured in Streaming Logs, categorized by their respective health aspects. The logs can be streamed via webhooks for real-time data reception.

Activity Logs

Data Type	Unit	Description	Webhook Event
custom_step_sessions	count	Customizable sessions tracking steps.	Activity log received
exercise_time	minute	Duration of physical exercise.	Activity log received
floor_count	count	Number of floors climbed.	Activity log received
stand_time	minute	Time spent standing.	Activity log received
step_count	count	Total steps taken.	Activity log received

Blood Logs

Data Type	Unit	Description	Webhook Event
blood_glucose	mg/dL	Glucose levels in the blood.	Blood log received
blood_pressure_diastolic	mmHg	Diastolic blood pressure.	Blood log received
blood_pressure_systolic	mmHg	Systolic blood pressure.	Blood log received

Body Logs

Data Type	Unit	Description	Webhook Event
body_fat	percent	Percentage of body fat.	Body log received
body_mass_index	count	Body Mass Index (BMI).	Body log received
lean_body_mass	kg	Weight of lean body mass.	Body log received
weight	kg	Total body weight.	Body log received

Device Logs

Data Type	Unit	Description	Webhook Event
device_lock	boolean	Indicates if the device is locked.	Device log received

Energy Logs

Data Type	Unit	Description	Webhook Event
active_energy_burned	kcal	Calories burned through activity.	Energy log received
basal_energy_burned	kcal	Calories burned at rest.	Energy log received
time_in_daylight	minute	Time spent in natural daylight.	Energy log received

Heart Logs

Data Type	Unit	Description	Webhook Event
heart_rate	bpm	Beats per minute.	Heart log received
heart_rate_variability	ms	Variation in intervals between heartbeats.	Heart log received
heart_rate_variability_sdnn	ms	Standard deviation of NN intervals.	Heart log received
resting_heart_rate	bpm	Heart rate at rest.	Heart log received
walking_heart_rate_average	bpm	Average heart rate while walking.	Heart log received

Oxygen Logs

Data Type	Unit	Description	Webhook Event
oxygen_saturation	percent	Percentage of oxygen-saturated hemoglobin.	Oxygen log received
respiratory_rate	bps	Breaths per second.	Oxygen log received
vo2_max	ml/kg/min	Maximum rate of oxygen consumption during exercise.	Oxygen log received

Sleep Logs

Data Type	Unit	Description	Webhook Event
sleep_stage_asleep_unspecified	minute	Duration in unspecified asleep stage.	Sleep log received
sleep_stage_awake	minute	Duration in awake stage.	Sleep log received
sleep_stage_awake_in_or_out_of_bed	minute	Duration awake in or out of bed.	Sleep log received
sleep_stage_deep	minute	Duration in deep sleep stage.	Sleep log received
sleep_stage_in_bed	minute	Duration in bed, not necessarily asleep.	Sleep log received
sleep_stage_light	minute	Duration in light sleep stage.	Sleep log received
sleep_stage_rem	minute	Duration in REM sleep stage.	Sleep log received
sleep_stage_sleeping	minute	Total sleeping duration.	Sleep log received
sleep_stage_unknown	minute	Duration in unknown sleep stage.	Sleep log received

Temperature Logs

Data Type	Unit	Description	Webhook Event
basal_body_temperature	degC	Body temperature at rest.	Body log received
sleeping_wrist_temperature	degC	Temperature measured at the wrist during sleep

Enabling Sensors on SDK

Sensor	Android Permissions	iOS Permissions
sleep	SleepSession	SleepAnalysis
activity	Steps, FloorsClimbed	StepCount, FlightsClimbed, MoveTime, StandTime, ExerciseTime, ActivitySummary
device	PhysicalActivity	X
heart	HeartRate, RestingHeartRate, HeartRateVariabilityRmssd	HeartRate, RestingHeartRate, WalkingHeartRateAverage, HeartRateVariabilitySDNN
blood	BloodPressure, BloodGlucose	BloodPressureSystolic, BloodPressureDiastolic, BloodGlucose
oxygen	OxygenSaturation, RespiratoryRate, Vo2Max	VO2Max, OxygenSaturation, RespiratoryRate
energy	ActiveCaloriesBurned, BasalMetabolicRate, TotalCaloriesBurned	ActiveEnergyBurned, BasalEnergyBurned, TimeInDaylight
body	Height, Weight, BodyFat, BodyWaterMass, BoneMass, LeanBodyMass	Height, Weight, LeanBodyMass, BodyMassIndex, BodyFat, WaistCircumference
temperature	BodyTemperature, BasalBodyTemperature	BodyTemperature, BasalBodyTemperature, AppleSleepingWristTemperature
exercise	Exercise	Workout

Output Schema for Streaming Logs

When you receive data from Streaming Logs, it comes in a structured format, or "schema," that looks like this:

[
	{
		"DataType": "heart_rate",
		"Value": 55,
		"Unit": "bpm",
		"Source": "iPhone X",
		"RecordingMethod": "RECORDING_METHOD_UNKNOWN",
		"DeviceType": "iPhone13,2",
		"StartDateTime": "2022-01-01T00:00:00+12:00",
		"EndDateTime": "2022-01-01T00:00:00+12:00"
	}
]

• DataType : Specifies what kind of health data is being logged, such as heart_rate or step_count.
• Value : The recorded value for the data type.
• Unit : The measurement unit for the Value, like beats per minute (bpm) or count.
• Source : Identifies where or what device the data came from.
• RecordingMethod : Describes how the data was collected, which might not always be specified.
• DeviceType : The specific type or model of the device that recorded the data.
• StartDateTime : When the data recording started, in an ISO 8601 format.
• EndDateTime : When the data recording ended, also in an ISO 8601 format.