Get Cluster Products

Competitor storefront URLs to narrow to. Narrows within the subscription gate; never widens it.

Days scaling_units_per_day looks back when the list has no date range. With published_after/published_before it compares the bestseller snapshots of that range instead, else those of created_after/created_before.

Only products carrying any of these tags (head state).

Only products with any of these vendors (head state).

Only products with any of these types (head state).

Only products the competitor published at/after this time

Only products the competitor published at/before this time

Only products the competitor created at/after this time (Shopify created_at; products without it drop out)

Only products the competitor created at/before this time (Shopify created_at; products without it drop out)

Only products whose sales_estimate compares true, written <op>:<n>: op is eq, gt, gte, lt or lte, n a non-negative integer. gt:0 = sold above the tail; eq:0 = in the tail; also e.g. gte:10. The estimate is compared rounded to a whole number. A null sales_estimate never matches, under any operator. Lags real sales by days. Repeat the param to bound a range (gte:5, lte:10).

Only products whose revenue_estimate compares true in revenue_currency, written <op>:<n>: op is eq, gt, gte, lt or lte, n a non-negative decimal. Revenue is converted from the store's currency at the latest ECB rate; a null revenue, or a store whose currency the ECB does not quote, never matches. Repeat the param to bound a range.

Currency of the revenue_estimate filter and sort, an ECB-quoted ISO 4217 code. The list items keep their revenue in the store's currency.

Only products whose bestseller_top_percent compares true, written <op>:<n>: op is eq, gt, gte, lt or lte, n a non-negative integer, e.g. lte:5 = in the top 5 % of their store's sold products (tail_start - 1). A null bestseller_top_percent never matches, so a product in the list's last group matches no operator; fewer than 100 sold products have no top 1 %.

Only products whose scaling_units_per_day compares true, written <op>:<n>: op is eq, gt, gte, lt or lte, n a non-negative decimal, e.g. gt:0 = climbed at all, gte:0.5. A null scaling_units_per_day never matches.

Only products whose scaling_overtake_percent compares true, written <op>:<n>: op is eq, gt, gte, lt or lte, n a non-negative decimal, e.g. gte:10 = overtook at least 10 % of the store's sold products. A null scaling_overtake_percent never matches. With scaling_units_per_day both apply. Repeat the param to bound a range.

Only products whose price (first variant, in the store's currency) compares true. A list of <op>:<n>, op eq, gt, gte, lt or lte; every value must hold (AND). A null price never matches.

Only products in any of these category groups, written in:<group_label>.

Category labels, written in:<label> (any of them) and/or not_in:<label> (none of them; unclassified products pass). With category_group a product matches either one.

Imported into each of these stores (in:<store id>, a bare id means in) and into none of not_in:<store id>; every value must hold (AND).

The first sale of the product, written <op>:<ISO 8601>; every value must hold (AND). A naive time is UTC.

Watched stores, written in:<id> (only these; a bare id means in) or not_in:<id> (every subscribed store but these); one operator per request. Narrows within the subscription gate; never widens it.

Stores the viewer tagged, written in:<tag> (any of them; no prefix means in) or not_in:<tag> (none of them); one operator per request. Named apart from tags, which means PRODUCT tags. Narrows within the subscription gate; never widens it.

The store's product count. A list of <op>:<n>, op eq, gt, gte, lt or lte; every value must hold (AND).

The store's bestseller_sold_count. A list of <op>:<n>, op eq, gt, gte, lt or lte; every value must hold (AND). A store without a bestseller snapshot never matches.

Only stores selling in any of these ISO 4217 currencies, written in:<code>.

Only stores that ship to any of these ISO 3166 alpha-2 countries (their meta.json ships_to_countries), written in:<code>, e.g. in:DE. A store not scanned since the field exists never matches.