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"

offset
integer | null
default:0

Rows to skip.

Required range: x >= 0
order
enum<string>
default:DESC
Available options:
DESC,
ASC
order_by
enum<string>
default:d_score

d_score is the performance score: units of the product ordered storewide in the window. Under d_score (and clicks, carts, orders) only products clicked in a collection grid in the window are ranked; product_views and revenue rank every product with activity.

Available options:
d_score,
clicks,
add_to_carts,
orders,
product_views,
revenue
page_size
integer
default:100

Rows per page.

Required range: 1 <= x <= 20000
view
enum<string>
default:full

full: each row carries the product and every collection it sits in. summary: the id, title, funnel numbers, Need attention verdict and the grids it names, for ranking a whole catalogue.

Available options:
full,
summary
collection_id
string

Scope the page to one collection's products, including ones with no activity.

include_untouched
enum<integer>

1 appends catalogue products with no activity after the ranked ones (DESC, storewide only).

Available options:
1

Response

One page: full rows, or summary rows with view=summary.

metrics
object[]
required
has_more
boolean
required