Skip to content

analytics_funnel_run

Run an ordered conversion funnel over the analytics semantic layer for the current product.

Tool

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

NameTypeRequiredDescription
tostringInclusive last day (UTC)
fromstringInclusive first day (UTC)
grainstringWhen set, also return per-step persons bucketed by step-entry time
stepsarrayOrdered funnel steps, 2 to 5
window_daysintegerMaximum days between two CONSECUTIVE steps for the later one to count

Response

FieldTypeAlwaysDescription
metaobject
stepsarray
seriesarray

Try it

Run an ordered conversion funnel over the analytics semantic layer for the current product.

When to use

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.

Example

Ask your agent something like this:

Run an ordered conversion funnel over the analytics semantic layer for the current product.

The agent will invoke analytics_funnel_run with these arguments:

{
  "to": "<to>",
  "from": "<from>",
  "steps": "<steps>"
}

Esc

Start typing to search the docs.

navigateselect