A valid request URL is required to generate request examples{
"metrics": [
{
"merchant": "<string>",
"main_product_id": "<string>",
"clicks": 123,
"prev_clicks": 123,
"add_to_carts": 123,
"prev_add_to_carts": 123,
"orders": 123,
"prev_orders": 123,
"product_views": 123,
"revenue": 123,
"click_through_rate": 123,
"add_to_cart_rate": 123,
"order_through_rate": 123,
"d_score": 123,
"prev_d_score": 123,
"normalized_d_score": 123,
"normalized_prev_d_score": 123,
"product": {
"main_product_id": "<string>",
"title": "<string>",
"handle": "<string>",
"images": [
{
"id": "<string>",
"url": "<string>",
"width": 123,
"height": 123,
"alt": "<string>"
}
],
"tags": [
"<string>"
],
"price": 123,
"price_currency": "<string>",
"status": "ACTIVE",
"has_online_store_channel": true,
"in_stock": true,
"quantity": 123,
"badges": [
{
"type": "on_sale",
"sale_percentage": 123,
"markets_on_sale": [
{
"market_id": "<string>",
"display_name": "<string>"
}
],
"total_markets": 123,
"market_group_display_name": "<string>"
}
],
"skus": [
"<string>"
],
"created_at": "<string>",
"published_at": "<string>",
"variants": [
{
"id": "<string>",
"title": "<string>",
"sku": "<string>",
"quantity_available": 123,
"image_url": "<string>",
"selected_options": [
{
"name": "<string>",
"value": "<string>"
}
]
}
]
},
"collections": [
{
"collection_id": "<string>",
"position": 123,
"title": "<string>",
"n_products": 123,
"image_urls": [
"<string>"
],
"product_images": [
"<string>"
],
"merchandised": true,
"recommendation": "good"
}
],
"needs_attention": {
"uncartable": true,
"bring_up_collection_id": "<string>",
"take_action_collection_id": "<string>"
}
}
],
"has_more": true
}{
"detail": "<string>"
}{
"detail": "<string>"
}{
"detail": "<string>"
}{
"detail": "<string>"
}{
"detail": "<string>"
}Per-product funnel: clicks, carts, orders, performance score
A page of products ranked by order_by (the performance score by default), each with clicks, add-to-carts, orders, views, revenue and their previous-period values, the product itself, the collections it sits in and a Need attention verdict. The performance score is units ordered, shown 0–10 against the best product in the result; under the default order_by only products clicked in a collection grid in the window are scored. Need attention flags products that sell but sit low in a merchandised grid (bring up) and products near the top that barely sell (take action). Storewide, or one collection’s products with collection_id. Page with offset/page_size while has_more. Full rows are large; view=summary drops the product and collection details for ranking a whole catalogue (title, the numbers, the verdict and the grids it names), and is what the assistant connector uses by default. For full details on a few products use view=full with a small page_size, or productSearch with query = the product id. Read-only.
A valid request URL is required to generate request examples{
"metrics": [
{
"merchant": "<string>",
"main_product_id": "<string>",
"clicks": 123,
"prev_clicks": 123,
"add_to_carts": 123,
"prev_add_to_carts": 123,
"orders": 123,
"prev_orders": 123,
"product_views": 123,
"revenue": 123,
"click_through_rate": 123,
"add_to_cart_rate": 123,
"order_through_rate": 123,
"d_score": 123,
"prev_d_score": 123,
"normalized_d_score": 123,
"normalized_prev_d_score": 123,
"product": {
"main_product_id": "<string>",
"title": "<string>",
"handle": "<string>",
"images": [
{
"id": "<string>",
"url": "<string>",
"width": 123,
"height": 123,
"alt": "<string>"
}
],
"tags": [
"<string>"
],
"price": 123,
"price_currency": "<string>",
"status": "ACTIVE",
"has_online_store_channel": true,
"in_stock": true,
"quantity": 123,
"badges": [
{
"type": "on_sale",
"sale_percentage": 123,
"markets_on_sale": [
{
"market_id": "<string>",
"display_name": "<string>"
}
],
"total_markets": 123,
"market_group_display_name": "<string>"
}
],
"skus": [
"<string>"
],
"created_at": "<string>",
"published_at": "<string>",
"variants": [
{
"id": "<string>",
"title": "<string>",
"sku": "<string>",
"quantity_available": 123,
"image_url": "<string>",
"selected_options": [
{
"name": "<string>",
"value": "<string>"
}
]
}
]
},
"collections": [
{
"collection_id": "<string>",
"position": 123,
"title": "<string>",
"n_products": 123,
"image_urls": [
"<string>"
],
"product_images": [
"<string>"
],
"merchandised": true,
"recommendation": "good"
}
],
"needs_attention": {
"uncartable": true,
"bring_up_collection_id": "<string>",
"take_action_collection_id": "<string>"
}
}
],
"has_more": true
}{
"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"
Rows to skip.
x >= 0DESC, ASC d_score is the performance score: units of the product ordered storewide in the window. Under d_score (and clicks, carts, orders) only products clicked in a collection grid in the window are ranked; product_views and revenue rank every product with activity.
d_score, clicks, add_to_carts, orders, product_views, revenue Rows per page.
1 <= x <= 20000full: each row carries the product and every collection it sits in. summary: the id, title, funnel numbers, Need attention verdict and the grids it names, for ranking a whole catalogue.
full, summary Scope the page to one collection's products, including ones with no activity.
1 appends catalogue products with no activity after the ranked ones (DESC, storewide only).
1 Was this page helpful?

