CompanyMonitoringService

GetCompanyCoverage

Returns the current coverage state for one account-scoped monitored company. Requires company_monitoring:read; runtime remains disabled until dependency #6003 passes.

get/api/company-monitoring/v1/get-company-coverage

Request

  • Base URL: https://api.worldmonitor.app
  • URL: https://api.worldmonitor.app/api/company-monitoring/v1/get-company-coverage
  • Auth: one of:
    • API key in header X-WorldMonitor-Key
    • API key in header X-Api-Key

Query parameters

company_idstring required

Account-scoped logical company ID; storage identifiers are not accepted.

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

companyIdstring

Changes