Skip to main content
GET
Compare Collection Analytics Endpoint

Authorizations

Authorization
string
header
required

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

Headers

X-API-Key
string | null

Path Parameters

merchant_id
string
required
collection_id
string<uuid>
required

Query Parameters

period_type
enum<string>
required
Available options:
week,
month,
week4
period_a
string<date>
required

ISO date — period A start

period_b
string<date>
required

ISO date — period B start

market
string | null
locale
string | null
market_group_id
string | null

Response

CollectionProductCompareResponse · object | null

Successful Response

collection_id
string<uuid>
required
title
string
required
period_a
AnalyticsSourceMeta · object
required
period_b
AnalyticsSourceMeta · object
required
products
ProductCompareRow · object[]
removed_products
ProductCompareRow · object[]
toplists_a
Toplists A · object
toplists_b
Toplists B · object