Skip to main content
List product metrics

Authorizations

Authorization
string
header
required

Public API token passed as Authorization: Bearer .

Query Parameters

page
integer

One-based page number.

Required range: x >= 1
perPage
integer

Number of items per page.

Required range: 1 <= x <= 100
timeWindow
enum<string>

Metrics time window understood by the reporting layer.

Available options:
7d,
14d,
30d
variantIds
string[]

Filter results to specific Shopify product variant IDs. Repeat the parameter or pass a comma-separated list.

collectionId
string

Filter results to variants in a Shopify collection.

sortBy
enum<string>

Metric field to sort by.

Available options:
currentMinPrice,
currentMinTotal,
currentOwnPrice,
currentOwnTotal,
avgOwnPrice,
avgOwnTotal,
avgMinPrice,
avgMinTotal,
currentOwnPricePosition,
currentOwnTotalPosition,
avgOwnPricePosition,
avgOwnTotalPosition,
pctOwnCheapestByPrice,
pctOwnCheapestByTotal,
volatility,
lastSnapshotAt
sortDirection
enum<string>

Sort direction.

Available options:
asc,
desc
source
enum<string>

Price source to query.

Available options:
IDEALO,
GOOGLE_SHOPPING,
KLARNA,
PRICERUNNER,
ALLEGRO,
AMAZON
country
enum<string>

Market country code to query.

Available options:
AE,
AT,
AU,
BE,
BG,
BR,
CA,
CH,
CN,
CZ,
DE,
DK,
ES,
FI,
FR,
GR,
HR,
HU,
IE,
IN,
IT,
JP,
NL,
NO,
PL,
PT,
RO,
MX,
SE,
SK,
UK,
US

Response

Successful response.

rows
object[]
pagination
object