get_report
Aggregated analytics broken down by dimension and/or time. Fast — hits the pre-aggregated reporting endpoint, not the raw events table.
USE WHEN the user asks for counts, values, or trends grouped by anything:
by event name ("how many Purchases vs Leads?") → dimensions=['event_name']
by traffic source ("top sources?", "Google vs Facebook?") → dimensions=['source']
by day / week / month ("daily conversions", "weekly trend") → granularity + read daily_series in response
by hour, device, or browser → dimensions=['hour'|'device'|'browser']
first-click vs last-click attribution → attribution='first_click'
filtered to one delivery integration ("events delivered to Facebook CAPI") → connector='facebook'
Prefer this over list_events / list_sessions for ANY question that resolves to a number, a chart, or a ranking — it is orders of magnitude faster. For a single-period overall snapshot (no dimension breakdown), use get_summary instead. Date range required, max 30 days. Call get_container first if you need the list of valid event names for this container.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| source | No | Filter by traffic source | |
| date_to | Yes | End date (YYYY-MM-DD) | |
| currency | No | Currency code, e.g. 'EUR', 'USD' | |
| connector | No | Filter by connector/integration | |
| date_from | Yes | Start date (YYYY-MM-DD) | |
| dimensions | No | Dimensions to break down by. Example: ['source', 'event_name'] | |
| event_name | No | Filter by event name | |
| attribution | No | Attribution model (default: last_click) | |
| granularity | No | Time granularity (default: daily) | |
| server_name | No | Server name (required when connected to multiple servers). | |
| container_id | Yes | Container ID (starts with "trc_") |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| data | Yes | ||
| meta | Yes |