--- title: "Get Sleep" method: GET path: "/v3/users/sleep/{date}" tags: ["Sleep"] --- # Get Sleep `GET /v3/users/sleep/{date}` ## Request - Base URL: `https://www.polaraccesslink.com` - URL: `https://www.polaraccesslink.com/v3/users/sleep/{date}` - Auth: OAuth 2 - Authorization code: `https://flow.polar.com/oauth2/authorization` - Token URL: `https://polarremote.com/v2/oauth2/token` scopes: `accesslink.read_all` - TypeScript: (a function with typed inputs; its response is checked against the schema) Get Users sleep data for given date. ## Path parameters - `date` string, required ## Response `200` Request was successful. - Sleep - `polar_user` string: Absolute link to user owning the sleep - `date` string, date: Result date of the sleep - `sleep_start_time` string, date-time: Start timestamp of the sleep as ISO-8601 datetime string - `sleep_end_time` string, date-time: End timestamp of the sleep as ISO-8601 datetime string - `device_id` string: Id of the device the sleep was measured with - `continuity` number, float: Continuity is an estimate of how continuous the sleep was on a scale of 1.0 – 5.0, where 5.0 reflects uninterrupted sleep. The lower the value the more fragmented the sleep was. - `continuity_class` integer: Verbal assessments of sleep continuity Very continuous sleep (5) Continuous sleep (4) Fairly continuous sleep (3) Fairly fragmented sleep (2) Fragmented sleep (1) - `light_sleep` integer: Total time in seconds spent in light sleep stage between when you fell asleep and when you woke up. Corresponds to N1+ N2 according to AASM classification. - `deep_sleep` integer: Total time in seconds spent in the deep sleep stage between when you fell asleep and when you woke up. Corresponds to N3 according to AASM classification. - `rem_sleep` integer: Total time in seconds spent in REM sleep stage between when you fell asleep and when you woke up. REM stands for rapid eye movement. - `unrecognized_sleep_stage` integer: Total time in seconds spent in unrecognised sleep stage. Sometimes it's impossible to recognize sleep stages. This might happen when, for example, the wrist strap is not tight enough, or if you sleep on your hand. - `sleep_score` integer: Sleep score summarizes the amount and quality of your sleep into a single number on a scale of 1 – 100. Sleep score tells you how well you slept compared to the indicators of a good night's sleep based on the current sleep science. It consists of six components; sleep time, long interruptions, continuity, actual sleep, REM sleep, and deep sleep. - `total_interruption_duration` integer: The total time in seconds you spent awake between when you fell asleep and when you woke up. - `sleep_charge` integer: Sleep score compared to your usual level from the past 28 days.Scale: much below usual (1) – below usual (2) – usual (3) – above usual (4) – much above usual(5). - `sleep_goal` integer: Time goal in seconds for sleep selected by user. A default value of the setting is based on age-related sleep duration recommendations. - `sleep_rating` integer: Numeric value given by user for representing the quality of sleep. Selection scale: Very poorly(1), poorly(2), ok(3), well(4), very well(5). 0 means no value is given. - `short_interruption_duration` integer: Total time in seconds of short interruptions. Short interruption is interruption in sleep of less than 90 seconds. - `long_interruption_duration` integer: Total time in seconds of long interruptions. Long interruption is interruption in sleep of 90 seconds or more. - `sleep_cycles` integer: Number of sleep cycles. - `group_duration_score` number, float: Sleep score consists of six components that are grouped under three themes. Score for sleep duration theme looks at your sleep time compared to your ‘preferred sleep time’ setting and the age-related duration recommendations. Group duration score ranges from 1.0 to 100.0. It is interpreted as textual feedback: poor, moderate or good amount. - `group_solidity_score` number, float: Sleep score consists of six components that are grouped under three themes. Score for sleep solidity theme is the average of the component scores of long interruptions, continuity and actual sleep. Group solidity score ranges from 1.0 to 100.0. It is interpreted as textual feedback: poor, moderate or good solidity. - `group_regeneration_score` number, float: Sleep score consists of six components that are grouped under three themes. Score for regeneration theme is the average of the scores of REM sleep and deep sleep. Group regeneration score ranges from 1.0 to 100.0. It is interpreted as textual feedback: poor, moderate or good regeneration - `hypnogram` object: The time span between when you fell asleep and when you woke up is classified into light, deep or REM sleep, or unrecognised or wake in 30-s epochs. 0 = WAKE, 1 = REM, 2 = LIGHTER NON-REM, 3 = LIGHT NON-REM, 4 = DEEP NON-REM, 5 = UNKNOWN (eg. due to bad skin contact). - `heart_rate_samples` object: 5 min average samples of heart rate from the duration of the sleep. Default time between samples is 5 minutes. There may be periods with samples more often than every 5 minutes. Unit of samples is beats per minute (bpm). ## Other responses - `400`: Invalid date. - `403`: User has not accepted all mandatory consents. - `404`: No data found for date. ## Changes - **2025-06-04** `5ef2cea678a2`: 2 info - added the non-success response with the status `400` - added the non-success response with the status `403` - **2021-02-25** `425d64c3dd59`: 1 info - endpoint added [Operation history](https://skmtc.dev/polar-com/apis/polar-accesslink-api/changes/v3/users/sleep/:date/get.md) --- [API](https://skmtc.dev/polar-com/apis/polar-accesslink-api.md) - [All operations](https://skmtc.dev/polar-com/apis/polar-accesslink-api/llms.txt) - [OpenAPI document](https://skmtc.dev/polar-com/apis/polar-accesslink-api/revisions/18ce96365320?raw)