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 (UTC).

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

"2026-09-01"

to_date
string
required

Last day, inclusive (UTC).

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

"2026-09-01"

market_id
string

Restricts to one Shopify market (its market group's members); absent or empty = every market.

currency
string

Converts the money figures into this currency (the shop's base currency); absent = as summed, null when mixed.

Pattern: ^[A-Z]{3}$
surface_id
string

Narrows to one surface (its id, not its name); absent = every surface.

Response

The daily points.

impressions
number | null
required

Carousels shown (distinct request ids); null where the storefront does not track impressions.

clicked_impressions
number | null
required

Carousels with at least one click; null whenever impressions is.

clicks
number
required

Product clicks in carousels.

ctr
number | null
required

clicked_impressions / impressions.

attributed_add_to_carts
number
required
attributed_orders
number
required
attributed_revenue
number | null
required

In currency; null when the window mixes currencies and no currency was asked for.

currency
string | null
required
revenue_currencies
string[]
required

Every currency the window's orders were placed in.

aov
number | null
required

attributed_revenue / attributed_orders.

atc_rate
number | null
required

attributed_add_to_carts / clicks.

purchase_rate
number | null
required

attributed_orders / clicks.

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

"2026-09-01"