POpolar-com
Nightly Recharge

Get Nightly Recharge

Changed on

Get Users Nightly Recharge data for given date.

get/v3/users/nightly-recharge/{date}

Request

Path parameters

datestring required

Date of Nightly Recharge as ISO-8601 date string, example: "2020-01-01"

Response

Request was successful.

polar_userstring

Absolute link to user owning the sleep

datestring date

Result date of the Nightly Recharge

heart_rate_avginteger

Average heart rate as beats per minute (bpm) during a 4-hour period starting at 30 minutes after falling asleep.

beat_to_beat_avginteger

Average time in milliseconds (ms) between successive heart beats during a 4-hour period starting at 30 minutes after falling asleep.

heart_rate_variability_avginteger

Average variation in the time in milliseconds (ms) between successive heart beats during a 4-hour period starting at 30 minutes after falling asleep. The Heart rate variability is Root Mean Square of Successive Differences (RMSSD) in beat-to-beat intervals.

breathing_rate_avgnumber float

Average breathing rate as breaths per minute (bpm) during a 4-hour period starting at 30 minutes after falling asleep.

nightly_recharge_statusinteger

The Nightly Recharge status shows how your body was able to recover from training and stress during the night. Scores for both ANS charge and sleep charge are taken into account. Nightly Recharge status has the following (6-item) scale: very poor (1) – poor (2) – compromised (3) – OK (4) – good (5) – very good (6).

ans_chargenumber float

ANS stands for autonomic nervous system. ANS charge is formed by measuring heart rate, heart rate variability and breathing rate during roughly the first four hours of your sleep. It is formed comparing your last night to your usual levels from the past 28 days. The scale is from -10.0 to +10.0. Around zero is your usual level.

ans_charge_statusinteger

ANS charge status = much below usual (1) - below usual (2) - usual (3) - above usual (4) - much above usual (5)

hrv_samplesobject

5-minute average samples of heart rate variability. Unit of samples is milliseconds(ms).

breathing_samplesobject

5-minute average samples of breathing rate. Unit of samples is breaths per minute (bpm).

Example response

{
  "polar_user": "https://www.polaraccesslink/v3/users/1",
  "date": "2020-01-01",
  "heart_rate_avg": 70,
  "beat_to_beat_avg": 816,
  "heart_rate_variability_avg": 28,
  "breathing_rate_avg": 14.1,
  "nightly_recharge_status": 3,
  "ans_charge_status": 3,
  "hrv_samples": {
    "00:41": 14,
    "00:46": 14,
    "00:51": 15
  },
  "breathing_samples": {
    "00:39": 13.4,
    "00:44": 13.5,
    "00:49": 13.5
  }
}

Changes