Breakdown by property
plausible_breakdownConvenience: break metrics down by a single property (dimension), e.g. visit:source or event:page. Plausible: POST /api/v2/query with dimensions=[property].
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| limit | No | Max rows to return — maps to pagination.limit. | |
| filters | No | Optional filters. Each is an array like ["is","visit:country_name",["Estonia"]] or ["contains","event:page",["/blog"]] with logical wrappers ["and",[...]] / ["or",[...]] / ["not",[...]]. Operators: is, is_not, contains, contains_not, matches, matches_not, has_done, has_not_done. | |
| metrics | Yes | Metrics to compute. Any of: visitors, visits, pageviews, views_per_visit, bounce_rate, visit_duration, events, scroll_depth, percentage, conversion_rate, group_conversion_rate, average_revenue, total_revenue, time_on_page. | |
| site_id | Yes | The site's domain as registered in Plausible, e.g. "example.com". | |
| order_by | No | Optional ordering: an array of [metric_or_dimension, "asc"|"desc"] pairs, e.g. [["visitors","desc"]]. | |
| property | Yes | The single dimension to group by, e.g. visit:source, event:page, visit:country_name, visit:device. | |
| date_range | Yes | Date range: a shortcut string ("day", "7d", "28d", "30d", "91d", "month", "6mo", "12mo", "year", "all", "24h") OR a 2-element ISO8601 array like ["2024-01-01","2024-07-01"] (dates or datetimes with tz). |