POpolar-com
SleepWise™

Circadian bedtime period data (date range)

Changed on

Get user's circadian bedtime period data for given date range. Maximum date range between from and to cannot be more than 28 days. <a href="https://support.polar.com/en/polar-sleepwise"> Supported devices </a>

get/v3/users/sleepwise/circadian-bedtime/date

Request

Query parameters

fromstring date required

Inclusive start date of range as ISO-8601 date string, example: "2022-01-01"

tostring date required

Inclusive end date of range as ISO-8601 date string, example: "2022-01-28"

Response

Request was successful.

validity'VALIDITY_UNKNOWN' | 'VALIDITY_RESET' | 'VALIDITY_NOT_VALID' | 'VALIDITY_ESTIMATE' | 'VALIDITY_VALID'

Validity

quality'CIRCADIAN_BEDTIME_QUALITY_UNKNOWN' | 'CIRCADIAN_BEDTIME_QUALITY_WEAK' | 'CIRCADIAN_BEDTIME_QUALITY_COMPROMISED' | 'CIRCADIAN_BEDTIME_QUALITY_CLEARLY_RECOGNIZABLE'

Quality

result_type'CIRCADIAN_BEDTIME_TYPE_UNKNOWN' | 'CIRCADIAN_BEDTIME_TYPE_PREDICTION' | 'CIRCADIAN_BEDTIME_TYPE_HISTORY'

Result type

period_start_timestring date-time

Circadian bedtime period start time (UTC)

period_end_timestring date-time

Circadian bedtime period end time (UTC)

preferred_sleep_period_start_timestring date-time

Circadian bedtime preferred sleep period start time (UTC)

preferred_sleep_period_end_timestring date-time

Circadian bedtime preferred sleep period end time (UTC)

sleep_gate_start_timestring date-time

Circadian bedtime sleep gate (suggested fall a sleep window) start time (UTC)

sleep_gate_end_timestring date-time

Circadian bedtime sleep gate (suggested fall a sleep window) end time (UTC)

sleep_timezone_offset_minutesinteger

Sleep timezone offset minutes

Example response

[
  {
    "validity": "VALIDITY_ESTIMATE",
    "quality": "CIRCADIAN_BEDTIME_QUALITY_COMPROMISED",
    "result_type": "CIRCADIAN_BEDTIME_TYPE_HISTORY",
    "period_start_time": "2022-11-20T21:18:30",
    "period_end_time": "2022-11-21T05:18:30",
    "preferred_sleep_period_start_time": "2022-11-20T21:18:30",
    "preferred_sleep_period_end_time": "2022-11-21T05:18:30",
    "sleep_gate_start_time": "2022-11-20T21:03:30",
    "sleep_gate_end_time": "2022-11-20T21:33:30",
    "sleep_timezone_offset_minutes": 120
  }
]

Changes

  • 18ce96365320Revision changes
    • breaking

      the / response's property format changed from date to date-time for status

    • breaking

      the / response's property format changed from date to date-time for status

    • breaking

      the / response's property format changed from date to date-time for status

    • breaking

      the / response's property format changed from date to date-time for status

    • breaking

      the / response's property format changed from date to date-time for status

    • breaking

      the / response's property format changed from date to date-time for status

  • f197848bba31Revision changes
    • info

      api tag SleepWise&trade; added

    • info

      api tag SleepWise&trade; (Beta) removed