Skip to main content
Run a report

Authorizations

Authorization
string
header
required

Public API token passed as Authorization: Bearer .

Path Parameters

report
enum<string>
required

Report identifier.

Available options:
average-price-trend,
cheapest-trend,
competitor-leaderboard,
headroom-and-exposure,
offers-trend,
position-distribution,
price-ranges,
price-change-funnel,
price-change-status-trend,
price-direction-heatmap,
volatility-list

Query Parameters

timeWindow
enum<string>

Report time window used by all reports.

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

Filter reports to specific Shopify product variant IDs. Used by all reports except volatility-list. Repeat the parameter or pass a comma-separated list.

collectionId
string

Filter reports to variants in a Shopify collection. Used by all reports except volatility-list.

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
priceBasis
enum<string>

Price basis used by cheapest-trend, position-distribution, and price-ranges.

Available options:
price,
total
page
integer

One-based page number used by competitor-leaderboard.

Required range: 1 <= x <= 100000
perPage
integer

Items per page used by competitor-leaderboard.

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

Sort field used by competitor-leaderboard.

Available options:
shopName,
sharedListings,
timesRankOne,
undercutShare,
avgPosition,
timesRankOneByPrice,
timesRankOneByTotal,
undercutShareByPrice,
undercutShareByTotal,
avgPricePosition,
avgTotalPosition,
avgShipping
sortDirection
enum<string>

Sort direction used by competitor-leaderboard.

Available options:
asc,
desc

Case-insensitive competitor shop-name search used by competitor-leaderboard.

headroomLimit
integer

Maximum headroom rows used by headroom-and-exposure.

Required range: 1 <= x <= 50
exposureLimit
integer

Maximum exposure rows used by headroom-and-exposure.

Required range: 1 <= x <= 50
limit
integer

Maximum rows used by price-ranges and volatility-list.

Required range: 1 <= x <= 50

Response

Successful response.

The response is of type object.