Plausible: breakdown by dimension
plausible_get_breakdownRank website metrics by dimensions such as pages, sources, countries, devices, UTM campaigns, goals, or custom properties to identify top performers, with pagination and filters.
Instructions
Rank groups by metrics: top pages, sources, countries, devices, UTM campaigns, goals, custom properties. Paginated.
Examples:
Top 10 traffic sources this month: {"site_id": "example.com", "dimensions": ["visit:source"], "date_range": "month", "limit": 10}
Top pages with engagement: {"dimensions": ["event:page"], "metrics": ["visitors", "pageviews", "bounce_rate", "time_on_page"]}
Goal conversions by campaign: {"dimensions": ["visit:utm_campaign"], "metrics": ["visitors", "conversion_rate"], "filters": [{"dimension": "event:goal", "operator": "is", "values": ["Signup"]}]}
Next page of results: repeat the call with "offset" set to next_offset from the previous response.
Rules: session metrics (bounce_rate, views_per_visit, visit_duration) cannot be combined with event dimensions other than event:page. "percentage" gives each group's share of the total.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| limit | No | Rows per page (1-1000, default 25) | |
| offset | No | Rows to skip, for pagination. Use next_offset from the previous page | |
| filters | No | Filters combined with logical AND. Each filter matches if any of its values match. | |
| metrics | No | Metrics per group. Default: ["visitors"] | |
| site_id | No | Site domain exactly as registered in Plausible, e.g. "example.com". Optional when PLAUSIBLE_DEFAULT_SITE_ID is set. | |
| order_by | No | Sort order. Default: first metric descending | |
| date_range | No | Either a preset ("day", "24h", "7d", "28d", "30d", "91d", "month", "6mo", "12mo", "year", "all") or a custom range {"from": "2024-01-01", "to": "2024-01-31"} | 30d |
| dimensions | Yes | Group by these dimensions (1-3), e.g. ["visit:source"] or ["visit:country_name", "visit:city_name"] | |
| response_format | No | "markdown" (default) for a readable table, "json" for machine-readable rows | markdown |
| include_imported | No | Include imported (e.g. Google Analytics) data where supported |