For the complete documentation index, see llms.txt. This page is also available as Markdown.

How do getSleep start and end date filters work?

getSleep(startDate, endDate) returns sleep sessions for that window, and the end time is not ignored.

getSleep(startDate, endDate) returns sleep sessions for that window, and the end time is not ignored.

  • iOS: the HealthKit query uses strictEndDate, so a session is returned if its end time falls within your range. A 22:00 to 07:00 sleep is returned by a midnight-to-now call because 07:00 is inside the window.

  • Android Health Connect: an overlap-based filter is used and the tail is widened internally, so any session overlapping the window is returned.

A midnight today to now range reliably catches last night's sleep on both platforms.

Last updated

Was this helpful?