Get Umami Events Series
umami_get_events_seriesRetrieve custom event counts for a website over time, returning event name, timestamp, and count per time bucket. Filter by attributes like path, referrer, browser, or country to analyze specific segments.
Instructions
Get custom event counts for a website over time. Returns event name, timestamp, and count rows.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| websiteId | Yes | Umami website ID. Use umami_list_websites or umami_find_website first if you do not know it. | |
| startAt | Yes | An ISO 8601 datetime string or a millisecond timestamp. Example: 2026-04-23T00:00:00+08:00 or 1776873600000. | |
| endAt | Yes | An ISO 8601 datetime string or a millisecond timestamp. Example: 2026-04-23T00:00:00+08:00 or 1776873600000. | |
| unit | Yes | Time bucket unit. Allowed values: hour, day, month, year. | |
| timezone | No | IANA timezone, for example Asia/Shanghai. Defaults to UMAMI_DEFAULT_TIMEZONE when omitted. | |
| filters | No | Optional filter object shared by Umami analytics endpoints. |