Reports

Basic Usage

By default, this returns a day-to-day rolling summary (timeseries) of all stats at the national level.

Method URI
GET /reports

Sample Response

{
  "province": "All",
  "data": [
    {
      "date": "2020-03-24",
      "change_cases": 661,
      "change_fatalities": 3,
      "change_tests": 7743,
      "change_hospitalizations": 49,
      "change_criticals": 19,
      "change_recoveries": 74,
      "change_vaccinations": 0,
      "change_vaccinated": 0,
      "change_boosters_1": 0,
      "change_vaccines_distributed": 0,
      "total_cases": 2806,
      "total_fatalities": 27,
      "total_tests": 110989,
      "total_hospitalizations": 146,
      "total_criticals": 70,
      "total_recoveries": 186,
      "total_vaccinations": 0,
      "total_vaccinated": 0,
      "total_boosters_1": 0,
      "total_vaccines_distributed": 0,
    },
    ...
  ]
}

province

When All, report includes data from all provinces and represents a national view.

data

An array of daily reports. Note the prefix for all reporting stats.

  • date — in Y-m-d format
  • change_{stat} — daily change compared to the previous report
  • total_{stat} — the total, cumulative count up to the date (with the exception of hospitalizations and criticals, where it indicates current occupation levels)

Parameters

Parameter Type Description
fill_dates Boolean When true, the response will fill any missing dates in-between with blank entries. Can be useful for some visualizations.
stat String Reports only on the set statistic e.g. recoveries
date Date Reports only on a single date e.g. 2020-01-01
after Date Returns reports on or after the specified date.
before Date Returns reports on or before the specified date. If after is provided, this defaults to today.

Example

reports?stat=tests&fill_dates=true

By Province

Filter the data to the province level by providing a province code e.g. SK. All parameters are supported.

Method URI
GET /reports/province/:code

Example

reports/province/ab

By Health Region

Filter the data to the health region level by providing a Health Region UID (hr_uid) e.g. 3527. All parameters are supported.

Method URI
GET reports/regions/:hr_uid

Example

reports/regions/3527

Hospitalization and Criticals Data

In contrast to other stats which report cumulative and daily change, the hospitalization and criticals data are census data. This means that total_hospitalizations actually indicates the current number of people in hospital with COVID-19. Similarly, total_criticals indicates the current number of people in ICUs with COVID-19.

The change_hospitalizations and change_criticals similarly indicate the change in occupation from one day to the next. For example, an increase of 50 does not mean that 50 individuals were admitted to hospital on a given day; rather it means that the net change in people receiving care in hospital increased by 50.

A final note of importance is that criticals are a subset of hospitalizations, and hospitalizations include those receiving both inpatient and critical care.