Reports
Humanitarian updates, situation reports, assessments, maps, and infographics from ReliefWeb sources (reliefweb.int/updates).
Tagged with country, primary_country, source, theme, format, disaster, disaster_type, and language, with downloadable attachments in file and images in image.
- Endpoint:
POSTorGET https://api.reliefweb.int/v2/reports - Single report:
GET https://api.reliefweb.int/v2/reports/{id|uuid}
Defaults
Requests to /v2/reports default to profile=minimal and preset=minimal. Single-record requests (/v2/reports/{id}) default to profile=default and preset=minimal. See Choose fields and presets.
Profiles
| Profile | Fields |
|---|---|
minimal |
title
|
list |
title, url, date.created, status, primary_country.name, country.name, source.name, source.homepage
|
full |
All fields |
default |
All fields |
Add more with fields.include.
Presets
| Preset | Status filter | Sort | Default query fields |
|---|---|---|---|
minimal |
published, to-review |
n/a | title |
latest |
published, to-review |
date.created:desc |
body, country, disaster, disaster_type, format.name, headline.title, headline.summary, language, primary_country, source, theme.name, title, vulnerable_groups |
analysis |
published, to-review |
n/a | body, country, disaster, disaster_type, format.name, headline.title, headline.summary, language, primary_country, source, status, theme.name, title, vulnerable_groups |
Available fields
| Name | Description | Type | Attributes |
|---|---|---|---|
body |
Main text in Markdown format | string | searchable |
body-html |
Main text in HTML format | string | |
country |
Shortcut for country - defaults to country.name | string | searchable facetable exact multi common |
country.id |
Id for country used by ReliefWeb | integer | searchable facetable exact |
country.iso3 |
ISO 3166-1 alpha-3 code | string | searchable facetable exact |
country.name |
Name of country in English | string | searchable facetable exact |
country.primary |
Flag to indicate this is the primary country | boolean | |
country.shortname |
Short name of country where applicable, for example 'Syria' for 'Syrian Arab Republic' | string | searchable facetable exact |
date |
Shortcut for date fields - defaults to date.created | object | facetable |
date.changed |
Date entry modified on ReliefWeb (ISO 8601) | date | sortable facetable |
date.created |
Date entry created on ReliefWeb (ISO 8601) | date | sortable facetable |
date.original |
Date entry first published by original source (ISO 8601) | date | sortable facetable |
disaster |
Shortcut for related disaster - defaults to disaster.name | string | searchable facetable exact multi common |
disaster.glide |
Global IDEntifier number (GLIDE) of the disaster | string | searchable facetable |
disaster.id |
Id for related disaster used by ReliefWeb | integer | searchable facetable |
disaster.name |
Name assigned to the disaster based on the ReliefWeb disaster naming convention | string | searchable facetable exact |
disaster.status |
Status of the related disaster (e.g. current, past, alert) | string | searchable facetable |
disaster.type |
Disaster type of the associated disaster. Note this may be different to the `disaster_type` of a report. Defaults to disaster.type.name | string | searchable facetable exact multi common |
disaster.type.code |
Code for the disaster type of the associated disaster. | string | searchable facetable |
disaster.type.id |
Id for the disaster type of the associated disaster. | integer | searchable facetable |
disaster.type.name |
Link for values | string | searchable facetable exact |
disaster.type.primary |
Whether this is the primary disaster type for the associated disaster. | boolean | |
disaster_type |
Shortcut for disaster type - defaults to disaster_type.name | string | searchable facetable exact multi common |
disaster_type.code |
GLIDE hazard code for disaster type. | string | searchable facetable |
disaster_type.id |
Id for disaster type used by ReliefWeb | integer | searchable facetable |
disaster_type.name |
Link for values | string | searchable facetable exact |
feature |
defaults to feature.name | string | searchable facetable exact multi common |
feature.id |
Id for feature used by ReliefWeb | integer | searchable facetable |
feature.name |
Link for values. | string | searchable facetable exact |
file |
File attachment shortcut - defaults to file.id | array | multi |
file.description |
Description of file attachment | string | searchable |
file.filehash |
Checksum/hash of the file attachment | string | searchable |
file.filename |
File name of file attachment | string | |
file.filesize |
Size of the file attachment in bytes | integer | searchable sortable facetable |
file.id |
Id of file attachment used by ReliefWeb | integer | searchable |
file.mimetype |
MIME type of file attachment | string | |
file.pagecount |
Number of pages in the file attachment (when applicable) | integer | searchable sortable facetable |
file.preview |
Shortcut for preview image of file attachment - defaults to file.preview.url | array | multi |
file.preview.url |
Link to preview image of file attachment | string | |
file.preview.url-large |
Link to a large preview image with a width of 680px | string | |
file.preview.url-small |
Link to a small preview image with a width of 200px | string | |
file.preview.url-thumb |
Link to a thumbnail preview image with a maximum width of 220px and a maximum height of 100px | string | |
file.url |
Link to file attachment | string | |
file.uuid |
UUID of the file attachment | string | searchable |
format |
Shortcut for content format - defaults to format.name | string | searchable facetable exact multi common |
format.id |
Id of content format used by ReliefWeb | integer | searchable facetable |
format.name |
Link for values | string | searchable facetable exact |
headline |
Shortcut for headline - defaults to headline.title | array | |
headline.image |
Shortcut for headline image - defaults to headline.image.id | array | |
headline.image.caption |
Caption attached to the headline image | string | searchable |
headline.image.copyright |
Copyright attached to the headline image | string | searchable |
headline.image.filename |
File name of the headline image | string | |
headline.image.id |
Unique id of headline image used by ReliefWeb | integer | searchable |
headline.image.mimetype |
MIME type of the headline image | string | |
headline.image.url |
URL of the headline image | string | |
headline.summary |
Summary of body, if report is selected as headline. Typically 180-190 characters long | string | searchable |
headline.title |
Headline text, if report is selected as headline. Typically 100-120 characters long | string | searchable sortable |
id |
Unique id of report used by ReliefWeb | integer | searchable sortable |
image |
Image shortcut - defaults to image.id | integer | |
image.caption |
Caption attached to the image | string | searchable |
image.copyright |
Copyright attached to the image | string | searchable |
image.filename |
File name of the image | string | |
image.id |
Unique id of image used by ReliefWeb | integer | searchable |
image.mimetype |
MIME type of the image | string | |
image.url |
Link to the original image | string | |
image.url-large |
Link to a large image with a width of 680px | string | |
image.url-small |
Link to a small image with a width of 200px | string | |
image.url-thumb |
Link to a thumbnail image with a maximum width of 220px and a maximum height of 100px | string | |
language |
Shortcut for language - defaults to language.name | string | searchable facetable exact multi common |
language.code |
ISO 639-1 code of the language the entry is written in | string | searchable facetable exact |
language.id |
Id for language of report used by ReliefWeb | integer | facetable |
language.name |
Language the report is written in - Link for values. | string | searchable facetable exact |
ocha_product |
Shortcut for OCHA product - defaults to ocha_product.name | string | searchable facetable exact multi common |
ocha_product.id |
Id of OCHA product used by ReliefWeb | integer | searchable facetable |
ocha_product.name |
Link for values | string | searchable facetable exact |
origin |
Url of original report when it was added to ReliefWeb | string | |
primary_country |
Shortcut for primary country - defaults to primary_country.name | string | searchable facetable exact multi common |
primary_country.id |
Id of primary country used by ReliefWeb | integer | searchable sortable facetable |
primary_country.iso3 |
ISO 3166-1 alpha-3 code | string | searchable sortable facetable exact |
primary_country.name |
Link for more information | string | searchable sortable facetable exact |
primary_country.shortname |
Short name of country where applicable, for example 'Syria' for 'Syrian Arab Republic' | string | searchable sortable facetable exact |
redirects |
Previous URL aliases that redirect to this item | string | searchable |
source |
Shortcut for sources - defaults to source.name | string | searchable facetable exact multi common |
source.disclaimer |
Disclaimer information for the source | string | searchable |
source.homepage |
URL of the source's primary website | string | searchable |
source.id |
Id for source used by ReliefWeb | integer | searchable facetable |
source.longname |
Official name of the source if different from source.name | string | searchable facetable exact |
source.name |
Common name of source | string | searchable facetable exact |
source.shortname |
Short name of the source, typically an acronym e.g. UNICEF | string | searchable facetable exact |
source.spanish_name |
Spanish name of the source | string | searchable facetable exact |
source.type |
Shortcut for source type - defaults to source.type.name | array | facetable exact common |
source.type.id |
Id for source type used by ReliefWeb | integer | searchable facetable |
source.type.name |
Link for values | string | searchable facetable exact |
status |
Status | string | searchable facetable |
theme |
Shortcut for theme - defaults to theme.name | string | searchable facetable exact multi common |
theme.id |
Id of theme used by ReliefWeb | integer | searchable facetable |
theme.name |
Link for values | string | searchable facetable exact |
title |
Title of report | string | searchable sortable exact |
url |
Canonical url | string | |
url_alias |
Friendly' url of the report | string | searchable |
uuid |
UUID of the document or term | string | searchable |
vulnerable_groups |
Deprecated. Shortcut for vulnerable groups - defaults to vulnerable_groups.name | string | searchable facetable exact multi common |
vulnerable_groups.id |
Deprecated. Id of vulnerable group used by ReliefWeb | integer | searchable facetable |
vulnerable_groups.name |
Deprecated. Name of vulnerable group | string | searchable facetable exact |