Sign in
latestSwagger 2.0BSD License2026-08-107753105.4 KB

52b0eb5e8b96

profile

Sleep Summary

Provides summarized sleep data.

get/profile/{profile_public_id}/sleep_summary/

Query parameters

cursorstring

The pagination cursor value.

page_sizeinteger

Number of results to return per page.

date_startstring date-time

Lower bound of date or timestamp.

date_endstring date-time

Upper bound of date or timestamp.

detailboolean

If set to true and only 1 result is returned, it will add a detail field

Response

OK

timestampstring date-time required

Starting UTC time of the measurement.

durationstring nullable

Duration of the measurement.

timestamp_endstring date-time
source'AGGREGATED' | 'ANDROID' | 'APPLE' | 'FITBIT' | 'GARMIN' | 'GOOGLE_HEALTH' | 'GOOGLEFIT' | 'HEALTHCONNECT' | 'HUAWEI' | 'MYZONE' | 'OMH' | 'OMRON' | 'OURA' | 'POLAR' | 'SAMSUNG' | 'STRAVA' | 'SUUNTO' | 'WF' | 'WHOOP' | 'WITHINGS' required

Origin of the data.

is_manualboolean nullable

Whether the data was entered manually.

{"stackTrail":"components:schemas:SleepSummary:properties:awake","oasType":"schema","type":"unknown","title":"Awake","description":"Time awake."}
{"stackTrail":"components:schemas:SleepSummary:properties:light","oasType":"schema","type":"unknown","title":"Light","description":"Time in light sleep."}
{"stackTrail":"components:schemas:SleepSummary:properties:deep","oasType":"schema","type":"unknown","title":"Deep","description":"Time in deep sleep."}
{"stackTrail":"components:schemas:SleepSummary:properties:rem","oasType":"schema","type":"unknown","title":"Rem","description":"Time in REM sleep."}
sleep_scoreinteger nullable

Sleep score