Get breakdown
get_breakdownTop values for one analytics dimension, ranked by visitors: pages, entry and exit pages, referrer domains, sources, mediums, UTM parameters, countries, regions, cities, devices, browsers, operating systems, or event names.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| app | Yes | Application id, or orgSlug/appSlug as returned by list_apps | |
| limit | No | ||
| range | No | Time range: 24h, 7d, 30d, 90d, 12m, or custom:YYYY-MM-DD..YYYY-MM-DD. Defaults to 7d. | |
| search | No | ||
| filters | No | Narrow the read to exact values, as "dimension:value" pairs, e.g. ["country:DE", "source:google"]. Dimensions are the ones get_breakdown accepts and the first colon ends the dimension. Filters are combined with AND, cover at most the last 90 days, and the answer carries capped: true when the range had to be shortened. | |
| dimension | Yes | path, entry_path, exit_path, referrer_domain, source, medium, utm_source, utm_medium, utm_campaign, utm_term, utm_content, country, region, city, device, browser, os or event | |
| environment | No | Environment slug: production, staging or development. Defaults to production. |