Skip to main content
GET
Error

Authorizations

Authorization
string
header
required

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

merchant_id
string
required

Lite merchant id, e.g. shopify-<shop id>.

from_date
string
required

First day, inclusive.

Pattern: ^\d{4}-\d{2}-\d{2}$
Example:

"2026-09-01"

to_date
string
required

Last day, inclusive.

Pattern: ^\d{4}-\d{2}-\d{2}$
Example:

"2026-09-01"

surface_id
string

Only the recommendation stages of one surface.

Pattern: ^[A-Za-z0-9_-]{1,64}$
country
string

The search pixel's country; narrows the search stages only.

Pattern: ^[A-Z]{2}$

Response

Both windows' stages.

current
object
required
previous
object
required
window_hours
number
required