Get Umami Pageviews Series
umami_get_pageviewsFetch pageview and session time series for a website using configurable time buckets, timezone, period comparison, and shared filters like path or referrer.
Instructions
Get pageview and session time series for a website. Supports time bucketing, timezone, period comparison, and shared filters.
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. | |
| compare | No | Optional comparison mode. Use prev for previous period or yoy for year-over-year. | |
| filters | No | Optional filter object shared by Umami analytics endpoints. |