IntelligenceService

SearchGdeltDocuments

SearchGdeltDocuments searches the GDELT GKG API for relevant documentation.

get/api/intelligence/v1/search-gdelt-documents

Request

  • Base URL: https://api.worldmonitor.app
  • URL: https://api.worldmonitor.app/api/intelligence/v1/search-gdelt-documents
  • Auth: one of:
    • API key in header X-WorldMonitor-Key
    • API key in header X-Api-Key

Query parameters

querystring required

Search query string.

max_recordsinteger

Maximum number of articles to return. Defaults to 10 when omitted or <= 0. The handler caps returned results at 20, so values above 20 (though accepted, up to the validation limit of 250) still return at most 20 articles.

timespanstring

Time span filter (e.g., "15min", "1h", "24h"). Accepted but currently ignored; no-op until this handler supports the parameter.

tone_filterstring

Tone filter appended to query (e.g., "tone>5" for positive, "tone<-5" for negative). Left empty to skip tone filtering. Accepted but currently ignored; no-op until this handler supports the parameter.

sortstring

Sort mode: "DateDesc" (default), "ToneDesc", "ToneAsc", "HybridRel". Accepted but currently ignored; no-op until this handler supports the parameter.

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

querystring

Echo of the search query.

errorstring

Error message if the search failed.

Changes

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