Get website stats
get_statsRetrieve aggregate website metrics—pageviews, visitors, visits, bounces, and time spent—over a specified date range with automatic comparison to the previous period.
Instructions
Aggregate metrics for a website over a date range: pageviews, visitors (unique sessions), visits, bounces (single-pageview sessions), and totaltime (seconds). Includes a previous-period comparison by default.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| os | No | ||
| tag | No | ||
| url | No | ||
| city | No | ||
| host | No | ||
| endAt | No | Explicit end — ISO 8601, YYYY-MM-DD, or epoch milliseconds. Defaults to now. | |
| event | No | ||
| query | No | ||
| range | No | Relative window: "24h", "7d", "30d", "12w", "today", "yesterday", "this-week", "last-month", "this-year". Ignored when startAt/endAt are set. Default "7d". | |
| title | No | ||
| device | No | ||
| region | No | ||
| browser | No | ||
| compare | No | Comparison window: "prev" (default) or "yoy". | |
| country | No | ||
| startAt | No | Explicit start — ISO 8601, YYYY-MM-DD, or epoch milliseconds. Overrides range. | |
| language | No | ||
| referrer | No | ||
| websiteId | Yes | Umami website UUID (obtain from list_websites). |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| endAt | Yes | ||
| stats | No | ||
| startAt | Yes | ||
| websiteId | Yes |