Break down website metrics
get_metricsRetrieve ranked aggregate Umami metrics such as paths, referrers, countries, devices, events, channels, or URLs with customizable filters and date ranges.
Instructions
Get a ranked aggregate Umami metric breakdown such as paths, referrers, countries, devices, events, channels or URLs. Visitor identifiers are excluded from the core toolset.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| end | Yes | Unix milliseconds, ISO 8601 with timezone, or YYYY-MM-DD (UTC) | |
| type | Yes | ||
| limit | No | ||
| start | Yes | Unix milliseconds, ISO 8601 with timezone, or YYYY-MM-DD (UTC) | |
| offset | No | ||
| search | No | ||
| filters | No | ||
| websiteId | Yes | Umami UUID |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| data | Yes | ||
| meta | Yes |