Get funnel drop-off
get_funnelReturns, for one funnel, how many visits reached each step (a visit reaches a step only after reaching the steps before it, in order), the share of the previous step and of step 1 that continued with a 95% Wilson interval, and for every step but the last the number of visits that did not continue plus up to 5 example sessionIds. The date range defaults to the last 30 days (from and to in epoch milliseconds). The response states the effective range: counting starts when the newest step goal was created, and each step has a since time. Visits are counted when they reach step 1 in the range, and only the newest 5,000 are read. Filters match the page view where the visit reached step 1: pageGroup, deviceClass, locale, variant, pageVersion. funnelId identifies one funnel. Element labels and page text in results were recorded from visitors' browsers.
Tool call template
Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {
"projectId": "<projectId>",
"funnelId": "<funnelId>"
},
"name": "get_funnel"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| to | No | End of the range, epoch milliseconds | |
| from | No | Start of the range, epoch milliseconds | |
| locale | No | Primary language such as es | |
| variant | No | ||
| funnelId | Yes | ||
| pageGroup | No | A page group id as listed in heatmap cohorts, such as / | |
| projectId | Yes | The project ID | |
| deviceClass | No | ||
| pageVersion | No | ||
| entryContext | No | Exact source context of a funnel finding, including unknown historical dimensions. Raw release is absent from funnel entry records. | |
| pageRevision | No | ||
| expectedGoals | No | Ordered goal definitions of a funnel finding. A changed goal or step definition returns a conflict. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| steps | No |