Skip to main content
GET
Home > Overview price-distribution card (catalogue histogram)

Authorizations

Authorization
string
header
required

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

country
string

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.

Example:

"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.

buckets
object[]
required
Required array length: 7 elements
catalogue_size
integer
required
Required range: x >= 0
median_price
string
required

Decimal 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.

Example:

"180.25"

currency
string
required

ISO 4217 three-letter code (uppercase).

Required string length: 3
Example:

"USD"

meta
object