A valid request URL is required to generate request examples{
"current": [
{
"hour": "<string>",
"searches": 123,
"no_results": 123,
"sessions_with_search": 123,
"clicks": 123,
"searches_with_click": 123,
"add_to_carts": 123,
"purchases": 123,
"sessions_with_purchase": 123,
"revenue": 123,
"searches_with_cart": 123,
"searches_with_order": 123
}
],
"previous": [
{
"hour": "<string>",
"searches": 123,
"no_results": 123,
"sessions_with_search": 123,
"clicks": 123,
"searches_with_click": 123,
"add_to_carts": 123,
"purchases": 123,
"sessions_with_purchase": 123,
"revenue": 123,
"searches_with_cart": 123,
"searches_with_order": 123
}
],
"totals": {
"current": {
"searches": 123,
"searches_with_click": 123,
"searches_with_cart": 123,
"searches_with_order": 123
},
"previous": {
"searches": 123,
"searches_with_click": 123,
"searches_with_cart": 123,
"searches_with_order": 123
}
}
}{
"detail": "<string>"
}{
"detail": "<string>"
}{
"detail": "<string>"
}{
"detail": "<string>"
}{
"detail": "<string>"
}Hourly search funnel: searches, clicks, carts, orders, revenue
The storefront search funnel per hour, plus exact per-window totals counted in searches. Revenue is attributed by the one Depict rule and converted to currency. 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": [
{
"hour": "<string>",
"searches": 123,
"no_results": 123,
"sessions_with_search": 123,
"clicks": 123,
"searches_with_click": 123,
"add_to_carts": 123,
"purchases": 123,
"sessions_with_purchase": 123,
"revenue": 123,
"searches_with_cart": 123,
"searches_with_order": 123
}
],
"previous": [
{
"hour": "<string>",
"searches": 123,
"no_results": 123,
"sessions_with_search": 123,
"clicks": 123,
"searches_with_click": 123,
"add_to_carts": 123,
"purchases": 123,
"sessions_with_purchase": 123,
"revenue": 123,
"searches_with_cart": 123,
"searches_with_order": 123
}
],
"totals": {
"current": {
"searches": 123,
"searches_with_click": 123,
"searches_with_cart": 123,
"searches_with_order": 123
},
"previous": {
"searches": 123,
"searches_with_click": 123,
"searches_with_cart": 123,
"searches_with_order": 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}$ISO 4217 code the money is converted to; USD when omitted.
^[A-Z]{3}$Was this page helpful?