User paths
get_flowWhat visits did next, as a tree up to 4 steps deep from a starting node (default: where visits enter the site). Every count is conditioned on the whole path above it, so it can be read as a journey. Each box lists its top branches plus 'other', 'rare' and 'exit' rows that sum to its visits. Boxes with below_threshold set are too thin to interpret: say so. Expand a branch by passing its key in path; find a root with find_flow_nodes. Dates are the project's calendar days, YYYY-MM-DD (timezone: get_project); timestamps are UTC. Omit from/to for the last 28 complete days, ending yesterday.
Tool call template
This tool declares no required parameters. Add optional parameters from the input schema as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {},
"name": "get_flow"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| to | No | Last day, YYYY-MM-DD in the project's timezone, inclusive. Default: yesterday, the last complete day. | |
| from | No | First day, YYYY-MM-DD in the project's timezone, inclusive. Default: 27 days before 'to'. | |
| path | No | Comma-separated node keys (the 'key' of branches, copied as returned) naming the branch to expand below the root, outermost first, at most 3. Keys are encoded as for root, e.g. pageview:https%3A%2F%2Fshop.acme.com:%2Fcart:,click:https%3A%2F%2Fshop.acme.com:%2Fcart:checkout. | |
| root | No | Node key to start from, exactly as returned by find_flow_nodes: event_type:page_origin:page_path:feature_name, four segments, each percent-encoded so a colon or slash inside one is %3A or %2F. The page view of https://shop.acme.com/ is pageview:https%3A%2F%2Fshop.acme.com:%2F: (never pageview:https://shop.acme.com/), a click on add-to-cart on /products/:id is click:https%3A%2F%2Fshop.acme.com:%2Fproducts%2F%3Aid:add-to-cart. Default: where visits enter. | |
| level | No | steps (default): pages plus named features. pages: pageviews only. | |
| project | No | Project ID, from list_projects. Required when this connection covers more than one project; may be left out when it covers one (and with an API key, which belongs to one project). | |
| branches | No | Real branches returned per box, 1-20. Default 6. |