Skip to main content
GET
Get Collection Metrics Endpoint

Authorizations

Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Path Parameters

merchant_id
string
required
collection_id
string<uuid>
required

Query Parameters

market
string | null
start_timestamp
integer | null
end_timestamp
integer | null
locale
string | null
market_group_id
string | null

Response

Successful Response

period
CollectionMetricsPeriod · object
required
total_revenue
CollectionRevenueMetric · object
required
total_views
CollectionMetricValue · object
required
total_clicks
CollectionMetricValue · object
required
avg_ctr
CollectionRateMetric · object
required
units_sold
CollectionMetricValue · object
required
avg_str
CollectionRateMetric · object
required
add_to_carts
CollectionMetricValue · object
dead_stock
CollectionMetricValue · object
avg_stock_coverage_days
number | null
rpm
CollectionRevenueMetric · object
velocity
CollectionMetricValue · object
auto_lift
CollectionAutoLift · object

Derived "Auto Lift" score: how the click-through rate of auto-sorted (non-pinned) products compares to the merchant's manually pinned products.

score is normalised to 0-100 where 50 means auto and pinned perform equally, 100 means auto CTR is >= 2x pinned CTR, and 0 means auto products get no clicks. Computed as clamp(50 * auto_ctr / pinned_ctr, 0, 100). It is None when the collection has no pinned products or no auto (non-pinned) products, so there is nothing to compare. pinned_ctr and auto_ctr are percentages (0-100); delta_pts is auto_ctr - pinned_ctr in percentage points.

top_product
CollectionTopProduct · object | null

The highest-revenue product in a collection, for the overview table's "Top Product" column. image_url is the product's first image (or None).