Skip to main content
GET
GetConsumerPriceFreshness

Authorizations

X-WorldMonitor-Key
string
header
required

User-issued WorldMonitor API key.

Query Parameters

market_code
string

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

jmespath
string

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

Successful response

GetConsumerPriceFreshnessResponse describes feed health for all retailers.

marketCode
string

market_code echoes the requested market.

asOf
string<int64>

as_of is the Unix millisecond timestamp of the snapshot.

retailers
object[]
overallFreshnessMin
integer<int32>

overall_freshness_min is the average freshness lag across all retailers.

stalledCount
integer<int32>

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

upstreamUnavailable
boolean

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