com.samsung.health.sleep_stage

This data type defines the detailed sleep stage for the specified sleep data.

Propertyy Type Description
"datauuid" string [Mandatory]
Unique ID for each health data.
This value should be format of UUID, the 32 hexadecimal digits displayed in five groups separated by hyphens in the form 8-4-4-4-12. It is highly encouraged to generate it using random UUID generator.
  • Value length: 10 ~ 36

"create_time" long [Mandatory]
UTC milliseconds when a data is created in the health data store.
It is different with "start_time" that indicates the start time for measurement.
  • Value range: 0 and above

"update_time" long [Mandatory]
UTC milliseconds when a data is updated.
You don't need to set its value. When a new data is inserted, it is assigned as the same value with "create_time" by the system. Then it is replaced to the updated time by the system if existing health data is updated.
  • Value range: 0 and above

"pkg_name" string [Mandatory]
Package name which provides a data.
You don't need to set its value because it is assigned by the system when a new data is inserted.
  • Value length: 0 ~ 64

"deviceuuid" string [Mandatory]
Device identifier of the source device which provides a health data.
  • Value length: 10 ~ 36

"start_time" long [Mandatory]
UTC milliseconds when the measurement is started.
"time_off" needs to set for showing the data's measured time properly.
  • Value range: 0 and above

"end_time" long [Mandatory]
UTC milliseconds after the measurement has ended.
"time_off" needs to set for showing the data's measured time properly.
  • Value range: equal or bigger than "start_time"

"time_offset" long [Mandatory]
Time offset in milliseconds which considers the time zone and daylight saving time.
E.g. Tehran (UTC+3:30) is presented as 12600000 (3.5 * 60 * 60 * 1000).
It affects to "start_time" to show the measured time properly to the user.
  • Value range: -43200000 (-12 * 60 * 60 * 1000) ~ 50400000 (14 * 60 * 60 * 1000)

"sleep_id" string [Mandatory]
The specified sleep data's ID.
  • Value length: 10 ~ 36

"stage" int [Mandatory]
Sleep stage.
  • Available values: one of the following values

Value Description
40001 Awaken stage of sleep.
Eyes open. Responsive to external stimuli.
40002 Light stage of sleep.
Breathing slows down and heartbeat becomes regular.
Typically lasts between 1 and 20 minutes after falling asleep.
40003 Deep stage of sleep.
Brain waves slow down and become larger. Typically starts 35 - 45 minutes after falling asleep.
40004 REM (Rapid Eye Movement) stage of sleep.
Brain waves similar to waking. Most vivid dreams happen in this stage. Body does not move.
"custom" blob Custom info which is formatted with JSON and compressed data.