/diseases/case-series/filter

View as Markdown
Returns **case series** rows matching optional filters. Results are ordered by the greater of start year and publication year (newest first). Successful responses include **`record_count`** and **`timestamp`** (Unix epoch seconds from the most recent row update in the filtered set). If the filter matches **more than** the server cap (default **500**, `case_series_max_records_without_filters`), the API returns **HTTP 200** with `{ "data": { "record_count", "max_records" } }` instead of listing rows—tighten filters and call again. #### **Query parameters** (all optional; **camelCase**) | Name | Description | | --- | --- | | `disease` | Numeric GIDEON disease identifier. | | `country` | GIDEON country code for the reporting country. | | `startYear` / `endYear` | **Overlap** window: with both set, a series must overlap that calendar range; with only `startYear`, the series’ effective end year must be ≥ `startYear`; with only `endYear`, its start year must be ≤ `endYear`. If no explicit end year exists for a series, its start year is used as the end for overlap checks. | | `publicationYear` | Exact match on publication year. | | `setting` | Setting id. | | `population` | Population group id. | | `parameter` | Case parameter id. | | `region` | Region id for subdivision filtering. | #### **Success with rows** `{ "data": [ ... ], "record_count": <n>, "timestamp": <unix_epoch_seconds> }` — normalized **lowercase** keys (e.g. `id` with `c_` prefix, `start_year`, `refs`, `region_name`). `timestamp` is a Unix epoch integer (seconds), not an ISO-8601 string. The Postman example shows **one** `data` row for brevity; `record_count` is still the full filtered total. #### **Too many matches** `{ "data": { "record_count", "max_records" } }` with **200**. #### **Errors** - **500** — Invalid request (generic error body).

Authentication

Authorizationstring
API Key authentication via header

Query parameters

diseaseintegerOptional
Numeric GIDEON disease identifier.
countrystringOptional
GIDEON country code.

Response

OK
datalist of objects
timestampinteger
record_countinteger