Skip to navigation

/diseases/charts/regions

View as Markdown

Returns distinct region options that appear in the GIDEON chart catalog, for building chart filters or autocompletes. Pair with GET /diseases/charts/countries for country pickers scoped the same way.

Each item has id (numeric id for chart filters), source (countryregion or state), and name (label). Use source to decide how to pass the id into GET /diseases/charts: state rows correspond to the states query parameter; countryregion rows correspond to countryregions.

All query parameters are optional; omitting filters returns a larger set (still limited to regions that appear on charts in the catalog).

Query parameters

NameRequiredDescription
countriesNoComma-separated country codes.
diseasesNoComma-separated disease ids.
qNoPrefix filter on the resolved region name.

Authentication

Authorizationstring
API Key authentication via header

Query parameters

countriesstringOptional

Comma-separated GIDEON country codes (see GET /diseases/charts/countries or GET /diseases/fingerprint/countries). Narrows regions to chart metadata that references those countries.

Response

OK
datalist of objects