Airly (Independent Publisher)
Airly provides accurate, hyper-local data about air pollution in your community. This is the first step towards understanding the health risks and making improvements.
This connector is available in the following products and regions:
| Service | Class | Regions |
|---|---|---|
| Logic Apps | Standard | All Logic Apps regions except the following: - Azure Government regions - Azure China regions - US Department of Defense (DoD) |
| Power Automate | Premium | All Power Automate regions except the following: - US Government (GCC) - US Government (GCC High) - China Cloud operated by 21Vianet - US Department of Defense (DoD) |
| Power Apps | Premium | All Power Apps regions except the following: - US Government (GCC) - US Government (GCC High) - China Cloud operated by 21Vianet - US Department of Defense (DoD) |
| Contact | |
|---|---|
| Name | Tomasz Poszytek |
| URL | https://aka.ms/poszytek |
| tomasz@poszytek.eu |
| Connector Metadata | |
|---|---|
| Publisher | Tomasz Poszytek |
| Website | https://airly.org/ |
| Privacy policy | https://airly.org/en/terms-conditions/ |
| Categories | Internet of Things;Lifestyle and Entertainment |
Creating a connection
The connector supports the following authentication types:
| Default | Parameters for creating connection. | All regions | Not shareable |
Default
Applicable: All regions
Parameters for creating connection.
This is not shareable connection. If the power app is shared with another user, another user will be prompted to create new connection explicitly.
| Name | Type | Description | Required |
|---|---|---|---|
| API Key | securestring | The API Key for this api | True |
Throttling Limits
| Name | Calls | Renewal Period |
|---|---|---|
| API calls per connection | 100 | 60 seconds |
Actions
| Get available indexes |
Endpoint returns a list of all the index types supported in the API along with lists of levels defined per each index type. |
| Get available measurements |
Endpoint returns list of all the measurement types supported in the API along with their names and units. |
| Get installation by ID |
Operation returns single installation metadata, given by InstallationId. |
| Get measurements for a point |
Endpoint returns measurements for any geographical location. Measurement values are interpolated by averaging measurements from nearby sensors (up to 1,5km away from the given point). The returned value is a weighted average, with the weight inversely proportional to the distance from the sensor to the given point. |
| Get measurements for installation |
Endpoint returns measurements for concrete installation given by InstallationId. |
| Get nearest installations |
Endpoint returns list of installations which are closest to a given point, sorted by distance to that point. |
| Get nearest measurements |
Endpoint returns measurements for an installation closest to a given location. |
Get available indexes
Endpoint returns a list of all the index types supported in the API along with lists of levels defined per each index type.
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
|
array of object | ||
|
Index name
|
name | string |
Name of the index. |
|
levels
|
levels | array of object |
List of available indexes levels. |
|
Minimum value
|
levels.minValue | float |
Minimum value the index can return for the given level. |
|
Maximum value
|
levels.maxValue | float |
Maximum value the index can return for the given level. |
|
Values
|
levels.values | string |
Values the index can return for the given level. |
|
Level name
|
levels.level | string | |
|
Level description
|
levels.description | string | |
|
Color
|
levels.color | string |
Color representing index level in a form of hexadecimal RGB triplet (e.g. #D1CF1E). |
Get available measurements
Endpoint returns list of all the measurement types supported in the API along with their names and units.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Language
|
Accept-Language | string |
Language in which text descriptions should be returned. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
|
array of object | ||
|
Name
|
name | string |
Name of this measurement type, e.g. PM10. |
|
Label
|
label | string |
Descriptive name of this measurement type (field translated). |
|
Unit
|
unit | string |
Unit of this measurement type e.g. µg/m3. |
Get installation by ID
Operation returns single installation metadata, given by InstallationId.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Installation ID
|
InstallationID | True | integer |
Id of the single installation to get metadata. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
|
array of object | ||
|
Id
|
id | integer |
Unique installation identifier. Having InstallationId you can query measurements from particular installation. |
|
Latitude
|
location.latitude | float |
Installation coordinates - latitude. Exact sensor location on map. |
|
Longitude
|
location.longitude | float |
Installation coordinates - longitude. Exact sensor location on map. |
|
Location Id
|
locationId | integer |
Unique location identifier. |
|
Country
|
address.country | string |
Installation country. Attribute is optional, may be empty or null. |
|
City
|
address.city | string |
Installation city. Attribute is optional, may be empty or null. |
|
Street
|
address.street | string |
Installation street. Attribute is optional, may be empty or null. |
|
Number
|
address.number | string |
Installation street number. Attribute is optional, may be empty or null. |
|
Display address 1
|
address.displayAddress1 | string |
Extra field describing address, e.g. school name or number. Optional field. |
|
Display address 2
|
address.displayAddress2 | string |
Extra field describing address, e.g. school name or number. Optional field. |
|
Elevation
|
elevation | float |
Altitude at which device is installed; meters above mean sea level (mamsl). |
|
Airly
|
airly | boolean |
Flag indicating whether this installation is an Airly device or not; e.g. GIOŚ stations are flagged as false. |
|
Id
|
sponsor.id | integer |
Sponsor identifier. |
|
Name
|
sponsor.name | string |
Name of this installation's sponsor. |
|
Description
|
sponsor.description | string |
Additional description of this installation's sponsor. |
|
Logo
|
sponsor.logo | string |
Url pointing to sponsor's logo (jpg image). |
|
Link
|
sponsor.link | string |
Url pointing to sponsor's website. |
Get measurements for a point
Endpoint returns measurements for any geographical location. Measurement values are interpolated by averaging measurements from nearby sensors (up to 1,5km away from the given point). The returned value is a weighted average, with the weight inversely proportional to the distance from the sensor to the given point.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Latitude
|
lat | True | number |
Latitude as decimal degree, e.g. 50.062006. |
|
Longitude
|
lng | True | number |
Longitude as decimal degree, e.g. 19.940984. |
|
Index type
|
indexType | string |
Selects the type of the index which should be calculated and returned in response. |
|
|
Language
|
Accept-Language | string |
Language in which text descriptions should be returned. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
From DateTime - current
|
current.fromDateTime | string |
ISO8601 timestamp. Date and time in UTC. The field represent start time from which the data in this payload was measured and averaged. |
|
Till DateTime - current
|
current.tillDateTime | string |
ISO8601 timestamp. Date and time in UTC. The field represent end time to which the data in this payload was measured and averaged. |
|
values
|
current.values | array of object |
Values - current. |
|
Measurement name - current
|
current.values.name | string |
Name (type) of the given measurement; e.g. PM10. |
|
Measurement value - current
|
current.values.value | float |
Measured value of the given measurement type, e.g. concentration 25µg/m3. |
|
indexes
|
current.indexes | array of object |
Indexes - current. |
|
Index name - current
|
current.indexes.name | string |
Name of the index (e.g. CAQI, or PIJP). |
|
Index value - current
|
current.indexes.value | float |
Numerical value of the calculated index. |
|
Level - current
|
current.indexes.level | string |
Discreet level of the index (e.g. HIGH, or LOW etc.). |
|
Description - current
|
current.indexes.description | string |
Description of the index level. The text translated and returned in a language according to Accept-Language request header. |
|
Advice - current
|
current.indexes.advice | string |
Additional text with advice regarding current index level. The text translated and returned in a language according to Accept-Language request header. |
|
Color - current
|
current.indexes.color | string |
Color representing index level in a form of hexadecimal RGB triplet (e.g. #D1CF1E). |
|
standards
|
current.standards | array of object |
Standards - current. |
|
Standard name - current
|
current.standards.name | string |
Name of this standard. Currently only WHO standards are supported. |
|
Pollutant - current
|
current.standards.pollutant | string |
Name of the pollutant to which this standard applies, currently only PM10 and PM25 are supported. |
|
Limit - current
|
current.standards.limit | float |
Certain average concentration level of the pollutant which should not be exceeded over given period of time; in other words, this is the value for which the pollutant concentration reaches 100% of the limit. |
|
Percent - current
|
current.standards.percent | float |
Concentration value of a given pollutant expressed as a percentage of this concentration in the standard / limit, e.g. for a standard of 50μg/m3 of PM10 the concentration of 25μg/m3 is expressed as 50%. |
|
Averaging - current
|
current.standards.averaging | string |
Measurement values are interpolated by averaging measurements from nearby sensors (up to 1,5km away from the given point). |
|
history
|
history | array of object |
Historical entries. |
|
From DateTime - history
|
history.fromDateTime | string |
ISO8601 timestamp. Date and time in UTC. The field represent start time from which the data in this payload was measured and averaged. |
|
Till DateTime - history
|
history.tillDateTime | string |
ISO8601 timestamp. Date and time in UTC. The field represent end time to which the data in this payload was measured and averaged. |
|
values
|
history.values | array of object |
Values - history. |
|
Measurement name - history
|
history.values.name | string |
Name (type) of the given measurement; e.g. PM10. |
|
Measurement value - history
|
history.values.value | float |
Measured value of the given measurement type, e.g. concentration 25µg/m3. |
|
indexes
|
history.indexes | array of object |
Indexes - history. |
|
Standard name - history
|
history.indexes.name | string |
Name of this standard. Currently only WHO standards are supported. |
|
Pollutant - history
|
history.indexes.pollutant | string |
Name of the pollutant to which this standard applies, currently only PM10 and PM25 are supported. |
|
Limit - history
|
history.indexes.limit | float |
Certain average concentration level of the pollutant which should not be exceeded over given period of time; in other words, this is the value for which the pollutant concentration reaches 100% of the limit. |
|
Percent - history
|
history.indexes.percent | float |
Concentration value of a given pollutant expressed as a percentage of this concentration in the standard / limit, e.g. for a standard of 50μg/m3 of PM10 the concentration of 25μg/m3 is expressed as 50%. |
|
Averaging - history
|
history.indexes.averaging | string |
Measurement values are interpolated by averaging measurements from nearby sensors (up to 1,5km away from the given point). |
|
standards
|
history.standards | array of object |
Standards - history. |
|
Standard name - history
|
history.standards.name | string |
Name of this standard. Currently only WHO standards are supported. |
|
Pollutant - history
|
history.standards.pollutant | string |
Name of the pollutant to which this standard applies, currently only PM10 and PM25 are supported. |
|
Limit - history
|
history.standards.limit | float |
Certain average concentration level of the pollutant which should not be exceeded over given period of time; in other words, this is the value for which the pollutant concentration reaches 100% of the limit. |
|
Percent - history
|
history.standards.percent | float |
Concentration value of a given pollutant expressed as a percentage of this concentration in the standard / limit, e.g. for a standard of 50μg/m3 of PM10 the concentration of 25μg/m3 is expressed as 50%. |
|
Averaging - history
|
history.standards.averaging | string |
Measurement values are interpolated by averaging measurements from nearby sensors (up to 1,5km away from the given point). |
|
forecast
|
forecast | array of object |
Forecast entries. |
|
From DateTime - forecast
|
forecast.fromDateTime | string |
ISO8601 timestamp. Date and time in UTC. The field represent start time from which the data in this payload was measured and averaged. |
|
Till DateTime - forecast
|
forecast.tillDateTime | string |
ISO8601 timestamp. Date and time in UTC. The field represent end time to which the data in this payload was measured and averaged. |
|
values
|
forecast.values | array of object |
Values - forecast. |
|
Measurement name - forecast
|
forecast.values.name | string |
Name (type) of the given measurement; e.g. PM10. |
|
Measurement value - forecast
|
forecast.values.value | float |
Measured value of the given measurement type, e.g. concentration 25µg/m3. |
|
indexes
|
forecast.indexes | array of object |
Indexes - forecast. |
|
Standard name - forecast
|
forecast.indexes.name | string |
Name of this standard. Currently only WHO standards are supported. |
|
Pollutant - forecast
|
forecast.indexes.pollutant | string |
Name of the pollutant to which this standard applies, currently only PM10 and PM25 are supported. |
|
Limit - forecast
|
forecast.indexes.limit | float |
Certain average concentration level of the pollutant which should not be exceeded over given period of time; in other words, this is the value for which the pollutant concentration reaches 100% of the limit. |
|
Percent - forecast
|
forecast.indexes.percent | float |
Concentration value of a given pollutant expressed as a percentage of this concentration in the standard / limit, e.g. for a standard of 50μg/m3 of PM10 the concentration of 25μg/m3 is expressed as 50%. |
|
Averaging - forecast
|
forecast.indexes.averaging | string |
Measurement values are interpolated by averaging measurements from nearby sensors (up to 1,5km away from the given point). |
|
standards
|
forecast.standards | array of object |
Standards - forecast. |
|
Standard name - forecast
|
forecast.standards.name | string |
Name of this standard. Currently only WHO standards are supported. |
|
Pollutant - forecast
|
forecast.standards.pollutant | string |
Name of the pollutant to which this standard applies, currently only PM10 and PM25 are supported. |
|
Limit - forecast
|
forecast.standards.limit | float |
Certain average concentration level of the pollutant which should not be exceeded over given period of time; in other words, this is the value for which the pollutant concentration reaches 100% of the limit. |
|
Percent - forecast
|
forecast.standards.percent | float |
Concentration value of a given pollutant expressed as a percentage of this concentration in the standard / limit, e.g. for a standard of 50μg/m3 of PM10 the concentration of 25μg/m3 is expressed as 50%. |
|
Averaging - forecast
|
forecast.standards.averaging | string |
Measurement values are interpolated by averaging measurements from nearby sensors (up to 1,5km away from the given point). |
Get measurements for installation
Endpoint returns measurements for concrete installation given by InstallationId.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Installation ID
|
installationId | True | integer |
Installation identifier for which measurements are returned. |
|
Language
|
Accept-Language | string |
Language in which text descriptions should be returned. |
|
|
Index type
|
indexType | string |
Selects the type of the index which should be calculated and returned in response. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
From DateTime - current
|
current.fromDateTime | string |
ISO8601 timestamp. Date and time in UTC. The field represent start time from which the data in this payload was measured and averaged. |
|
Till DateTime - current
|
current.tillDateTime | string |
ISO8601 timestamp. Date and time in UTC. The field represent end time to which the data in this payload was measured and averaged. |
|
values
|
current.values | array of object |
Values - current. |
|
Measurement name - current
|
current.values.name | string |
Name (type) of the given measurement; e.g. PM10. |
|
Measurement value - current
|
current.values.value | float |
Measured value of the given measurement type, e.g. concentration 25µg/m3. |
|
indexes
|
current.indexes | array of object |
Indexes - current. |
|
Index name - current
|
current.indexes.name | string |
Name of the index (e.g. CAQI, or PIJP). |
|
Index value - current
|
current.indexes.value | float |
Numerical value of the calculated index. |
|
Level - current
|
current.indexes.level | string |
Discreet level of the index (e.g. HIGH, or LOW etc.). |
|
Description - current
|
current.indexes.description | string |
Description of the index level. The text translated and returned in a language according to Accept-Language request header. |
|
Advice - current
|
current.indexes.advice | string |
Additional text with advice regarding current index level. The text translated and returned in a language according to Accept-Language request header. |
|
Color - current
|
current.indexes.color | string |
Color representing index level in a form of hexadecimal RGB triplet (e.g. #D1CF1E). |
|
standards
|
current.standards | array of object |
Standards - current. |
|
Standard name - current
|
current.standards.name | string |
Name of this standard. Currently only WHO standards are supported. |
|
Pollutant - current
|
current.standards.pollutant | string |
Name of the pollutant to which this standard applies, currently only PM10 and PM25 are supported. |
|
Limit - current
|
current.standards.limit | float |
Certain average concentration level of the pollutant which should not be exceeded over given period of time; in other words, this is the value for which the pollutant concentration reaches 100% of the limit. |
|
Percent - current
|
current.standards.percent | float |
Concentration value of a given pollutant expressed as a percentage of this concentration in the standard / limit, e.g. for a standard of 50μg/m3 of PM10 the concentration of 25μg/m3 is expressed as 50%. |
|
Averaging - current
|
current.standards.averaging | string |
Measurement values are interpolated by averaging measurements from nearby sensors (up to 1,5km away from the given point). |
|
history
|
history | array of object |
Historical entries. |
|
From DateTime - history
|
history.fromDateTime | string |
ISO8601 timestamp. Date and time in UTC. The field represent start time from which the data in this payload was measured and averaged. |
|
Till DateTime - history
|
history.tillDateTime | string |
ISO8601 timestamp. Date and time in UTC. The field represent end time to which the data in this payload was measured and averaged. |
|
values
|
history.values | array of object |
Values - history. |
|
Measurement name - history
|
history.values.name | string |
Name (type) of the given measurement; e.g. PM10. |
|
Measurement value - history
|
history.values.value | float |
Measured value of the given measurement type, e.g. concentration 25µg/m3. |
|
indexes
|
history.indexes | array of object |
Indexes - history. |
|
Standard name - history
|
history.indexes.name | string |
Name of this standard. Currently only WHO standards are supported. |
|
Pollutant - history
|
history.indexes.pollutant | string |
Name of the pollutant to which this standard applies, currently only PM10 and PM25 are supported. |
|
Limit - history
|
history.indexes.limit | float |
Certain average concentration level of the pollutant which should not be exceeded over given period of time; in other words, this is the value for which the pollutant concentration reaches 100% of the limit. |
|
Percent - history
|
history.indexes.percent | float |
Concentration value of a given pollutant expressed as a percentage of this concentration in the standard / limit, e.g. for a standard of 50μg/m3 of PM10 the concentration of 25μg/m3 is expressed as 50%. |
|
Averaging - history
|
history.indexes.averaging | string |
Measurement values are interpolated by averaging measurements from nearby sensors (up to 1,5km away from the given point). |
|
standards
|
history.standards | array of object |
Standards - history. |
|
Standard name - history
|
history.standards.name | string |
Name of this standard. Currently only WHO standards are supported. |
|
Pollutant - history
|
history.standards.pollutant | string |
Name of the pollutant to which this standard applies, currently only PM10 and PM25 are supported. |
|
Limit - history
|
history.standards.limit | float |
Certain average concentration level of the pollutant which should not be exceeded over given period of time; in other words, this is the value for which the pollutant concentration reaches 100% of the limit. |
|
Percent - history
|
history.standards.percent | float |
Concentration value of a given pollutant expressed as a percentage of this concentration in the standard / limit, e.g. for a standard of 50μg/m3 of PM10 the concentration of 25μg/m3 is expressed as 50%. |
|
Averaging - history
|
history.standards.averaging | string |
Measurement values are interpolated by averaging measurements from nearby sensors (up to 1,5km away from the given point). |
|
forecast
|
forecast | array of object |
Forecast entries. |
|
From DateTime - forecast
|
forecast.fromDateTime | string |
ISO8601 timestamp. Date and time in UTC. The field represent start time from which the data in this payload was measured and averaged. |
|
Till DateTime - forecast
|
forecast.tillDateTime | string |
ISO8601 timestamp. Date and time in UTC. The field represent end time to which the data in this payload was measured and averaged. |
|
values
|
forecast.values | array of object |
Values - forecast. |
|
Measurement name - forecast
|
forecast.values.name | string |
Name (type) of the given measurement; e.g. PM10. |
|
Measurement value - forecast
|
forecast.values.value | float |
Measured value of the given measurement type, e.g. concentration 25µg/m3. |
|
indexes
|
forecast.indexes | array of object |
Indexes - forecast. |
|
Standard name - forecast
|
forecast.indexes.name | string |
Name of this standard. Currently only WHO standards are supported. |
|
Pollutant - forecast
|
forecast.indexes.pollutant | string |
Name of the pollutant to which this standard applies, currently only PM10 and PM25 are supported. |
|
Limit - forecast
|
forecast.indexes.limit | float |
Certain average concentration level of the pollutant which should not be exceeded over given period of time; in other words, this is the value for which the pollutant concentration reaches 100% of the limit. |
|
Percent - forecast
|
forecast.indexes.percent | float |
Concentration value of a given pollutant expressed as a percentage of this concentration in the standard / limit, e.g. for a standard of 50μg/m3 of PM10 the concentration of 25μg/m3 is expressed as 50%. |
|
Averaging - forecast
|
forecast.indexes.averaging | string |
Measurement values are interpolated by averaging measurements from nearby sensors (up to 1,5km away from the given point). |
|
standards
|
forecast.standards | array of object |
Standards - forecast. |
|
Standard name - forecast
|
forecast.standards.name | string |
Name of this standard. Currently only WHO standards are supported. |
|
Pollutant - forecast
|
forecast.standards.pollutant | string |
Name of the pollutant to which this standard applies, currently only PM10 and PM25 are supported. |
|
Limit - forecast
|
forecast.standards.limit | float |
Certain average concentration level of the pollutant which should not be exceeded over given period of time; in other words, this is the value for which the pollutant concentration reaches 100% of the limit. |
|
Percent - forecast
|
forecast.standards.percent | float |
Concentration value of a given pollutant expressed as a percentage of this concentration in the standard / limit, e.g. for a standard of 50μg/m3 of PM10 the concentration of 25μg/m3 is expressed as 50%. |
|
Averaging - forecast
|
forecast.standards.averaging | string |
Measurement values are interpolated by averaging measurements from nearby sensors (up to 1,5km away from the given point). |
Get nearest installations
Endpoint returns list of installations which are closest to a given point, sorted by distance to that point.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Latitude
|
lat | True | float |
Latitude as decimal degree, e.g. 50.062006. |
|
Longitude
|
lng | True | float |
Longitude as decimal degree, e.g. 19.940984. |
|
Max distance (KM)
|
maxDistanceKM | float |
Default value 3.0. All the returned installations must be located within this limit from the given point (in km). Negative value means no limit. |
|
|
Max returned results
|
maxResults | integer |
Default value 1. Maximum number of installations to return. Negative value means no limit |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
|
array of object | ||
|
Id
|
id | integer |
Unique installation identifier. Having InstallationId you can query measurements from particular installation. |
|
Latitude
|
location.latitude | float |
Installation coordinates - latitude. Exact sensor location on map. |
|
Longitude
|
location.longitude | float |
Installation coordinates - longitude. Exact sensor location on map. |
|
Location Id
|
locationId | integer |
Unique location identifier. |
|
Country
|
address.country | string |
Installation country. Attribute is optional, may be empty or null. |
|
City
|
address.city | string |
Installation city. Attribute is optional, may be empty or null. |
|
Street
|
address.street | string |
Installation street. Attribute is optional, may be empty or null. |
|
Number
|
address.number | string |
Installation street number. Attribute is optional, may be empty or null. |
|
Display address 1
|
address.displayAddress1 | string |
Extra field describing address, e.g. school name or number. Optional field. |
|
Display address 2
|
address.displayAddress2 | string |
Extra field describing address, e.g. school name or number. Optional field. |
|
Elevation
|
elevation | float |
Altitude at which device is installed; meters above mean sea level (mamsl). |
|
Airly
|
airly | boolean |
Flag indicating whether this installation is an Airly device or not; e.g. GIOŚ stations are flagged as false. |
|
Id
|
sponsor.id | integer |
Sponsor identifier. |
|
Name
|
sponsor.name | string |
Name of this installation's sponsor. |
|
Description
|
sponsor.description | string |
Additional description of this installation's sponsor. |
|
Logo
|
sponsor.logo | string |
Url pointing to sponsor's logo (jpg image). |
|
Link
|
sponsor.link | string |
Url pointing to sponsor's website. |
Get nearest measurements
Endpoint returns measurements for an installation closest to a given location.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Latitude
|
lat | True | number |
Latitude as decimal degree, e.g. 50.062006. |
|
Longitude
|
lng | True | number |
Longitude as decimal degree, e.g. 19.940984. |
|
Max distance (KM)
|
maxDistanceKM | float |
The searched installation must be located within this limit from the given point (in km). Negative value means no limit. |
|
|
Index type
|
indexType | string |
Selects the type of the index which should be calculated and returned in response. |
|
|
Language
|
Accept-Language | string |
Language in which text descriptions should be returned. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
From DateTime - current
|
current.fromDateTime | string |
ISO8601 timestamp. Date and time in UTC. The field represent start time from which the data in this payload was measured and averaged. |
|
Till DateTime - current
|
current.tillDateTime | string |
ISO8601 timestamp. Date and time in UTC. The field represent end time to which the data in this payload was measured and averaged. |
|
values
|
current.values | array of object |
Values - current. |
|
Measurement name - current
|
current.values.name | string |
Name (type) of the given measurement; e.g. PM10. |
|
Measurement value - current
|
current.values.value | float |
Measured value of the given measurement type, e.g. concentration 25µg/m3. |
|
indexes
|
current.indexes | array of object |
Indexes - current. |
|
Index name - current
|
current.indexes.name | string |
Name of the index (e.g. CAQI, or PIJP). |
|
Index value - current
|
current.indexes.value | float |
Numerical value of the calculated index. |
|
Level - current
|
current.indexes.level | string |
Discreet level of the index (e.g. HIGH, or LOW etc.). |
|
Description - current
|
current.indexes.description | string |
Description of the index level. The text translated and returned in a language according to Accept-Language request header. |
|
Advice - current
|
current.indexes.advice | string |
Additional text with advice regarding current index level. The text translated and returned in a language according to Accept-Language request header. |
|
Color - current
|
current.indexes.color | string |
Color representing index level in a form of hexadecimal RGB triplet (e.g. #D1CF1E). |
|
standards
|
current.standards | array of object |
Standards - current. |
|
Standard name - current
|
current.standards.name | string |
Name of this standard. Currently only WHO standards are supported. |
|
Pollutant - current
|
current.standards.pollutant | string |
Name of the pollutant to which this standard applies, currently only PM10 and PM25 are supported. |
|
Limit - current
|
current.standards.limit | float |
Certain average concentration level of the pollutant which should not be exceeded over given period of time; in other words, this is the value for which the pollutant concentration reaches 100% of the limit. |
|
Percent - current
|
current.standards.percent | float |
Concentration value of a given pollutant expressed as a percentage of this concentration in the standard / limit, e.g. for a standard of 50μg/m3 of PM10 the concentration of 25μg/m3 is expressed as 50%. |
|
Averaging - current
|
current.standards.averaging | string |
Measurement values are interpolated by averaging measurements from nearby sensors (up to 1,5km away from the given point). |
|
history
|
history | array of object |
Historical entries. |
|
From DateTime - history
|
history.fromDateTime | string |
ISO8601 timestamp. Date and time in UTC. The field represent start time from which the data in this payload was measured and averaged. |
|
Till DateTime - history
|
history.tillDateTime | string |
ISO8601 timestamp. Date and time in UTC. The field represent end time to which the data in this payload was measured and averaged. |
|
values
|
history.values | array of object |
Values - history. |
|
Measurement name - history
|
history.values.name | string |
Name (type) of the given measurement; e.g. PM10. |
|
Measurement value - history
|
history.values.value | float |
Measured value of the given measurement type, e.g. concentration 25µg/m3. |
|
indexes
|
history.indexes | array of object |
Indexes - history. |
|
Standard name - history
|
history.indexes.name | string |
Name of this standard. Currently only WHO standards are supported. |
|
Pollutant - history
|
history.indexes.pollutant | string |
Name of the pollutant to which this standard applies, currently only PM10 and PM25 are supported. |
|
Limit - history
|
history.indexes.limit | float |
Certain average concentration level of the pollutant which should not be exceeded over given period of time; in other words, this is the value for which the pollutant concentration reaches 100% of the limit. |
|
Percent - history
|
history.indexes.percent | float |
Concentration value of a given pollutant expressed as a percentage of this concentration in the standard / limit, e.g. for a standard of 50μg/m3 of PM10 the concentration of 25μg/m3 is expressed as 50%. |
|
Averaging - history
|
history.indexes.averaging | string |
Measurement values are interpolated by averaging measurements from nearby sensors (up to 1,5km away from the given point). |
|
standards
|
history.standards | array of object |
Standards - history. |
|
Standard name - history
|
history.standards.name | string |
Name of this standard. Currently only WHO standards are supported. |
|
Pollutant - history
|
history.standards.pollutant | string |
Name of the pollutant to which this standard applies, currently only PM10 and PM25 are supported. |
|
Limit - history
|
history.standards.limit | float |
Certain average concentration level of the pollutant which should not be exceeded over given period of time; in other words, this is the value for which the pollutant concentration reaches 100% of the limit. |
|
Percent - history
|
history.standards.percent | float |
Concentration value of a given pollutant expressed as a percentage of this concentration in the standard / limit, e.g. for a standard of 50μg/m3 of PM10 the concentration of 25μg/m3 is expressed as 50%. |
|
Averaging - history
|
history.standards.averaging | string |
Measurement values are interpolated by averaging measurements from nearby sensors (up to 1,5km away from the given point). |
|
forecast
|
forecast | array of object |
Forecast entries. |
|
From DateTime - forecast
|
forecast.fromDateTime | string |
ISO8601 timestamp. Date and time in UTC. The field represent start time from which the data in this payload was measured and averaged. |
|
Till DateTime - forecast
|
forecast.tillDateTime | string |
ISO8601 timestamp. Date and time in UTC. The field represent end time to which the data in this payload was measured and averaged. |
|
values
|
forecast.values | array of object |
Values - forecast. |
|
Measurement name - forecast
|
forecast.values.name | string |
Name (type) of the given measurement; e.g. PM10. |
|
Measurement value - forecast
|
forecast.values.value | float |
Measured value of the given measurement type, e.g. concentration 25µg/m3. |
|
indexes
|
forecast.indexes | array of object |
Indexes - forecast. |
|
Standard name - forecast
|
forecast.indexes.name | string |
Name of this standard. Currently only WHO standards are supported. |
|
Pollutant - forecast
|
forecast.indexes.pollutant | string |
Name of the pollutant to which this standard applies, currently only PM10 and PM25 are supported. |
|
Limit - forecast
|
forecast.indexes.limit | float |
Certain average concentration level of the pollutant which should not be exceeded over given period of time; in other words, this is the value for which the pollutant concentration reaches 100% of the limit. |
|
Percent - forecast
|
forecast.indexes.percent | float |
Concentration value of a given pollutant expressed as a percentage of this concentration in the standard / limit, e.g. for a standard of 50μg/m3 of PM10 the concentration of 25μg/m3 is expressed as 50%. |
|
Averaging - forecast
|
forecast.indexes.averaging | string |
Measurement values are interpolated by averaging measurements from nearby sensors (up to 1,5km away from the given point). |
|
standards
|
forecast.standards | array of object |
Standards - forecast. |
|
Standard name - forecast
|
forecast.standards.name | string |
Name of this standard. Currently only WHO standards are supported. |
|
Pollutant - forecast
|
forecast.standards.pollutant | string |
Name of the pollutant to which this standard applies, currently only PM10 and PM25 are supported. |
|
Limit - forecast
|
forecast.standards.limit | float |
Certain average concentration level of the pollutant which should not be exceeded over given period of time; in other words, this is the value for which the pollutant concentration reaches 100% of the limit. |
|
Percent - forecast
|
forecast.standards.percent | float |
Concentration value of a given pollutant expressed as a percentage of this concentration in the standard / limit, e.g. for a standard of 50μg/m3 of PM10 the concentration of 25μg/m3 is expressed as 50%. |
|
Averaging - forecast
|
forecast.standards.averaging | string |
Measurement values are interpolated by averaging measurements from nearby sensors (up to 1,5km away from the given point). |