Get Outbreaks

Get Outbreaks

curl --request GET \
  --url https://api.example.com/v1/hed-outbreaks/outbreaks \
  --header 'Authorization: Bearer <token>'

[
  {
    "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>",
    "pathogen_detail": "<unknown>",
    "pathogen_detail_2": "<unknown>",
    "administrative_area_level_1": "<unknown>",
    "administrative_area_level_2": "<unknown>",
    "locality": "<unknown>"
  }
]

GET

hed-outbreaks

outbreaks

Get Outbreaks

curl --request GET \
  --url https://api.example.com/v1/hed-outbreaks/outbreaks \
  --header 'Authorization: Bearer <token>'

[
  {
    "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>",
    "pathogen_detail": "<unknown>",
    "pathogen_detail_2": "<unknown>",
    "administrative_area_level_1": "<unknown>",
    "administrative_area_level_2": "<unknown>",
    "locality": "<unknown>"
  }
]

Authorizations

Authorization

string

header

required

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

Query Parameters

offset

integer

default:0

It is used for offset-based pagination, usually works together with num parameter.

num

integer

default:100

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

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)

sortby

enum<string>

If not empty, the records will be sorted in ascending order of this soryby value. The acceptable sort by values are event, event_id, disease, syndrome, pathogen, pathogen_detail, pathogen_detail_2, date_occurred_low_end, date_occurred_high_end, date_reported, date_type, country, cc, latitude, longitude, administrative_area_level_1, administrative_area_level_2, locality, location_granularity, location_type, cases, confirmed_cases, suspected_cases, probable_cases, deaths, confirmed_deaths, suspected_deaths, probable_deaths, cuml_cases, cuml_confirmed_cases, cuml_suspected_cases, cuml_prob_cases, cuml_deaths, cuml_confirmed_deaths, cuml_suspected_deaths, cuml_probable_deaths, source and is_primary_source

Available options:

administrative_area_level_1,

administrative_area_level_2,

cases,

cc,

confirmed_cases,

confirmed_deaths,

confirmed_cases,

cuml_cases,

cuml_confirmed_cases,

cuml_confirmed_deaths,

cuml_deaths,

cuml_prob_cases,

cuml_probable_deaths,

cuml_suspected_cases,

cuml_suspected_deaths,

date_occurred_high_end,

date_occurred_low_end,

date_reported,

date_type,

death,

deaths,

disease,

event,

event_id,

is_primary_source,

latitude,

locality,

location_granularity,

location_type,

longitude,

pathogen,

pathogen_detail,

pathogen_detail_2,

probable_cases,

probable_deaths,

source,

suspected_cases,

suspected_deaths,

syndrome

order

enum<string>

If not empty, the records will be sorted in ascending order. The acceptable order values are asc and desc

Available options:

asc,

desc

Response

Successful Response

event

any

required

event_guid

any

required

disease

any

required

syndrome

any

required

pathogen

any

required

date_occurred_low_end

any

required

date_occurred_high_end

any

required

date_reported

any

required

date_type

any

required

country

any

required

any

required

latitude

any

required

longitude

any

required

location_granularity

any

required

location_type

any

required

cases

any

required

suspected_cases

any

required

probable_cases

any

required

confirmed_cases

any

required

deaths

any

required

suspected_deaths

any

required

probable_deaths

any

required

confirmed_deaths

any

required

cuml_cases

any

required

cuml_suspected_cases

any

required

cuml_prob_cases

any

required

cuml_confirmed_cases

any

required

cuml_deaths

any

required

cuml_suspected_deaths

any

required

cuml_probable_deaths

any

required

cuml_confirmed_deaths

any

required

derive_delta_cases

any

required

derive_delta_susp_cases

any

required

derive_delta_prob_cases

any

required

derive_delta_conf_cases

any

required

derive_delta_deaths

any

required

derive_delta_susp_deaths

any

required

derive_delta_prob_deaths

any

required

derive_delta_conf_deaths

any

required

source

any

required

source_url

any

required

is_default_source

any

required

output_version

any

required

pathogen_detail

any

pathogen_detail_2

any

administrative_area_level_1

any

administrative_area_level_2

any

locality

any

Get Event Sources Get Events

⌘I

API Reference

Endpoints

Authorizations

Query Parameters

Response