Regional data payload parameters.

The regional data payload parameters allow you to define a query to retrieve specific data from the Datagarden API. While all parameters are optional, default values will be applied if they are not specified.

Refer to the table below for a list of available parameters and their default values.

Parameter

Default Value

Mandatory

Description

region_level

The number of levels below the requested region for which the data should be retrieved.

Model

1st available model in alphabetic order

Model data that is to be retrieved. Should be something like 'demographics' or 'economics'. available models vary by region level.

period_type

Period type for which the data should be retrieved. Possible values are 'Y' (i.e year), 'Q' (i.e quarter), 'M' (i.e month), 'W' (i.e week), 'D' (i.e day).

period_from

2020

Start period for which the data should be retrieved. Format: YYYY-MM-DD.

period_to

Jan 1st of year.

End period for which the data should be retrieved. Format: YYYY-MM-DD.

Region level

The region_level parameter specifies the hierarchical level of subregions for which data is requested, relative to the region defined in the resource URL.

For example:

When querying regional data for a country, region_level refers to the hierarchy within that country (e.g., states or provinces).
For a specific U.S. state, region_level refers to levels within that state’s hierarchy (e.g., counties).

Thus, setting region_level to 4 for the U.S. will return county-level data nationwide, while setting region_level to 1 for New York State will return county-level data exclusively for New York State.

The possible values for region_level vary depending on the type of region:

SubRegion: region_level can range from 0 up to the total number of subregion levels for the specified subregion.
Country: region_level can range from 0 up to the number of subregion levels within the country.
Continent: region_level can be either 0 or 1, where a value of 1 retrieves regional data for each country within the continent.
World: No region_level can be provided.