Skip to navigation

/diseases/outbreaks/filter

View as Markdown

Returns outbreak rows in simple mode by default (return=simple). Each row includes update_date, update_date_epoch (Unix seconds; derived from each row’s update time), geography, counts, and resolved names (vehicle, pathogen, populations, etc.). id is prefixed (o_, t_, sp_) from event type and a stable numeric key.

Year overlap uses the query parameters outbreak_start and outbreak_end (calendar years) with derived span logic on the server.

If the filtered row count exceeds outbreaks_max_records_without_filters (default 500), the API returns HTTP 200 with { "data": { "record_count", "max_records" } } instead of listing rows.

Use GET /diseases/outbreaks/filter-options for facet values. Use GET /diseases/outbreaks/regions (requires countryId) for subdivision pickers; use GET /diseases/outbreaks/settings, GET /diseases/outbreaks/population, GET /diseases/outbreaks/pathogens, and GET /diseases/outbreaks/vehicles for the full setting, population, pathogen, and vehicle catalogs (optional prefix search where noted on each request).

Query parameters (optional; combine as needed)

NameDescription
diseaseNumeric GIDEON disease identifier.
countryGIDEON country code for the reporting country.
originCountryCountry code for the country of origin (imported exposure), when applicable.
typeSubstring match on stored event type (e.g. outbreak, sporadic, travelcase).
outbreak_start / outbreak_endCalendar-year overlap window.
regionSubdivision id (region_code from GET /diseases/outbreaks/regions with the same country as countryId, or filter-options region_id).
settingSetting id (setting_code from GET /diseases/outbreaks/settings or filter-options).
populationHuman population id (population_code from GET /diseases/outbreaks/population with is_human=1, or filter-options data.populations).
animalPopulationAnimal population id (population_code from GET /diseases/outbreaks/population with is_human=0, or filter-options data.animal_populations as animal_population_code).
vehicleVehicle id (vehicle_code from GET /diseases/outbreaks/vehicles or filter-options).
pathogenPathogen id (pathogen_code from GET /diseases/outbreaks/pathogens or filter-options).
humanCases / humanDeaths / animalCases / animalDeathsNumeric filters (same operator rules as similar endpoints).
returnsimple (default) or detailed (paginated, extra fields).

Success with rows (simple)

{ "data": [ ... ] } — the Postman example shows one row for brevity (from api-dev; values change).

Authentication

Authorizationstring
API Key authentication via header

Query parameters

diseaseintegerOptional
Numeric GIDEON disease identifier.
countrystringOptional
GIDEON country code for the reporting country.

Response

OK
datalist of objects