Documentation

get_search_analysis

On-site search queries with click-through and purchase rates, and the zero-result searches that name demand the catalogue does not serve.

When to use it

For findability and missing inventory. Zero-result searches are the clearest demand signal a store produces — visitors typing what they want and being told it does not exist.

Ask for it like this

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

What inventory am I missing?
What do people search for and not find?

What will make you wrong

Caveats

  • Rows with lowSample: true are below 10 searches and are too small for a rate conclusion, though the query text itself can still be worth reading.

Parameters

zeroResultsOnly
booleandefault: false
Return only searches that produced no results.
minOccurrences
numberdefault: 1
Minimum times a query was searched.
limit
numberdefault: 50
Maximum queries 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.

queries
Per query: total_searches, total_clicks, total_purchases, click_through_rate, purchase_rate, has_zero_results and a lowSample flag.

Pairs with