Skip to main content
GET
Get Collection Analytics 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

Rich payload for the Collection Analytics drawer. scroll_depth is always None for now -- there is no scroll tracking, documented as a data gap. summary reuses the same aggregate as the /metrics endpoint.

collection_id
string<uuid>
required
title
string
required
period
CollectionMetricsPeriod · object
required
summary
CollectionMetricsSummary · object
required
inventory
AnalyticsInventoryBreakdown · object
required

Inventory health for the in-scope products.

hidden is the count of manually-hidden products. low_stock counts visible products with 0 < inventory <= LOW_STOCK_UNITS; ok counts visible products with inventory > LOW_STOCK_UNITS. Fully out-of-stock visible products (inventory == 0) are counted in total but not in ok/low_stock. total is the number of in-scope products (visible + hidden). at_risk is hidden + low_stock (degrading to the hidden lower bound when inventory is unknown). unknown counts visible products with metrics whose inventory level is unknown — they are in neither ok nor low_stock and must not be read as out of stock; in a fully blanked/quantity-less scope that is every product with metrics. Unknown products' variants are excluded from variants_in_stock/ variants_total (their variant rows would read as 0 in stock), and their sales still count toward the coverage denominator, so avg_stock_coverage_days is understated in proportion to the unknown share under partial coverage. avg_stock_coverage_days is total_inventory / (units_sold / period_days) and None when nothing sold in the period. When no member has a known inventory level (blanked scope or quantity-less feed), low_stock/ok and the coverage are None (unknown), and at_risk is the hidden lower bound.

variant_availability_pct (0-100) is in-stock variants ÷ total variants across the in-scope products with known inventory (variants_in_stock / variants_total are the raw sums over that same subset — see the unknown exclusion above). None when the merchant has no variant-level inventory data.

scroll_depth
number | null
top_products
AnalyticsProductRef · object[]
needs_attention
AnalyticsAttentionProduct · object[]
pinned_vs_auto
AnalyticsPinnedVsAutoItem · object[]
sell_through_by_tier
AnalyticsTierStr · object[]
position_performance
AnalyticsPositionBand · object[]
total_products
integer
default:0