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.

Path Parameters

collection_id
string
required

The Shopify collection id (numeric, no gid prefix).

Query Parameters

merchant_id
string
required

Lite merchant id, e.g. shopify-<shop id>.

from_date
string
required

First day, YYYY-MM-DD.

to_date
string
required

Last day, YYYY-MM-DD; at most 365 days after from_date.

Response

One row per content block with clicks.

content_block_id
integer
required
handle
string
required

The content block's handle.

nbr_clicks
integer
required
unique_click_sessions
integer
unique_impression_sessions
integer

Sessions that saw the block; with unique_click_sessions, the click-through rate.