Skip to main content
POST
GetHumanitarianSummaryBatch

Authorizations

X-WorldMonitor-Key
string
header
required

User-issued WorldMonitor API key.

Headers

Idempotency-Key
string

Optional client-generated idempotency key. Retrying a POST with the same key and an identical request body replays the original response (only the status, body, and Content-Type are reproduced) instead of re-executing; reusing the key with a different body is rejected with 422. For mutations this avoids duplicating the side effect, while for batch-read POSTs it replays a cached snapshot that can be up to 24 hours stale. Keys are scoped per authenticated caller (falling back to the source IP for unauthenticated endpoints) and retained for 24 hours.

Required string length: 1 - 255
Pattern: ^[\x21-\x7E]{1,255}$

Body

application/json

GetHumanitarianSummaryBatchRequest looks up humanitarian summaries for multiple countries.

countryCodes
string[]
Required array length: 1 - 25 elements

ISO 3166-1 alpha-2 country codes (e.g., "YE", "SD"). Max 25.

Response

Successful response

GetHumanitarianSummaryBatchResponse contains humanitarian summaries for the requested countries.

results
object

Map of country_code -> humanitarian summary for found countries.

fetched
integer<int32>

Number of countries successfully fetched.

requested
integer<int32>

Number of countries requested.