A valid request URL is required to generate request examples{
"current": [
{
"day": "<string>",
"searches": 123,
"no_results": 123,
"no_results_rate": 123,
"sessions": 123,
"clicks": 123,
"ctr": 123,
"searches_with_click": 123,
"no_click_rate": 123,
"positioned_searches": 123,
"median_click_position": 123,
"index_p50_ms": 123,
"index_p95_ms": 123
}
],
"previous": [
{
"day": "<string>",
"searches": 123,
"no_results": 123,
"no_results_rate": 123,
"sessions": 123,
"clicks": 123,
"ctr": 123,
"searches_with_click": 123,
"no_click_rate": 123,
"positioned_searches": 123,
"median_click_position": 123,
"index_p50_ms": 123,
"index_p95_ms": 123
}
]
}{
"detail": "<string>"
}{
"detail": "<string>"
}{
"detail": "<string>"
}{
"detail": "<string>"
}{
"detail": "<string>"
}Daily search health: no-results, click rates, latency
Per day: searches, no-result rate, click-through, no-click rate, median click position and index latency. Takes the current and previous windows (from_ts/to_ts, prev_from_ts/prev_to_ts) and answers both, for period-over-period comparison. Read-only.
A valid request URL is required to generate request examples{
"current": [
{
"day": "<string>",
"searches": 123,
"no_results": 123,
"no_results_rate": 123,
"sessions": 123,
"clicks": 123,
"ctr": 123,
"searches_with_click": 123,
"no_click_rate": 123,
"positioned_searches": 123,
"median_click_position": 123,
"index_p50_ms": 123,
"index_p95_ms": 123
}
],
"previous": [
{
"day": "<string>",
"searches": 123,
"no_results": 123,
"no_results_rate": 123,
"sessions": 123,
"clicks": 123,
"ctr": 123,
"searches_with_click": 123,
"no_click_rate": 123,
"positioned_searches": 123,
"median_click_position": 123,
"index_p50_ms": 123,
"index_p95_ms": 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}$Was this page helpful?