get_breakdown
Retrieve analytics breakdown by dimensions such as top pages, traffic sources, or countries. Use natural date keywords like 'yesterday' to get ranked data.
Instructions
Break stats down by one or more dimensions — top pages, traffic sources, countries, devices, browsers, UTM tags, etc. Returns ranked rows. Use for 'top pages yesterday', 'where did traffic come from last week', and similar.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| site_id | No | Site domain (e.g. example.com). | |
| dimensions | Yes | What to group by. Common: 'event:page' (top pages), 'visit:source' (sources), 'visit:country_name' (countries), 'visit:device', 'visit:browser'. | |
| date_range | No | Time period. Friendly keywords (resolved in the site's own timezone): today, yesterday, this_week, last_week, this_month, last_month, this_year, last_year, last_7_days, last_30_days, last_90_days, last_12_months. Also accepts Plausible presets (day, 7d, 30d, month, 6mo, 12mo, year, all), a single date "YYYY-MM-DD", or an explicit range "YYYY-MM-DD,YYYY-MM-DD". For "yesterday"/"last week" etc., prefer the keyword — the server computes the exact dates so you don't have to know today's date. | 30d |
| metrics | No | Metrics to retrieve. | |
| filters | No | Plausible v2 filters. | |
| order_by | No | Sort order, e.g. [["visitors", "desc"]]. Defaults to first metric desc. | |
| limit | No | Max rows to return. |