Home > Overview price-distribution card (catalogue histogram)
Returns the active catalogue as a fixed 7-band price histogram, plus the catalogue size and default currency. Prices come from variant_countries.price for the company’s default country (products.price is essentially empty on real tenants).
Authorizations
Bearer token authentication. Requires a company-admin token
whose role holds reports.view. Additionally, the caller's
company must have ANALYTICS_DASHBOARD enabled — otherwise
every endpoint returns 404.
Query Parameters
ISO alpha-2 code of one of the requesting company's configured
countries (see GET /countries). When present, every service
on this endpoint filters its data to that country and reports
money in the country's own currency. Omit (or send "all")
for the aggregate-across-countries view, which is the default
and matches pre-Phase-004 behavior. Unknown ISO codes or ones
the company is not configured for return 400.
"US"
Response
Price-distribution card payload
Active-catalogue price histogram on the company's default country. Products without a default-country variant drop out — they aren't sellable in the operator's home market and would otherwise inflate the low band.
7 elementsx >= 0Decimal amount, expressed as a string to preserve arbitrary
precision across the wire. Parsed to Number on the client and
formatted with Intl.NumberFormat. Once the in-flight
money-cents-migration lands, this will switch to a
{ amount_cents: integer, currency: string } object.
"180.25"
ISO 4217 three-letter code (uppercase).
3"USD"