Get metric breakdown
get_metricsRetrieves ranked breakdown of website metrics by dimension (pages, referrers, events, etc.) over a date range. Returns top values with counts, supporting filters like search, url, and country.
Instructions
Top-N breakdown of a website by a single dimension (type) over a date range. Returns ranked { x: value, y: count } rows. Use type=event for custom-event counts. url is an alias for path.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| os | No | ||
| tag | No | ||
| url | No | ||
| city | No | ||
| host | No | ||
| type | Yes | Dimension to break down by. | |
| endAt | No | Explicit end — ISO 8601, YYYY-MM-DD, or epoch milliseconds. Defaults to now. | |
| event | No | ||
| limit | No | Max rows (default 50). | |
| 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 | ||
| search | No | Substring filter on the dimension value. | |
| browser | No | ||
| 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 |
|---|---|---|---|
| data | Yes | ||
| type | Yes | ||
| count | Yes | ||
| websiteId | Yes |