Retention report
report_retentionTrack user retention by analyzing cohort data showing how many users return on subsequent days. Specify website, date range, and timezone for precise insights.
Instructions
Cohort retention over the selected period (how many users return on subsequent days).
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| endAt | No | Explicit end — ISO 8601, YYYY-MM-DD, or epoch milliseconds. Defaults to now. | |
| range | No | Relative window: "24h", "7d", "30d", "12w", "today", "yesterday", "this-week", "last-month", "this-year". Ignored when startAt/endAt are set. Default "7d". | |
| startAt | No | Explicit start — ISO 8601, YYYY-MM-DD, or epoch milliseconds. Overrides range. | |
| timezone | No | IANA timezone for bucketing (e.g. America/New_York). Defaults to the server's configured tz. | |
| websiteId | Yes | Umami website UUID (obtain from list_websites). |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| data | No |