Health

Get rest/recovery summary with sleep and stress data

Returns sleep score, deep rest duration, and stress levels

get/api/health/rest-summary

Request

  • Base URL
    https://api.hiyd.ai
  • Auth
    HTTP bearer

Query parameters

datestring date
Example:2026-01-24

Date for the summary (defaults to today)

time_zonestring
Example:America/Los_Angeles

IANA zone the client lives in. Demo sleep rows are attributed to the wake day in this zone. Band nights need no zone. Omitted or unrecognised values mean UTC.

Response

Rest summary data. sleep.source is 'band', 'demo' or null. skin_temp holds last night's wrist skin temperature (°C, sleep window only), the median of the previous 14 nights as baseline (needs 3 nights) and the deviation between them; null while there is not enough data.

Changes

No recorded changes to this operation across all 1 revision of this API.