Documentation

get_journey_patterns

Common navigation paths through the store — Home to Collection to Product to Cart — with the conversion rate, engagement and frustration of each path.

When to use it

After the funnel localises a drop, to see which routes lead into it. Filter converted: false for the paths that fail.

Ask for it like this

You do not name the tool. These are questions that make an assistant reach for it:

What route do people take when they do not buy?
Which navigation path converts best?

How to read the result

  • Paths are normalised, so * stands in for a variable segment such as a product handle.
  • conversion_rate per pattern is an unweighted average of daily rates, so treat small patterns as directional.

Parameters

minOccurrences
numberdefault: 2
Minimum times a pattern occurred to be reported.
converted
boolean
true keeps only converting journeys, false keeps only non-converting ones.
limit
numberdefault: 20
Maximum patterns to return.

Shared parameters it accepts

Documented in full on the tool reference index.

Date window — defaults to the last 30 days.

dateFrom
stringdefault: 30 days ago
Start of the window, YYYY-MM-DD. Inclusive.
dateTo
stringdefault: today
End of the window, YYYY-MM-DD. Inclusive.

Every tool also accepts merchantId, which resolves from your connection. You never pass it.

What comes back

JSON. These are the top-level keys; date-scoped tools additionally carry a _meta block with the server date and the data coverage envelope.

patterns
Each with the normalised path, total occurrences, conversion rate, average engagement and frustration, average revenue, and a lowSample flag.

Pairs with