get_breakdown
Retrieve top-N breakdowns for built-in analytics dimensions like page, country, browser, or device. Apply optional filters and custom date ranges to focus on specific segments.
Instructions
Top-N for any column-backed dimension: page, referrer, country, region, city, browser, device, language, screen, channel, ai_source, hostname. Use this for "top countries / browsers / devices / channels / AI sources / cities / etc." — anything in the dashboard's breakdown tabs. For custom event properties (UTM rollups, plan splits, anything you ship in event JSON), use breakdown_by_property instead. Filters and custom date ranges supported.
Optional dimension filters. Each filter is {dim, op, value}. Available dims: page, entry_page, exit_page, referrer, hostname, channel, ai_source, utm_source, utm_medium, utm_campaign, country, region, city, language, device, browser, screen, event_name, or prop:. Available ops: is, is_not, contains, not_contains. Filters AND together. Example: [{dim:'country', op:'is', value:'US'}, {dim:'device', op:'is_not', value:'mobile'}].
Optional date range. Either {preset:'last_7_days'} (also: today, yesterday, last_14_days, last_30_days, last_90_days, last_year, month_to_date, last_month, all_time) OR {from:'2026-05-01', to:'2026-05-15'} for a custom range (ISO 8601 dates or timestamps). Defaults vary by tool.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| dimension | Yes | Which built-in dimension to group by: page, referrer, country, region, city, browser, device, language, screen, channel, ai_source, or hostname. | |
| site_id | No | Internal site UUID. Get one from list_sites. Omit to scope to the entire workspace. | |
| date_range | No | Optional date range. Either {preset:'last_7_days'} OR {from:'2026-05-01', to:'2026-05-15'}. Defaults per tool — usually last_7_days. | |
| filters | No | AND-joined dimension filters. | |
| limit | No | Max number of rows to return. Defaults to 20, capped at 200. Pagination via date_range for larger windows. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| rows | Yes | Top-N rows sorted by visitor count, descending. |