A valid request URL is required to generate request examples{
"current": {
"views": 123,
"clicks": 123,
"product_clicks": 123,
"viewing_shoppers": 123,
"clicking_shoppers": 123,
"click_events": 123,
"clickthrough_rate": 123,
"collections": 123
},
"previous": {
"views": 123,
"clicks": 123,
"product_clicks": 123,
"viewing_shoppers": 123,
"clicking_shoppers": 123,
"click_events": 123,
"clickthrough_rate": 123,
"collections": 123
},
"total_collections": 123
}{
"detail": "<string>"
}{
"detail": "<string>"
}{
"detail": "<string>"
}{
"detail": "<string>"
}{
"detail": "<string>"
}Merchant-wide collection traffic totals for a window
Returns merchant-wide collection-page traffic (views, clicks, shoppers, click-through) summed over all collections for [from_date, to_date], and for the same-length window immediately before it so a caller can show a delta. Read-only; answers from Tinybird analytics, cached privately for 5 minutes. A null row means no collection traffic in that window.
A valid request URL is required to generate request examples{
"current": {
"views": 123,
"clicks": 123,
"product_clicks": 123,
"viewing_shoppers": 123,
"clicking_shoppers": 123,
"click_events": 123,
"clickthrough_rate": 123,
"collections": 123
},
"previous": {
"views": 123,
"clicks": 123,
"product_clicks": 123,
"viewing_shoppers": 123,
"clicking_shoppers": 123,
"click_events": 123,
"clickthrough_rate": 123,
"collections": 123
},
"total_collections": 123
}{
"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.
Query Parameters
Lite merchant id, e.g. shopify-<shop id>.
First day, inclusive.
^\d{4}-\d{2}-\d{2}$"2026-09-01"
Last day, inclusive.
^\d{4}-\d{2}-\d{2}$"2026-09-01"
Restricts traffic to one Shopify market (the id the portal's market picker sends); the response then omits total_collections.
Response
Both windows.
previous is the same-length window just before current; a null row is a window with no collection traffic.
Was this page helpful?