POpolar-com
SleepWise™

Alertness period data (date range)

Changed on

Get user's alertness 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/alertness/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.

gradenumber double

Grade

grade_validity_secondsinteger

Grade validity seconds

grade_type'GRADE_TYPE_UNKNOWN' | 'GRADE_TYPE_PRIMARY' | 'GRADE_TYPE_ADDITIONAL'

Grade type

grade_classification'GRADE_CLASSIFICATION_UNKNOWN' | 'GRADE_CLASSIFICATION_WEAK' | 'GRADE_CLASSIFICATION_FAIR' | 'GRADE_CLASSIFICATION_STRONG' | 'GRADE_CLASSIFICATION_EXCELLENT'

Grade classification

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

Validity

sleep_inertia'SLEEP_INERTIA_UNKNOWN' | 'SLEEP_INERTIA_NO_INERTIA' | 'SLEEP_INERTIA_MILD' | 'SLEEP_INERTIA_MODERATE' | 'SLEEP_INERTIA_HEAVY'

Sleep inertia

sleep_type'SLEEP_TYPE_UNKNOWN' | 'SLEEP_TYPE_PRIMARY' | 'SLEEP_TYPE_SECONDARY' | 'SLEEP_TYPE_ARTIFICIAL'

Sleep type

result_type'ALERTNESS_TYPE_UNKNOWN' | 'ALERTNESS_TYPE_PREDICTION' | 'ALERTNESS_TYPE_HISTORY'

Result type

period_start_timestring date-time

Alertness period start time (UTC)

period_end_timestring date-time

Alertness period end time (UTC)

sleep_period_start_timestring date-time

Sleep period start time (UTC)

sleep_period_end_timestring date-time

Sleep period end time (UTC)

sleep_timezone_offset_minutesinteger

Sleep timezone offset minutes

Example response

[
  {
    "grade": 9.9,
    "grade_validity_seconds": 57600,
    "grade_type": "GRADE_TYPE_PRIMARY",
    "grade_classification": "GRADE_CLASSIFICATION_STRONG",
    "validity": "VALIDITY_ESTIMATE",
    "sleep_inertia": "SLEEP_INERTIA_MILD",
    "sleep_type": "SLEEP_TYPE_PRIMARY",
    "result_type": "ALERTNESS_TYPE_HISTORY",
    "period_start_time": "2022-11-20T20:52:20",
    "period_end_time": "2022-11-21T19:15:52",
    "sleep_period_start_time": "2022-11-20T20:52:20.57",
    "sleep_period_end_time": "2022-11-21T04:11:20.57",
    "sleep_timezone_offset_minutes": 120,
    "hourly_data": [
      {
        "validity": "VALIDITY_ESTIMATE",
        "alertness_level": "ALERTNESS_LEVEL_LOW",
        "start_time": "2022-11-21T04:12:00",
        "end_time": "2022-11-21T05:00:00"
      }
    ]
  }
]

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