Error
A valid request URL is required to generate request examples{
"offset": 123,
"has_next": true,
"collections": [
{
"collection_id": "<string>",
"title": "<string>",
"handle": "<string>",
"image_urls": [
"<string>"
],
"shopify_sort_order": "MANUAL",
"sort_order": "ALPHA_ASC",
"has_depict_configuration": true,
"sync_back_to_shopify": true,
"unpin_oos": true,
"updated_at": "<string>",
"shopify_updated_at": "<string>",
"use_collection_specific_boost_bury": true,
"main_version": "<string>",
"n_products": 123,
"n_pinned_main_product_ids": 123,
"product_images": [
"<string>"
],
"has_scheduled_version": true,
"selected_period_data": {
"clicks": 123,
"views": 123,
"percentage_of_max_clicks": 123,
"percentage_of_total_clicks": 123,
"clickthrough_rate": 123
}
}
]
}{
"detail": "<string>"
}{
"detail": "<string>"
}{
"detail": "<string>"
}{
"detail": "<string>"
}{
"detail": "<string>"
}{
"detail": "<string>"
}API Reference
The collections dashboard: a sorted, filtered page with traffic
Returns one page of the merchant’s collections with their traffic over [from_date, to_date] (views, clicks, CTR), ordered by traffic (top_views, top_ctr, top_clicks) or metadata (updated_at, name_a_z, number_of_products), optionally filtered by status and title. Read-only; POST because the filters and date window travel as a JSON body. To page, pass the response’s offset back while has_next is true.
POST
/
collections
/
data-sorted-by
Error
A valid request URL is required to generate request examples{
"offset": 123,
"has_next": true,
"collections": [
{
"collection_id": "<string>",
"title": "<string>",
"handle": "<string>",
"image_urls": [
"<string>"
],
"shopify_sort_order": "MANUAL",
"sort_order": "ALPHA_ASC",
"has_depict_configuration": true,
"sync_back_to_shopify": true,
"unpin_oos": true,
"updated_at": "<string>",
"shopify_updated_at": "<string>",
"use_collection_specific_boost_bury": true,
"main_version": "<string>",
"n_products": 123,
"n_pinned_main_product_ids": 123,
"product_images": [
"<string>"
],
"has_scheduled_version": true,
"selected_period_data": {
"clicks": 123,
"views": 123,
"percentage_of_max_clicks": 123,
"percentage_of_total_clicks": 123,
"clickthrough_rate": 123
}
}
]
}{
"detail": "<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.
Query Parameters
Lite merchant id, e.g. shopify-<shop id>.
Body
application/json
Pattern:
^\d{4}-\d{2}-\d{2}$Example:
"2026-09-01"
Pattern:
^\d{4}-\d{2}-\d{2}$Example:
"2026-09-01"
Required range:
x >= 0Required range:
x >= 1Case-insensitive title filter.
Available options:
top_views, top_ctr, top_clicks, updated_at, name_a_z, number_of_products Available options:
live, draft, scheduled, not_live, null Was this page helpful?

