A valid request URL is required to generate request examples[
{
"query": "<string>",
"searches": 123,
"no_results": 123,
"sessions": 123,
"clicks": 123,
"searches_with_click": 123,
"no_click_rate": 123,
"positioned_searches": 123,
"median_click_position": 123
}
]{
"detail": "<string>"
}{
"detail": "<string>"
}{
"detail": "<string>"
}{
"detail": "<string>"
}{
"detail": "<string>"
}Per-query table: what shoppers searched and how it went
One row per search query in the current window, sorted by order_by and paged with offset/page_size: searches, no-results, clicks, no-click rate, median click position. Use it to find queries that return nothing or get no clicks. Read-only.
A valid request URL is required to generate request examples[
{
"query": "<string>",
"searches": 123,
"no_results": 123,
"sessions": 123,
"clicks": 123,
"searches_with_click": 123,
"no_click_rate": 123,
"positioned_searches": 123,
"median_click_position": 123
}
]{
"detail": "<string>"
}{
"detail": "<string>"
}{
"detail": "<string>"
}{
"detail": "<string>"
}{
"detail": "<string>"
}Authorizations
Shopify App Bridge session token of the embedded Depict: Search & Merchandising app. The shop in the token determines the merchant; merchant_id parameters must belong to that shop.
Query Parameters
Lite merchant id, e.g. shopify-<shop id>.
App Bridge session token, when not sent as a bearer header.
Current window start, inclusive ("YYYY-MM-DD HH:MM:SS", UTC)
^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$Current window end, exclusive ("YYYY-MM-DD HH:MM:SS", UTC)
^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$Previous window start, inclusive ("YYYY-MM-DD HH:MM:SS", UTC)
^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$Previous window end, exclusive ("YYYY-MM-DD HH:MM:SS", UTC)
^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$IANA timezone the pipes bucket hours/days in; UTC when omitted.
^[A-Za-z_+\-/0-9]{1,64}$Two-letter country code to narrow to.
^[A-Z0-9]{2}$Accepted and ignored (older portal bundles still send it).
Sort column; searches by default.
searches, no_results, no_click_rate, median_click_position, clicks, add_to_carts, purchases Rows to skip; 0 by default.
^\d{1,7}$Rows to return, 1–100000; 100 by default.
^[1-9]\d{0,6}$Response
The report.
1 - searches_with_click / searches
Median first position clicked (1 = first) over searches with a positioned click; null under the minimum sample.
Was this page helpful?