Sleep data type

Data type to capture sleep stages.

Sleep

This data type captures the user's length and type of sleep. Each data point represents a time interval for a stage of sleep.

The start time of the data point represents the start of the sleep stage and always needs to be included. The timestamp represents the end of the sleep stage. Time intervals don't need to be continuous but shouldn't overlap.

REST

Name com.google.sleep.segment

OAuth permission scopes

https://www.googleapis.com/auth/fitness.sleep.read

https://www.googleapis.com/auth/fitness.sleep.write

Fields (format—units)

sleep segment type (int—enum)

Values representing different sleep stages and types.

Accepted values

"intVal": 0 // Unspecified or unknown if user is sleeping.
"intVal": 1 // Awake; user is awake.
"intVal": 2 // Sleeping; generic or non-granular sleep description.
"intVal": 3 // Out of bed; user gets out of bed in the middle of a sleep session.
"intVal": 4 // Light sleep; user is in a light sleep cycle.
"intVal": 5 // Deep sleep; user is in a deep sleep cycle.
"intVal": 6 // REM sleep; user is in a REM sleep cyle.

Android

Name com.google.sleep.segment

Data type object TYPE_SLEEP_SEGMENT

Fields (format—units)

FIELD_SLEEP_SEGMENT_TYPE (int—enum)

Values representing different sleep stages and types.

Accepted values

SLEEP_SEGMENT_TYPE_UNSPECIFIED // Unspecified or unknown if user is sleeping.
AWAKE // Awake; user is awake.
SLEEP // Sleeping; generic or non-granular sleep description.
OUT_OF_BED // Out of bed; user gets out of bed in the middle of a sleep session.
SLEEP_LIGHT // Light sleep; user is in a light sleep cycle.
SLEEP_DEEP // Deep sleep; user is in a deep sleep cycle.
SLEEP_REM // REM sleep; user is in a REM sleep cyle.