analytics_funnel_run
Run an ordered conversion funnel over the analytics semantic layer for the current product.
Run an ordered conversion funnel over the analytics semantic layer for the current product. Each step names a semantic entity (optionally narrowed by declared-dimension filters) and is counted in resolved persons from the identity graph, so a person is counted once per step no matter how many rows or identifiers they produced. Deterministic: entity, dimension and metric names are resolved against the semantic catalog, never generated. A step whose entity has a `propertiesColumn` in the catalog may also filter on `props.<key>`, compared as a string. Prefer this over analytics_query_run whenever the question is a conversion between ordered steps.
Behavior
- HTTP
POST /analytics/funnels/run
Arguments
| Name | Type | Required | Description |
|---|---|---|---|
| to | string | • | Inclusive last day (UTC) |
| from | string | • | Inclusive first day (UTC) |
| grain | string | — | When set, also return per-step persons bucketed by step-entry time |
| steps | array | • | Ordered funnel steps, 2 to 5 |
| window_days | integer | — | Maximum days between two CONSECUTIVE steps for the later one to count |
Response
| Field | Type | Always | Description |
|---|---|---|---|
| meta | object | • | |
| steps | array | • | |
| series | array | — |
Try it
Run an ordered conversion funnel over the analytics semantic layer for the current product.