custom_report
Run any Klaviyo values or series report with custom statistics, groupings, filters, intervals, and timeframes. Get raw JSON results for full analytical control.
Instructions
Expert escape hatch - run ANY Klaviyo values or series report with full control over statistics, group_by, filter, interval, and timeframe (preset OR custom range, auto-windowed into 1-year chunks back to the 2023-06-01 floor). Returns raw JSON results so you can analyze like a Klaviyo analyst. Use when the specialized report tools do not expose a statistic, dimension, or filter you need.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| end | No | Custom range end, YYYY-MM-DD. Defaults to today. | |
| year | No | Year for quarter, e.g. 2024. | |
| start | No | Custom range start, YYYY-MM-DD. Overrides timeframe. Data floor: 2023-06-01 (earlier is clamped). | |
| filter | No | Raw Klaviyo filter expression, e.g. equals(campaign_id,"01ABC"). You own its correctness. | |
| account | Yes | Account name | |
| quarter | No | Quarter 1-4 (with year) - convenience for a full quarter. | |
| group_by | No | Grouping dimensions, e.g. ["campaign_id","send_channel"]. | |
| interval | No | For *-series-report only: hourly/daily/weekly/monthly. Default daily. | |
| timeframe | No | Preset period, OR use start/end/quarter/year. | |
| statistics | Yes | Statistics to fetch, e.g. ["recipients","open_rate","conversion_value"]. Must be valid for the chosen report_type. | |
| report_type | Yes | Which Klaviyo report to run. NOTE: there is no campaign-series-report - campaign reports are values-only; use metric_aggregate or per-period campaign-values for campaign trends. | |
| conversion_metric_id | No | Required whenever you request a revenue/conversion statistic (e.g. conversion_value, conversion_rate). |