Get top pages, referrers, countries or devices
simpleanalytics_get_breakdownRead-only
Top values of one dimension for one website and date range, each with pageviews and visitors: pages, countries, referrers, UTM sources/mediums/campaigns/contents/terms, browsers, operating systems or device types. Optional filters as in simpleanalytics_get_stats. Stats API: GET /.json?fields=.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| end | No | End date (inclusive): YYYY-MM-DD, today, yesterday or today-1d. Default: today. | |
| page | No | Only this page path, e.g. /pricing. A trailing * matches a prefix (/blog/*). | |
| limit | No | Maximum number of values (default 20, max 1000). | |
| pages | No | Only these page paths, comma separated (/contact,/product/*). | |
| start | No | Start date: YYYY-MM-DD, today, yesterday or today-30d. Default: 1 month ago. | |
| country | No | Only this country, 2-letter code (NL). | |
| os_name | No | Only this OS name (iOS). | |
| hostname | Yes | Website hostname as shown in Simple Analytics, e.g. example.com (from simpleanalytics_list_websites). | |
| metadata | No | Exact metadata filters as {key: value}; all must match. | |
| referrer | No | Only this referrer (normalized, e.g. google.com). | |
| timezone | No | IANA time zone, e.g. Europe/Amsterdam. Default: the website setting. | |
| utm_term | No | Only this UTM term. | |
| dimension | Yes | What to break the traffic down by. | |
| utm_medium | No | Only this UTM medium. | |
| utm_source | No | Only this UTM source. | |
| device_type | No | Only this device type. | |
| utm_content | No | Only this UTM content. | |
| browser_name | No | Only this browser name (Chrome). | |
| utm_campaign | No | Only this UTM campaign. |