analytics_breakdown
Aggregate KPIs broken down by one dimension: product_type, sales_channel, fulfillment_provider, product, variant, or hold_reason. Rows are sorted for display; overflow past the limit folds into an "(everything else)" row so totals still reconcile. Requires an Advanced Analytics plan. Read-only.
[#127113]
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| end | No | End date (YYYY-MM-DD). Omit to default to today (UTC). | |
| limit | No | Max rows before folding the rest into "(everything else)" (default 50). | |
| start | No | Start date (YYYY-MM-DD). Omit to default to 30 days before end. | |
| store | No | Store uuid to narrow to one store. Omit for all accessible stores. | |
| currency | No | Reporting currency (e.g. "USD"). Currencies are segmented, never summed. | |
| dimension | Yes | The dimension to break down by (required). | |
| workspace | No | Workspace uuid to scope to (agency accounts). Omit for the Default workspace. |