Skip to main content
GET
GetGivingSummary

Authorizations

X-WorldMonitor-Key
string
header
required

User-issued WorldMonitor API key.

Query Parameters

platform_limit
integer<int32>

Number of platform rows to return (0 = all). Aggregates and provenance continue to describe the full snapshot.

category_limit
integer<int32>

Number of category rows to return (0 = all). Aggregates and provenance continue to describe the full snapshot.

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

GetGivingSummaryResponse contains a cacheable published-claim snapshot.

summary
object

GivingSummary is a cacheable snapshot of published giving claims. Source reference periods live in provenance; generated_at is only the time this response snapshot was materialized.

fetchedAt
integer<int64>

Cache/response materialization time as Unix epoch milliseconds. This is not source publication or observation time. A value of 0 means the snapshot is unavailable/degraded, not that giving activity is zero.. Warning: Values > 2^53 may lose precision in JavaScript

dataAvailable
boolean

True when a summary payload is populated. False means an absent/empty summary is graceful degradation because the snapshot is unavailable; provenance and data mode are not required on that degraded shape.