Get event activity
get_eventsRetrieve a time series of custom event counts for a website, grouped by minute, hour, day, month, or year.
Instructions
Custom-event activity over time for a website, bucketed by unit. Returns a time series of event counts. For a ranked list of event names use get_metrics(type='event').
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| unit | No | Bucket size (default day). | |
| 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 | ||
| endAt | Yes | ||
| startAt | Yes | ||
| websiteId | Yes |