ReliefWeb API Preset settings

Jump to settings:

  1. Analysis
  2. Latest
  3. Minimal

Introduction

This page lists the settings associated with the 'preset' parameter.

Presets settings default to minimal.

Note: Each query parameter overrides any preset configuration apart from filter, which is joined with AND to any preset conditions and query where each setting is independently overridden.

For example, you can not get expired jobs using preset=latest, because the filter for this would be:

"filter": {
  "operator": "AND",
  "conditions": [
    {
      "field": "status",
      "value": ["published"],
      "operator": "OR"
    },
    {
      "field": "status",
      "value": ["expired"],
    }
  ]
}

and no job can have both statuses at the same time.

The settings

  • Analysis

    • Blog - analysis

      {
        "query": {
          "fields": [
            "title",
            "body"
          ],
          "operator": "OR"
        },
        "filter": {
          "field": "status",
          "value": ["published"],
          "operator": "OR"
        }
      }
      
    • Book - analysis

      {
        "query": {
          "fields": [
            "title",
            "body"
          ],
          "operator": "OR"
        },
        "filter": {
          "field": "status",
          "value": ["published"],
          "operator": "OR"
        }
      }
      
    • Countries - analysis

      {
        "query": {
          "fields": [
            "name",
            "shortname",
            "iso3",
            "status"
          ],
          "operator": "OR"
        },
        "filter": {}
      }
      
    • Disasters - analysis

      {
        "query": {
          "fields": [
            "name",
            "glide",
            "description",
            "type",
            "country",
            "status"
          ],
          "operator": "OR"
        },
        "filter": {
          "field": "status",
          "value": ["alert", "alert-archive", "archive", "current", "past"],
          "operator": "OR"
        }
      }
      
    • Jobs - analysis

      {
        "query": {
          "fields": [
            "title",
            "body",
            "career_categories",
            "country",
            "how_to_apply",
            "source",
            "status",
            "theme"
          ],
          "operator": "OR"
        },
        "filter": {
          "field": "status",
          "value": ["published", "expired"],
          "operator": "OR"
        }
      }
      
    • Reports - analysis

      {
        "query": {
          "fields": [
            "body",
            "country",
            "disaster",
            "disaster_type",
            "format.name",
            "headline.title",
            "headline.summary",
            "language",
            "primary_country",
            "source",
            "status",
            "theme.name",
            "title"
          ],
          "operator": "OR"
        },
        "filter": {
          "field": "status",
          "value": ["published", "to-review"],
          "operator": "OR"
        }
      }
      
    • Sources - analysis

      {
        "query": {
          "fields": [
            "title"
          ]
        },
        "filter": {
          "field": "status",
          "value": ["published"],
          "operator": "OR"
        }
      }
      
    • Training - analysis

      {
        "query": {
          "fields": [
            "body",
            "country",
            "format",
            "source",
            "status",
            "theme",
            "title",
            "type"
          ],
          "operator": "OR"
        },
        "filter": {
          "field": "status",
          "value": ["published", "expired"],
          "operator": "OR"
        }
      }
      
  • Latest

    • Blog - latest

      {
        "query": {
          "fields": [
            "title",
            "body"
          ],
          "operator": "OR"
        },
        "sort": [
          "date.created:desc"
        ],
        "filter": {
          "field": "status",
          "value": ["published"],
          "operator": "OR"
        }
      }
      
    • Book - latest

      {
        "query": {
          "fields": [
            "title",
            "body"
          ],
          "operator": "OR"
        },
        "sort": [
          "date.created:desc"
        ],
        "filter": {
          "field": "status",
          "value": ["published"],
          "operator": "OR"
        }
      }
      
    • Countries - latest

      {
        "query": {
          "fields": [
            "name",
            "shortname",
            "iso3"
          ],
          "operator": "OR"
        },
        "sort": [
          "id:desc"
        ],
        "filter": {}
      }
      
    • Disasters - latest

      {
        "query": {
          "fields": [
            "name",
            "status",
            "glide",
            "description",
            "type",
            "country"
          ],
          "operator": "OR"
        },
        "sort": [
          "date.created:desc"
        ],
        "filter": {
          "field": "status",
          "value": ["alert", "current", "past"],
          "operator": "OR"
        }
      }
      
    • Jobs - latest

      {
        "query": {
          "fields": [
            "title",
            "body",
            "career_categories",
            "country",
            "how_to_apply",
            "source",
            "theme"
          ],
          "operator": "OR"
        },
        "sort": [
          "date.created:desc"
        ],
        "filter": {
          "field": "status",
          "value": ["published"],
          "operator": "OR"
        }
      }
      
    • Reports - latest

      {
        "query": {
          "fields": [
            "body",
            "country",
            "disaster",
            "disaster_type",
            "format.name",
            "headline.title",
            "headline.summary",
            "language",
            "primary_country",
            "source",
            "theme.name",
            "title"
          ],
          "operator": "OR"
        },
        "sort": [
          "date.created:desc"
        ],
        "filter": {
          "field": "status",
          "value": ["published", "to-review"],
          "operator": "OR"
        }
      }
      
    • Sources - latest

      {
        "query": {
          "fields": [
            "name",
            "shortname",
            "longname",
            "spanish_name"
          ],
          "operator": "OR"
        },
        "sort": [
          "id:desc"
        ],
        "filter": {
          "field": "status",
          "value": ["active", "inactive"],
          "operator": "OR"
        }
      }
      
    • Training - latest

      {
        "query": {
          "fields": [
            "body",
            "country",
            "format",
            "source",
            "theme",
            "title",
            "type",
            "how_to_register",
            "career_categories",
            "training_language"
          ],
          "operator": "OR"
        },
        "sort": [
          "date.created:desc"
        ],
        "filter": {
          "field": "status",
          "value": ["published"],
          "operator": "OR"
        }
      }
      
  • Minimal

    • Blog - minimal

      {
        "query": {
          "fields": [
            "include": [
              "title"
            ]
          ]
        },
        "filter": {
          "field": "status",
          "value": ["published"],
          "operator": "OR"
        }
      }
      
    • Book - minimal

      {
        "query": {
          "fields": [
            "include": [
              "title"
            ]
          ]
        },
        "filter": {
          "field": "status",
          "value": ["published"],
          "operator": "OR"
        }
      }
      
    • Countries - minimal

      {
        "query": {
          "fields": [
            "name"
          ]
        },
        "filter": {}
      }
      
    • Disasters - minimal

      {
        "query": {
          "fields": [
            "name"
          ]
        },
        "filter": {
          "field": "status",
          "value": ["alert", "current", "past"],
          "operator": "OR"
        }
      }
      
    • Jobs - minimal

      {
        "query": {
          "fields": [
            "title"
          ]
        },
        "filter": {
          "field": "status",
          "value": ["published"],
          "operator": "OR"
        }
      }
      
    • Reports - minimal

      {
        "query": {
          "fields": [
            "title"
          ]
        },
        "filter": {
          "field": "status",
          "value": ["published", "to-review"],
          "operator": "OR"
        }
      }
      
    • Sources - minimal

      {
        "query": {
          "fields": [
            "name"
          ]
        },
        "filter": {
          "field": "status",
          "value": ["active", "inactive"],
          "operator": "OR"
        }
      }
      
    • Training - minimal

      {
        "query": {
          "fields": [
            "title"
          ]
        },
        "filter": {
          "field": "status",
          "value": ["published"],
          "operator": "OR"
        }
      }