Run a report
Runs one report by name. Query parameters are a superset shared across the 11 report types; unsupported extras are ignored by reports that do not read them.
Authorizations
Public API token passed as Authorization: Bearer .
Path Parameters
Report identifier.
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
Report time window used by all reports.
7d, 14d, 30d Filter reports to specific Shopify product variant IDs. Used by all reports except volatility-list. Repeat the parameter or pass a comma-separated list.
Filter reports to variants in a Shopify collection. Used by all reports except volatility-list.
Price source to query.
IDEALO, GOOGLE_SHOPPING, KLARNA, PRICERUNNER, ALLEGRO, AMAZON Market country code to query.
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 Price basis used by cheapest-trend, position-distribution, and price-ranges.
price, total One-based page number used by competitor-leaderboard.
1 <= x <= 100000Items per page used by competitor-leaderboard.
1 <= x <= 100Sort field used by competitor-leaderboard.
shopName, sharedListings, timesRankOne, undercutShare, avgPosition, timesRankOneByPrice, timesRankOneByTotal, undercutShareByPrice, undercutShareByTotal, avgPricePosition, avgTotalPosition, avgShipping Sort direction used by competitor-leaderboard.
asc, desc Case-insensitive competitor shop-name search used by competitor-leaderboard.
Maximum headroom rows used by headroom-and-exposure.
1 <= x <= 50Maximum exposure rows used by headroom-and-exposure.
1 <= x <= 50Maximum rows used by price-ranges and volatility-list.
1 <= x <= 50Response
Successful response.
The response is of type object.