get_breakdown
Retrieve granular website analytics breakdowns segmented by page, source, country, or device, with customizable metrics and filters for targeted insights.
Instructions
Get detailed analytics breakdown for a site.
COMMON QUERIES:
Most visited pages in last 7 days: {"site_id": "example.com", "metrics": ["visitors", "pageviews"], "dimensions": ["event:page"], "date_range": "7d"}
Traffic sources with bounce rates: {"site_id": "example.com", "metrics": ["visitors", "bounce_rate"], "dimensions": ["visit:source"], "date_range": "30d"}
Geographic breakdown: {"site_id": "example.com", "metrics": ["visitors", "visit_duration"], "dimensions": ["visit:country", "visit:city"], "date_range": "month"}
Hourly visitor trends for today: {"site_id": "example.com", "metrics": ["visitors", "pageviews"], "dimensions": ["time:hour"], "date_range": "day"}
Device and browser analysis: {"site_id": "example.com", "metrics": ["visitors", "bounce_rate"], "dimensions": ["visit:device", "visit:browser"], "date_range": "7d"}
Campaign performance: {"site_id": "example.com", "metrics": ["visitors", "views_per_visit"], "dimensions": ["visit:utm_campaign", "visit:utm_source"], "date_range": "month"}
AVAILABLE METRICS:
visitors: Number of unique visitors
visits: Number of visits/sessions
pageviews: Number of pageview events
views_per_visit: Average number of pages viewed per visit
bounce_rate: Percentage of visits with only one page view
visit_duration: Average visit duration in seconds
events: Total number of events (pageviews + custom events)
AVAILABLE DIMENSIONS: Event dimensions (page/content related):
event:name - Event name (e.g., 'pageview', 'download', etc.)
event:page - Full page URL including UTM parameters
event:page.pathname - Page path without query parameters
event:props:* - Custom event properties (e.g., event:props:author)
Visit dimensions (visitor/session related):
visit:source - Traffic source (e.g., 'Google', 'Twitter')
visit:referrer - Full referrer URL
visit:utm_medium - Marketing medium (e.g., 'cpc', 'social')
visit:utm_source - UTM source parameter
visit:utm_campaign - UTM campaign name
visit:utm_content - UTM content parameter
visit:utm_term - UTM term parameter
visit:device - Device type (desktop, mobile, tablet)
visit:browser - Browser name
visit:browser_version - Browser version
visit:os - Operating system
visit:os_version - OS version
visit:country - Country of visitor
visit:country_name - Full country name
visit:region - Region/state of visitor
visit:region_name - Full region/state name
visit:city - City of visitor
visit:city_name - Full city name
Time dimensions (for trends and patterns):
time:minute - Group by minute (only available with 'day' time:day range)
time:hour - Group by hour (only available with 'day' time:day range)
time:day - Group by day (available with any time:day range)
time:week - Group by week (available with 'month', '6mo', '12mo', or custom ranges)
time:month - Group by month (available with '6mo', '12mo', or custom ranges)
Note: Time dimensions are mutually exclusive - only one can be used at a time. When using time dimensions, results are automatically sorted chronologically.
FILTERING EXAMPLES:
Only Chrome users: {"filters": [["is", "visit:browser", ["Chrome"]]]}
Blog pages only: {"filters": [["contains", "event:page", ["/blog"]]]}
Multiple countries: {"filters": [["is", "visit:country", ["US", "GB", "CA"]]]}
Exclude certain pages: {"filters": [["is_not", "event:page", ["/admin", "/login"]]]}
Complex filter (Chrome users from US): {"filters": [["and", [["is", "visit:browser", ["Chrome"]], ["is", "visit:country", ["US"]]]]]}
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| site_id | Yes | Your website domain as configured in Plausible (e.g., 'example.com') | |
| metrics | No | List of metrics to calculate. Default: ['visitors']. See AVAILABLE METRICS above for options. | |
| dimensions | No | Properties to group results by. Default: ['time:day']. See AVAILABLE DIMENSIONS above for options. 'date' is not a valid dimension | |
| date_range | No | Time period to analyze. Options: - 'day': Last 24 hours - '7d', '30d': Last N days - 'month': Current month - '6mo', '12mo': Last N months - Custom ISO dates: ['2024-01-01', '2024-01-31'] Default: '7d' | |
| filters | No | Filter conditions to apply. See FILTERING EXAMPLES above. Operators: is, is_not, contains, contains_not, matches, matches_not | |
| limit | No | Maximum number of results to return. Default: 10000 | |
| page | No | Page number for pagination. Default: 1 |