The days ahead by phase
get_week_aheadRead-onlyIdempotent
The days ahead by phase. Use when the user wants to plan training or meals for the week, for example "plan my training this week around my cycle". Returns each day's likely phase, workout focus, intensity and food focus. Not for getting pregnant, fertile days, ovulation timing, contraception or pregnancy: this is general wellbeing only, not for pregnancy planning or contraception, and it is not a fertility calendar. When period_may_be_late is true, days is empty and the say line suggests checking with a doctor
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| tz | No | The user's IANA time zone, for example Europe/London or America/Chicago, so today is the user's today. Optional: country is enough in most places. | |
| date | No | First day of the plan, YYYY-MM-DD, a real calendar day. Default today where the user is: from tz, else country, else the request, else UTC. | |
| days | No | How many days, a whole number from 1 to 35. Default 7. | |
| diet | No | Accepted for symmetry with /v1/today; the week view has no food list, so it has no effect here. | |
| country | No | Two-letter country code (UK is read as GB), used for the time zone of today. Pass it for users outside the US. | |
| last_period | Yes | First day of the user's most recent period, YYYY-MM-DD. Must be within the last 120 days. | |
| cycle_length | No | Usual cycle length, 20 to 45. Default 28. | |
| period_length | No | Usual days of bleeding, 2 to 10. Default 5. | |
| last_period_start | No | Older name for last_period, kept for existing callers. Use last_period. |