analytics_funnel_run

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. Supply filters on a step to narrow its rows; omit filters to apply no step filters. Each step names a semantic entity 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 also accepts filters on `props.<key>`, compared as a string. Step filters support legacy {dimension, eq} or op eq, neq, in, not_in, starts_with, is_null, is_not_null; in and not_in take 1–100 values of one type; starts_with takes a string and works on text dimensions. neq and not_in retain NULL rows. Give each step a label (1–60 characters, e.g. Дошли до /pricing); every returned step carries label — the declared one, or its entity and filters when it has none. 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
person_filter	string	—	`exclude_identified` drops the rows of identified people: a person who has an email or a phone in the analytics person graph. The link is the row's identifier, not time, so a visitor's earlier anonymous rows are dropped too once that visitor is identified. Rows with no identifier (cookieless events) are never excluded, because there is nothing to resolve them by. The person graph is rebuilt on a schedule (hourly by default), so a newly identified person is excluded only after the next rebuild. Omit the field to count everyone.

Response

Field	Type	Always
meta	object	•
steps	array	•
series	array	—

Try it

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

When to use

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>"
}