Skip to main content
POST
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>.

Body

application/json
from_date
string
required
Pattern: ^\d{4}-\d{2}-\d{2}$
Example:

"2026-09-01"

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

"2026-09-01"

offset
integer
Required range: x >= 0
page_size
integer
Required range: x >= 1
query
string | null

Case-insensitive title filter.

order_by
enum<string>
default:top_views
Available options:
top_views,
top_ctr,
top_clicks,
updated_at,
name_a_z,
number_of_products
reverse
boolean
filter_by
enum<string> | null
Available options:
live,
draft,
scheduled,
not_live,
null

Response

The page.

offset
integer
required

Where the next page starts.

has_next
boolean
required
collections
object[]
required