Menstrual cycle
get_menstrual_cycleRead recent menstrual cycle data and predict the next period from opted-in Apple Health samples, optionally for a shared partner cycle.
Instructions
Decrypt recent menstrual cycle data locally and predict the next period.
SENSITIVE: menstrual data only reaches this server if the user explicitly opted
in on iOS; it stays on-device and is never re-exported. Returns recent samples plus
a next-period prediction. Reads YOUR cycle by default; if the cycle being
asked about is your partner's, pass partner=true (it reaches this server
only if they share it).
Carries a coverage block: quote coverage.days_covered (distinct days, not
the row count) and coverage.span_days beside any average or trend.
coverage.window_satisfied: false alone does NOT mean a short history: it is
also false when older days exist beyond your window. π΄ Before saying how far
back someone's data goes, read coverage.more_available: true means this
server can decrypt days OLDER than first_day that your limit left behind β
re-read with a larger limit, or quote coverage.oldest_available as the real
start of their history. Never report a limit-shaped window as the extent of
their data.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| fresh | No | ||
| limit | No | ||
| partner | No |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||