The API endpoint is the following:
https://goadmin.ifrc.org/api/v2/ops-learning/
Variable code | Data Type | Accept Null Value | Description | Filtering available in API |
---|---|---|---|---|
id | int | False | Unique identifier of the learning provided by GO | True |
learning | str | False | Operational learning extracted from operational final reports | False |
learning_validated | str | True | Operational learning with human validation | True |
appeal_document_id | int | True | Unique identifier of the appeal document in GO, from which the learning was extracted | True |
type | int | False | Type of learning. 1: Lesson Learned, 2: Challenge | False |
type_validated | int | False | Type of learning validated. 1: Lesson Learned, 2: Challenge. This variable doesn't accept null values, so it has the same value as type by default. | True |
is_validated | bool | False | Verify if learning, type, organization, sector, and per component of learning are validated. | True |
modified_at | str | False | Modification date of entry in UTC time. Format: YYYY-MM_DDT00:00:00Z. This variable doesn't accept null values, so it has the same value as created_at by default. | True |
created_at | str | False | Creation date of entry in UTC time. Format: YYYY-MM_DDT00:00:00Z | False |
organization | list | True | A list of integers that denotes the organizations to which the extracted learning applies. The values within the list correspond to specific organizations. 1: Secretariat, 2: National Society | False |
organization_validated | list | True | A list of integers that denotes the organizations to which the extracted learning applies validated. The values within the list correspond to specific organizations. 1: Secretariat, 2: National Society | True |
sector | list | True | A list of integers that denotes the sector related to the extracted learning. The values within the list correspond to specific sectors (i.e., 0: WASH, 1: PGI, 2: CEA, 3: Migration, 4: Health (public), 5: DRR, 6: Shelter, 7: NS Strengthening 8: Education, 9: Livelihoods and basic needs, 10: Recovery, 11: Internal displacement, 12: Health (clinical), 13: COVID-19) | False |
sector_validated | list | True | A list of integers that denotes the sector related to the extracted learning validated. The values within the list correspond to specific sectors (i.e., 0: WASH, 1: PGI, 2: CEA, 3: Migration, 4: Health (public), 5: DRR, 6: Shelter, 7: NS Strengthening 8: Education, 9: Livelihoods and basic needs, 10: Recovery, 11: Internal displacement, 12: Health (clinical), 13: COVID-19) | True |
per_component | list | True | A list of integers that denotes the per component related to the extracted learning. The values within the list correspond to specific per components (e.g., 1: RC auxiliary role, Mandate and Law, 2: DRM Strategy, 3: DRM Policy,.., 52: Fleet and Transportation Management) | False |
per_component_validated | list | True | A list of integers that denotes the per component related to the extracted learning validated. The values within the list correspond to specific per components (e.g., 1: RC auxiliary role, Mandate and Law, 2: DRM Strategy, 3: DRM Policy,.., 52: Fleet and Transportation Management) | True |
appeal | dict | False | A dictionary including information of the appeal of which the learning is coming from. Some variables of the dictionary are: name of event, appeal code, number of beneficiaries, start date, disaster type, country, region. | True |
id
: Need to provide the GO operational learning ID e.g.: https://goadmin.ifrc.org/api/v2/ops-learning/?id=3283
It is as well, possible to search for a list of learnings IDs, e.g,: https://goadmin.ifrc.org/api/v2/ops-learning/?id__in=3283,3284,3285
learning_validated
: You can filter the table through a general search (besides the learning_validated field, the search would be done in the event name field and in the code field) e.g.: https://goadmin.ifrc.org/api/v2/ops-learning/?search=tents
appeal_document_id
: Need to provide the GO ID for the appeal document containing the learning e.g.:https://goadmin.ifrc.org/api/v2/ops-learning/?appeal_document_id=5366
type_validated
: Need to provide the ID of the type of learning of your interest e.g. for Challenges: https://goadmin.ifrc.org/api/v2/ops-learning/?type_validated=2
is_validated
: If you are only interested in the results that are validated https://goadmin.ifrc.org/api/v2/ops-learning/?is_validated=true
. By default, these are the results that are displayed for users without admin authentication.modified_at
: Need to provide the modified date in specified format e.g.: https://goadmin.ifrc.org/api/v2/ops-learning/?modified_at__gte=2024-01-22T13:00:00
This will search the learnings that were modified on a date greater or equal to 22 of January of 2024 at 13h UCT.organization_validated
: Need to provide the ID of the organization of your interest e.g. for Secretariat: e.g.: https://goadmin.ifrc.org/api/v2/ops-learning/?organization_validated=1
sector_validated
: Need to provide the ID of the sector of your interest e.g. for Migration: https://goadmin.ifrc.org/api/v2/ops-learning/?sector_validated=3
. The relation between sector's 'name' and 'id' is: 0: WASH, 1: PGI, 2: CEA, 3: Migration, 4: Health (public), 5: DRR, 6: Shelter, 7: NS Strengthening 8: Education, 9: Livelihoods and basic needs, 10: Recovery, 11: Internal displacement, 12: Health (clinical), 13: COVID-19. It is as well, possible to search for a list of sector IDs, e.g,: https://goadmin.ifrc.org/api/v2/ops-learning/?sector_validated__in=5,7
per_component_validated
: Need to provide the ID of the per component of your interest e.g. for Information Management: https://goadmin.ifrc.org/api/v2/ops-learning/?per_component_validated=35
. The relation between per component's 'name' and 'id' can be found here: https://goadmin.ifrc.org/api/v2/per-formcomponent/
It is as well, possible to search for a list of per component IDs, e.g,: https://goadmin.ifrc.org/api/v2/ops-learning/?per_component_validated__in=35,47,32,34
appeal_code
: Need to provide the MDR Code of the operation you are interested in, e.g. https://goadmin.ifrc.org/api/v2/ops-learning/?appeal_code=MDREC018
It is as well, possible to search for a list of appeal codes, e.g,: https://goadmin.ifrc.org/api/v2/ops-learning/?appeal_code__in=MDRBF015,MDRBF014
appeal_code__num_beneficiaries
: If you want to filter the operations by their relative size, you can filter by providing a threshold of the reported number of beneficiaries e.g.: https://goadmin.ifrc.org/api/v2/ops-learning/?appeal_code__num_beneficiaries__gte=5000
appeal_code__start_date
: If you want to filter the operations by their start date, you can filter by providing a threshold for the date e.g.: https://goadmin.ifrc.org/api/v2/ops-learning/?appeal_code__start_date__gte=2022-12-23T00:00:00
This will search the operations that started on a date greater or equal to 23 of December of 2022. You can also use: https://goadmin.ifrc.org/api/v2/ops-learning/?appeal_code__start_date__lte=2022-12-23T00:00:00
if you are interested in getting the operations that started on a date less or equal to 23 of December of 2022.appeal_code__dtype
: Need to provide the GO ID of the disaster type of your interest e.g. for Drought: https://goadmin.ifrc.org/api/v2/ops-learning/?appeal_code__dtype=20
. The relation between disaster type's 'name' and 'id' can be found here: https://goadmin.ifrc.org/api/v2/disaster_type/
It is as well, possible to search for a list of disaster types, e.g,: https://goadmin.ifrc.org/api/v2/ops-learning/?appeal_code__dtype__in=12,27
appeal_code__country
: Need to provide the GO ID of the country of your interest e.g. for Colombia: https://goadmin.ifrc.org/api/v2/ops-learning/?appeal_code__country=48
. The relation between country's 'name' and 'id' can be found here: https://goadmin.ifrc.org/api/v2/country/
It is as well, possible to search for a list of countries, e.g,: https://goadmin.ifrc.org/api/v2/ops-learning/?appeal_code__country__in=48,8,35
and to search with the ISO3 of the country https://goadmin.ifrc.org/api/v2/ops-learning/?appeal_code__country__iso3=COL
appeal_code__region
: Need to provide the GO ID of the region of your interest e.g. for Asia Pacific: https://goadmin.ifrc.org/api/v2/ops-learning/?appeal_code__region=2
. The relation between region's 'name' and 'id' can be found here: https://goadmin.ifrc.org/api/v2/region/