Get Umami Breakdown
umami_get_breakdownGet metric breakdowns for a website by dimension (path, country, browser, etc.) over a time range. Use expanded=true for detailed metrics or expanded=false for x/y rows.
Instructions
Get a metric breakdown for a website and time range. Use expanded=true for detailed metrics or expanded=false for x/y breakdown 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. | |
| type | Yes | Breakdown dimension. Supported values: path, entry, exit, title, query, referrer, channel, domain, country, region, city, browser, os, device, language, screen, event, hostname, tag, distinctId. | |
| limit | No | Maximum number of rows to return. Umami defaults to 500 when omitted. | |
| offset | No | Number of rows to skip. Defaults to 0 when omitted. | |
| expanded | No | Set to true to call /metrics/expanded instead of /metrics. | |
| filters | No | Optional filter object shared by Umami analytics endpoints. |