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.

Path Parameters

collection_id
string
required

Numeric Shopify collection id.

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"

market_id
string

Restricts revenue to one Shopify market's countries; sell_through_rate is then null.

Response

Metrics by product id.

{key}
object