Get Collection Analytics Endpoint
Authorizations
The access token received from the authorization server in the OAuth 2.0 flow.
Query Parameters
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.
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.
avg_stock_coverage_days is total_inventory / (units_sold / period_days)
and None when nothing sold in the period.
variant_availability_pct (0-100) is in-stock variants ÷ total variants
across the in-scope products' size/colour variants (variants_in_stock /
variants_total are the raw sums). None when the merchant has no
variant-level inventory data.

