Breakdown
get_breakdownThe top values of one dimension (source, channel, page, country, device, campaign …) by distinct visitors, or by revenue, each with its share of visitors and the revenue its visitors brought.
Tool call template
Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {
"dimension": "<dimension>"
},
"name": "get_breakdown"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| to | No | A custom range's last day (YYYY-MM-DD), with from. | |
| from | No | A custom range's first day (YYYY-MM-DD), with to. Up to 366 days, not past today. | |
| site | No | The site's id. Optional: the API key's site is the one read. | |
| sort | No | Top values by visitors (default) or by revenue. | |
| limit | No | Rows at most (default 10). | |
| period | No | A preset period, in the site's time zone. Leave out for the tool's default, or give from and to instead. | |
| filters | No | Visits that match every filter (AND). Each dimension at most once. | |
| dimension | Yes | What to break down by. |