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>.

id_token
string

App Bridge session token, when not sent as a bearer header.

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"

Response

The report.