Get Breakdown
get_breakdownBreak down analytics metrics by dimension (page, source, country, etc.) to identify top pages, traffic sources, or segment your audience.
Instructions
Break down metrics by a dimension: page, traffic source, country, device, etc. Use to find top pages, sources, or segment traffic.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| page | No | Filter by page path. Exact match by default, use * as trailing wildcard (e.g. /blog*) | |
| limit | No | Max results to return | |
| metrics | No | Metrics to return. Defaults vary by tool. | |
| site_id | No | Plausible site domain (e.g. example.com). Uses PLAUSIBLE_DEFAULT_SITE_ID if omitted. | |
| dimension | Yes | Dimension to group results by | |
| date_range | Yes | Date range: "7d", "30d", "12mo", "month", "year", "all", or "YYYY-MM-DD,YYYY-MM-DD" |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| metrics | Yes | Metric keys, in the order they appear in each row's `metrics` array | |
| results | Yes | One row per dimension-value combination returned by Plausible | |
| dimensions | Yes | Dimension keys, in the order they appear in each row's `dimensions` array |