ConsumerPricesService

GetConsumerPriceFreshness

GetConsumerPriceFreshness retrieves feed freshness and coverage health per retailer.

get/api/consumer-prices/v1/get-consumer-price-freshness

Request

  • Base URL: https://api.worldmonitor.app
  • URL: https://api.worldmonitor.app/api/consumer-prices/v1/get-consumer-price-freshness
  • Auth: one of:
    • API key in header X-WorldMonitor-Key
    • API key in header X-Api-Key

Query parameters

market_codestring

market_code is the ISO 3166-1 alpha-2 market identifier.

jmespathstring

Optional JMESPath expression applied server-side to project or reduce the JSON response before it is returned (mirrors the MCP jmespath argument). Invalid expressions, expressions larger than 1024 UTF-8 bytes, or projections that exceed the 256 KB output cap return HTTP 400 with a {_jmespath_error, original_keys} envelope. Grammar and worked examples: https://www.worldmonitor.app/docs/mcp-jmespath.

Response

OK

marketCodestring

market_code echoes the requested market.

asOfstring int64

as_of is the Unix millisecond timestamp of the snapshot.

overallFreshnessMininteger

overall_freshness_min is the average freshness lag across all retailers.

stalledCountinteger

stalled_count is the number of retailers with no recent successful scrape.

upstreamUnavailableboolean

upstream_unavailable is true when the companion service could not be reached.

Changes

No recorded changes to this operation across all 1 revision of this API.