SupplyChainService

GetChokepointStatus

GetChokepointStatus retrieves seeded chokepoint status. Empty chokepoints with upstream_unavailable=true means the seed snapshot is unavailable/ degraded, not that there are confirmed zero chokepoints.

get/api/supply-chain/v1/get-chokepoint-status

Request

  • Base URL: https://api.worldmonitor.app
  • URL: https://api.worldmonitor.app/api/supply-chain/v1/get-chokepoint-status
  • Auth: one of:
    • API key in header X-WorldMonitor-Key
    • API key in header X-Api-Key

Query parameters

jmespathstring

JMESPath; 1024 UTF-8 bytes; 256 KB output cap.

Response

OK

fetchedAtstring

ISO-8601 time the status snapshot was fetched. Empty string with upstream_unavailable=true means the snapshot is unavailable/degraded.

upstreamUnavailableboolean

True when upstream seed/relay data is unavailable or partial. When true, an empty chokepoints array is graceful degradation, not confirmed zero data.

Changes

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