Skip to main content
GET
/
v2
/
hed-outbreaks
/
outbreaks
Get Outbreaks V2
curl --request GET \
  --url https://api.example.com/v2/hed-outbreaks/outbreaks \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "event": "<unknown>",
      "event_guid": "<unknown>",
      "disease": "<unknown>",
      "syndrome": "<unknown>",
      "pathogen": "<unknown>",
      "date_occurred_low_end": "<unknown>",
      "date_occurred_high_end": "<unknown>",
      "date_reported": "<unknown>",
      "date_type": "<unknown>",
      "country": "<unknown>",
      "cc": "<unknown>",
      "latitude": "<unknown>",
      "longitude": "<unknown>",
      "location_granularity": "<unknown>",
      "location_type": "<unknown>",
      "cases": "<unknown>",
      "suspected_cases": "<unknown>",
      "probable_cases": "<unknown>",
      "confirmed_cases": "<unknown>",
      "deaths": "<unknown>",
      "suspected_deaths": "<unknown>",
      "probable_deaths": "<unknown>",
      "confirmed_deaths": "<unknown>",
      "cuml_cases": "<unknown>",
      "cuml_suspected_cases": "<unknown>",
      "cuml_prob_cases": "<unknown>",
      "cuml_confirmed_cases": "<unknown>",
      "cuml_deaths": "<unknown>",
      "cuml_suspected_deaths": "<unknown>",
      "cuml_probable_deaths": "<unknown>",
      "cuml_confirmed_deaths": "<unknown>",
      "derive_delta_cases": "<unknown>",
      "derive_delta_susp_cases": "<unknown>",
      "derive_delta_prob_cases": "<unknown>",
      "derive_delta_conf_cases": "<unknown>",
      "derive_delta_deaths": "<unknown>",
      "derive_delta_susp_deaths": "<unknown>",
      "derive_delta_prob_deaths": "<unknown>",
      "derive_delta_conf_deaths": "<unknown>",
      "source": "<unknown>",
      "source_url": "<unknown>",
      "is_default_source": "<unknown>",
      "output_version": "<unknown>",
      "created_at": "<unknown>",
      "updated_at": "<unknown>",
      "pathogen_detail": "<unknown>",
      "pathogen_detail_2": "<unknown>",
      "administrative_area_level_1": "<unknown>",
      "administrative_area_level_2": "<unknown>",
      "locality": "<unknown>"
    }
  ],
  "has_more": true,
  "next_page": "<string>"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

​
page
string | null

A cursor for pagination across multiple pages of results. Don't include this parameter on the first call. Use the next_page value returned in a previous response to request subsequent results.

​
num
integer
default:100

Maximum number of records will be returned by the API call. The maximum acceptable value is 1000

​
pathogen
string | null

If not empty, only the records with this pathogen will be return.

​
event
string | null

If not empty, only the records with this event will be returned.

​
source
string | null

If not empty, only the records with this source will be returned.

​
countrycode
string | null

If not empty, only the records with this country code will be returned.

Required string length: 2
​
dateoccurredhighmin
string<date> | null

It is the min value of the data range higher end. Date format (yyyy-mm-dd)

​
dateoccurredhighmax
string<date> | null

It is the max value of the data higher range. Date format (yyyy-mm-dd)

​
updated_at_min
string<date-time> | null

Filter to return events with an updated_date greater than this timestamp. Timestamp format (yyyy-mm-ddTHH:MM:SSZ) in UTC

Response

Successful Response

​
data
Outbreak · object[]
required
​
has_more
boolean
required
​
next_page
string | null