Skip to main content
GET
GetRegionalSnapshot

Authorizations

X-WorldMonitor-Key
string
header
required

User-issued WorldMonitor API key.

Query Parameters

region_id
string
required

Display region id (e.g. "mena", "east-asia", "europe"). See shared/geography.js. Kebab-case: lowercase alphanumeric groups separated by single hyphens, no trailing or consecutive hyphens.

Pattern: ^[a-z][a-z0-9]*(-[a-z0-9]+)*$
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

GetRegionalSnapshotResponse returns the latest RegionalSnapshot for the requested region. The snapshot is written by scripts/seed-regional-snapshots.mjs on a 6h cron; this handler only reads canonical state.

snapshot
object

RegionalSnapshot is the canonical intelligence object for one region. See docs/internal/pro-regional-intelligence-upgrade.md for the full spec and shared/regions.types.d.ts for the authoritative TypeScript contract.