Skip to navigation

/diseases/outbreaks/filter-options

View as Markdown

Returns distinct filter values for outbreak UIs, aligned with GET /diseases/outbreaks/filter. Pass the same optional query parameters to reflect the current filter context.

With no parameters, a faster path loads options from the full outbreak set. With any filter present, each facet’s options are computed with that facet relaxed.

  • regions — Only when country is set and subdivision-level geography exists; items use region_id and region_name.
  • source_countries overlaps reporting-country options; countries merges reporting and origin country codes (prefer countries for new integrations where noted in release notes).
  • years — outbreak_start_years merges start years with publication years; outbreak_end_years uses end year or start when end is missing.
  • eventType — Maps each row’s type field to event_code / event_name (Outbreak, Cross-border, Sporadic).
  • GET /diseases/outbreaks/regions — pass countryId (reporting country); returns region_code / region (same id as region_id / name as region_name in data.regions here). Optional search prefixes the subdivision name.
  • GET /diseases/outbreaks/settings, GET /diseases/outbreaks/population, GET /diseases/outbreaks/pathogens, and GET /diseases/outbreaks/vehicles return the full setting, population, pathogen, and vehicle catalogs with optional prefix search on labels (same codes as data.settings, data.populations / data.animal_populations, data.pathogens, and data.vehicles here).

Response

data contains settings, populations, vehicles, pathogens, regions, animal_populations, countries, source_countries, origin_countries, diseases, eventType, years. The saved example trims each list to one item (and a few sample years); live responses are much larger.

Authentication

Authorizationstring
API Key authentication via header

Response

OK
dataobject