Break down website metrics
get_metricsRetrieves ranked aggregate Umami analytics breakdowns by metric type—paths, referrers, countries, devices, events, channels, or URLs—for a website and date range.
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.
Tool call template
Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {
"websiteId": "<websiteId>",
"start": "<start>",
"end": "<end>",
"type": "<type>"
},
"name": "get_metrics"
}
}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 |