Get a dimensional breakdown (top pages, referrers, countries, browsers, etc.)
rybbit_get_breakdownBreak down website analytics by dimension like page, country, or browser to see traffic, pageviews, and bounce rate per value.
Instructions
Get analytics broken down by a single dimension, ranked by traffic. Use this for questions like 'what are the top pages', 'where is traffic coming from', 'what countries/browsers/devices do visitors use', 'what are the top UTM campaigns', etc. Set parameter to the dimension to break down by, e.g.: pathname, page_title, hostname, referrer, channel, entry_page, exit_page, country, region, city, browser, browser_version, operating_system, device_type, language, utm_source, utm_medium, utm_campaign, utm_term, utm_content, event_name. Results include visit count, percentage of total, pageviews, and bounce rate per value.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| site | Yes | The Rybbit site ID (numeric ID from your Rybbit dashboard or the rybbit_list_sites tool). | |
| parameter | Yes | Dimension to break down by, e.g. pathname, referrer, country, browser, device_type, utm_source, channel. | |
| limit | No | Max number of rows to return (default applies if omitted). | |
| page | No | Page number for pagination (1-indexed). | |
| start_date | No | Start date, e.g. 2024-01-01. Use with end_date and time_zone. | |
| end_date | No | End date, e.g. 2024-01-31. Use with start_date and time_zone. | |
| time_zone | No | IANA time zone, e.g. America/New_York. Required when using start_date/end_date or start_datetime/end_datetime. | |
| start_datetime | No | Exact start datetime, e.g. '2024-01-15 13:00:00' (UTC). Alternative to start_date. | |
| end_datetime | No | Exact end datetime, e.g. '2024-01-15 15:00:00' (UTC). Alternative to end_date. | |
| past_minutes_start | No | Relative range start in minutes ago, e.g. 60. Use with past_minutes_end instead of dates. | |
| past_minutes_end | No | Relative range end in minutes ago, e.g. 0 for 'now'. Use with past_minutes_start. | |
| filters | No | Optional list of filters to narrow the data (AND logic across different filters). Example: [{"parameter":"country","type":"equals","value":["US"]}] |