The API Endpoint is here:
https://goadmin.ifrc.org/api/v2/situation_report/
| Variable Code | Data Type | Accept Null Value | Description | Filtering available in API |
|---|---|---|---|---|
| created_at | str | FALSE | Creation date of the report in UTC time. Format: YYYY-MM-DDT00:00:00Z | TRUE |
| document | str | TRUE | URL of the document | FALSE |
| document_url | str | TRUE | URL of the document | FALSE |
| event | int | FALSE | GO related event (emergency) id | TRUE |
| type | dict | TRUE | It is a dictionary storing the data about the type of document along with its type id and whether it is a primary report or not | TRUE |
| id | int | FALSE | FALSE | |
| is_pinned | str | TRUE | FALSE | |
| visibility | int | FALSE | Visibility - Code | FALSE |
| visibility_display | str | FALSE | Visibility - Name | FALSE |
| name | str | FALSE | Name of situation report | TRUE |
created_at: The data stored in the situation report API can be filtered based on the date of creation as follows: https://goadmin.ifrc.org/api/v2/situation_report/?created_at__gte=2022-01-01T00%3A00%3A00. Here %3A is a URL-encoded representation of the colon (:) character.event: In order to filter the data based on Go related event id, use the following URL string: https://goadmin.ifrc.org/api/v2/situation_report/?event=3122. You can filter the table through a general search (besides to the event name field, the search would be done in the name field) e.g.: https://goadmin.ifrc.org/api/v2/situation_report/?search=Earthquake%20Haititype: The data can also be filtered according to the type id of the document. At the moment the following type ids correspond to their respective document types: 1 - ERU reports, 2 - Key Surge Documents, 3- Information Products, 5 - Situation Reports, 6 - Logistic Documents and Mobilization Tables, 7 - Maps and 11 - Resource Mobilization and Communications Products. The data filtering can be done as follows: https://goadmin.ifrc.org/api/v2/situation_report/?type=3. Here we filter the data where the document type is an Information Product. name: You can filter the table through a general search (besides to the name field, the search would be done in the event field) e.g.: https://goadmin.ifrc.org/api/v2/situation_report/?search=ECHO. Using this URL wherever the word ‘ECHO’ is present in the name of the situation report, those reports will be filtered out and displayed.