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

Query Parameters

locale
string | null

Response

Successful Response

Merchant-wide analytics for the hub page.

totals reuses the collection summary aggregate over the entire catalog (every product with metrics, pinned split empty — auto_lift is meaningless there and should be ignored). collections_considered is how many collections the rollups cover (capped at _MAX_COLLECTIONS).

totals
CollectionMetricsSummary · object
required
top_collections
OverviewCollection · object[]
declining_collections
OverviewCollection · object[]
pinned_vs_auto
PinnedVsAutoRollup · object

How many collections fall into each pinned-vs-auto health bucket (same thresholds as the collections table's status column). no_pins counts collections with nothing pinned (or no data), where there is nothing to compare.

collections_considered
integer
default:0