A valid request URL is required to generate request examples{
"impressions": 123,
"clicked_impressions": 123,
"clicks": 123,
"ctr": 123,
"attributed_add_to_carts": 123,
"attributed_orders": 123,
"attributed_revenue": 123,
"currency": "<string>",
"revenue_currencies": [
"<string>"
],
"aov": 123,
"atc_rate": 123,
"purchase_rate": 123,
"first_data_at": "<string>",
"surface_id": "<string>",
"surface_name": "<string>"
}{
"detail": "<string>"
}{
"detail": "<string>"
}{
"detail": "<string>"
}{
"detail": "<string>"
}{
"detail": "<string>"
}One recommendation surface's performance totals
As the totals route, narrowed to one surface by id, with the surface’s current name. An unknown or deleted surface answers 200 with its history (zeros if none) and a null name, never 404. Counts come from storefront events attributed to recommendation carousels; money figures use the shared Depict attribution rule. Read-only; answers from Tinybird analytics.
A valid request URL is required to generate request examples{
"impressions": 123,
"clicked_impressions": 123,
"clicks": 123,
"ctr": 123,
"attributed_add_to_carts": 123,
"attributed_orders": 123,
"attributed_revenue": 123,
"currency": "<string>",
"revenue_currencies": [
"<string>"
],
"aov": 123,
"atc_rate": 123,
"purchase_rate": 123,
"first_data_at": "<string>",
"surface_id": "<string>",
"surface_name": "<string>"
}{
"detail": "<string>"
}{
"detail": "<string>"
}{
"detail": "<string>"
}{
"detail": "<string>"
}{
"detail": "<string>"
}Authorizations
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
The surface's id (a uuid), not its name.
Query Parameters
Lite merchant id, e.g. shopify-<shop id>.
First day, inclusive (UTC).
^\d{4}-\d{2}-\d{2}$"2026-09-01"
Last day, inclusive (UTC).
^\d{4}-\d{2}-\d{2}$"2026-09-01"
Restricts to one Shopify market (its market group's members); absent or empty = every market.
Converts the money figures into this currency (the shop's base currency); absent = as summed, null when mixed.
^[A-Z]{3}$Response
The surface's totals.
Carousels shown (distinct request ids); null where the storefront does not track impressions.
Carousels with at least one click; null whenever impressions is.
Product clicks in carousels.
clicked_impressions / impressions.
In currency; null when the window mixes currencies and no currency was asked for.
Every currency the window's orders were placed in.
attributed_revenue / attributed_orders.
attributed_add_to_carts / clicks.
attributed_orders / clicks.
When the merchant's first day with a recommendation click or impression began (UTC); null before any. Merchant-wide.
The surface's current name; null for a deleted or unknown surface, whose history still reads.
Was this page helpful?