# Weather data

# Air Quality index - Daily

weatherDaily

Daily Maximum or Average Air Quality index: PM2.5 (PM25A),PM10 (PM10A), O3, CO2 (CO2RE), NO2, SO2. The parameters of the devices depends on devices type and the device model is also avaiable.

# HTTP Request

GET {url}/data/weather/air/daily?startTime={startTime}&endTime={endTime}&deviceIds={device_ids}

# Request headers

KEY	VALUE
x-language	en
Authorization	Bearer `{YOUR_API_TOKEN_HERE}`

# Request params

Parameter	Required	Type	Description
startTime	YES	datetime	Initial DateTime (UTC) for collecting the data
endTime	YES	datetime	Final DateTime (UTC) for collecting the data. The maximum allowed time interval is 30 days
deviceIds	YES	Array of String	Array of Devices ID. The device ID could be specified more than 1 device by comma (,)

# Response

When successful, redirects to the assigned redirect_uri or posts according to the form with the parameters below attached.

Parameter	Type	Description
count	Number	The count of the raw data in the requested period time.
data.date	datetime	UTC datetime of the publish timestamp (average 15 minutes) from the device or summarized devices
data.params	double	the tag code or parameter's values as requested
data.deviceId	String	Device ID

{
    "data": {
        "count": 2,
        "air": [
            {
                "deviceId": "6125e7ca45d8e49e5c3596c6",
                "date": "2021-09-05T17:00:00.000Z",
                "pm25": {
                    "UGm3": 7.606334841628959,
                    "AQI": 8
                },
                "pm10": {
                    "UGm3": 11.253393665158372,
                    "AQI": 22
                },
                "co2": {
                    "ppm": 427.9578947368421,
                    "AQI": 598
                }
            },
            {
                "deviceId": "6125e7ca45d8e49e5c3596c6",
                "date": "2021-09-06T17:00:00.000Z",
                "pm25": {
                    "UGm3": 15.545454545454545,
                    "AQI": 16
                },
                "pm10": {
                    "UGm3": 25,
                    "AQI": 50
                },
                "co2": {
                    "ppm": 405.8181818181818,
                    "AQI": 576
                }
            }
        ]
    }
}

Example

As the response above, we got the daily air quality index of the PM2.5 both units (ug/m3 and AQI), the daily air quality index of the PM10 both units (ug/m3 and AQI) and the daily air quality index of the CO2 both units (ppm and AQI) on date "2021-09-06" and "2021-09-07" of the device "DEVICE_NAME".

# Weather - Daily

weatherDaily

Daily Maximum or Minimum or Average Air Quality index: PM2.5 (PM25A),PM10 (PM10A), O3, CO2 (CO2RE), NO2, SO2 and Weather: Ambient Temperature (ABTMP), Humidity (HUDTY), Wind Speed (WISPE). The parameters of the devices depends on devices type and the device model is also avaiable.

# HTTP Request

GET {url}/data/weather/daily?startTime={startTime}&endTime={endTime}&deviceIds={device_ids}

# Request headers

KEY	VALUE
x-language	en
Authorization	Bearer `{YOUR_API_TOKEN_HERE}`

# Request params

Parameter	Required	Type	Description
startTime	YES	datetime	Initial DateTime (UTC) for collecting the data
endTime	YES	datetime	Final DateTime (UTC) for collecting the data. The maximum allowed time interval is 30 days
deviceIds	YES	Array of String	Array of Devices ID. The device ID could be specified more than 1 device by comma (,)
params	YES	Array of String	Array of tag code (XXXXX). The tag code could be specified more than 1 parameters by comma (,)

# Response

When successful, redirects to the assigned redirect_uri or posts according to the form with the parameters below attached.

Parameter	Type	Description
count	Number	The count of the raw data in the requested period time.
data.date	datetime	UTC datetime of the publish timestamp (average 15 minutes) from the device or summarized devices
data.params	double	the tag code or parameter's values as requested
data.deviceId	String	Device ID


{
    "data": {
        "count": 14,
        "weather": [
            {
                "date": "2021-10-15T17:00:00.000Z",
                "deviceId": "6125e7ca45d8e49e5c3596c6",
                "ABTMP_MAX": 29.033333333333335,
                "ABTMP_MIN": 25.2,
                "CO2RE_MAX": 424.66129032258067,
                "CO2RE_MIN": 412.3068181818182,
                "HUDTY_MAX": 85.9090909090909,
                "HUDTY_MIN": 74.16666666666667,
                "PM10A_AVG": 15.575510204081633,
                "PM25A_AVG": 10.612244897959183,
                "RAINF_SUM": 0,
                "WISPE_MAX": 0.520625,
                "WISPE_MIN": 0.01
            },
            ...
        ]
    }
}

Example

As the response above, we got the daily (max/min/avg) air quality index and weathers' parameters on date "2021-10-16" of the device "DEVICE_NAME".

# Weather - Monthly

weatherMonthly

Monthly Maximum or Minimum or Average Air Quality index: PM2.5 (PM25A),PM10 (PM10A), O3, CO2 (CO2RE), NO2, SO2 and Weather: Ambient Temperature (ABTMP), Humidity (HUDTY), Wind Speed (WISPE). The parameters of the devices depends on devices type and the device model is also avaiable.

# HTTP Request

GET {url}/data/weather/monthly?startTime={startTime}&endTime={endTime}&deviceIds={device_ids}

# Request headers

KEY	VALUE
x-language	en
Authorization	Bearer `{YOUR_API_TOKEN_HERE}`

# Request params

Parameter	Required	Type	Description
startTime	YES	datetime	Initial DateTime (UTC) for collecting the data
endTime	YES	datetime	Final DateTime (UTC) for collecting the data. The maximum allowed time interval is 30 days
deviceIds	YES	Array of String	Array of Devices ID. The device ID could be specified more than 1 device by comma (,)
params	YES	Array of String	Array of tag code (XXXXX). The tag code could be specified more than 1 parameters by comma (,)

# Response

When successful, redirects to the assigned redirect_uri or posts according to the form with the parameters below attached.

Parameter	Type	Description
count	Number	The count of the raw data in the requested period time.
data.date	datetime	UTC datetime of the publish timestamp (average 15 minutes) from the device or summarized devices
data.params	double	the tag code or parameter's values as requested
data.deviceId	String	Device ID


{
    "data": {
        "count": 14,
        "weather": [
            {
                "ABTMP_MAX": 29.675,
                "ABTMP_MIN": 23.9,
                "HUDTY_MAX": 89,
                "HUDTY_MIN": 56.083333333333336,
                "CO2RE_MAX": 534.5555555555555,
                "CO2RE_MIN": 399.125,
                "PM10A_MAX": 72.49246231155779,
                "PM10A_MIN": 4.563786008230453,
                "PM25A_MAX": 42.346231155778895,
                "PM25A_MIN": 3.567901234567901,
                "RAINF_SUM": 0,
                "WISPE_MAX": 0.7616666666666667,
                "WISPE_MIN": 0,
                "date": "2021-09-30T17:00:00.000Z",
                "deviceId": "6125e7ca45d8e49e5c3596c6"
            },
            ...
        ]
    }
}

Example

As the response above, we got the monthly (max/min) air quality index and weathers' parameters on date "2021-10" of the device "DEVICE_NAME".

# Weather - Lasted Feel like

heatIndex

The Heat Index is a measure of how hot it really feels when relative humidity is factored in with the actual air temperature. To find the Heat Index temperature, look at the Heat Index Chart above or check our Heat Index Calculator. The parameters of the devices shall be consist of relative humidity (HUDTY) and ambient temperature (ABTMP).

# HTTP Request

GET {url}/data/weather/feellike?deviceIds={device_ids}

# Request headers

KEY	VALUE
x-language	en
Authorization	Bearer `{YOUR_API_TOKEN_HERE}`

# Request params

Parameter	Required	Type	Description
deviceIds	YES	Array of String	Array of Devices ID. The device ID could be specified more than 1 device by comma (,)

# Response

When successful, redirects to the assigned redirect_uri or posts according to the form with the parameters below attached.

Parameter	Type	Description
count	Number	The count of the raw data in the requested period time.
data.deviceId	String	Device ID
data.date	datetime	UTC datetime of the publish timestamp (average 15 minutes) from the device or summarized devices
data.params	double	the tag code or parameter's values as requested
data.feelLike	double	The heat index


{
    "data": {
        "count": 2,
        "feelLikes": [
            {
                "deviceId": "612c849389362868151f62c5",
                "date": "2022-01-27T09:00:00.000Z",
                "ABTMP": 27.1,
                "HUDTY": 84.98,
                "feelLike": 29
            },
            {
                "deviceId": "61dbec487616e3d9a7de495f",
                "date": "2022-01-27T09:00:00.000Z",
                "ABTMP": 23.3,
                "HUDTY": 71.43
            }
        ]
    }
}

Example

As the response above, we got the lasted ambient temperature °C, relative humidity %, and feel like temperature °C of the device "DEVICE_NAME".

# Rainfall - Hourly

rainfall

Rainfall Hourly (mm/hr) is calculated from the raw Rainfall Amount (RAINF) (mm). The parameters of the devices depends on devices type and the device model is also avaiable.

# HTTP Request

GET {url}/data/weather/rainfall/hourly?deviceIds={device_ids}&startTime={startTime}&endTime={endTime}

# Request headers

KEY	VALUE
x-language	en
Authorization	Bearer `{YOUR_API_TOKEN_HERE}`

# Request params

Parameter	Required	Type	Description
startTime	YES	datetime	Initial DateTime (UTC) for collecting the data
endTime	YES	datetime	Final DateTime (UTC) for collecting the data. The maximum allowed time interval is 30 days
deviceIds	YES	Array of String	Array of Devices ID. The device ID could be specified more than 1 device by comma (,)

# Response

When successful, redirects to the assigned redirect_uri or posts according to the form with the parameters below attached.

Parameter	Type	Description
count	Number	The count of the raw data in the requested period time.
data.date	datetime	UTC datetime of the publish timestamp from the device or summarized devices
data.params	double	the tag code or parameter's values as requested
data.deviceId	String	Device ID


{
    "data": {
        "count": 24,
        "rainfall": [
            {
                "date": "2022-06-12T17:00:00.000Z",
                "deviceId": "616ad4ccf8c8dafcb93cd37d",
                "RAINF": 2.2,
 
            },
            ...
        ]
    }
}

Example

As the response above, we got the Rainfall hourly (mm/hr) since "2022-06-13" to "2022-06-14" of the device "DEVICE_NAME".

# Rainfall - Daily

rainfall

Rainfall Daily (mm/day) is calculated from the raw Rainfall Amount (RAINF) (mm). The parameters of the devices depends on devices type and the device model is also avaiable.

# HTTP Request

GET {url}/data/weather/rainfall/daily?deviceIds={device_ids}&startTime={startTime}&endTime={endTime}

# Request headers

KEY	VALUE
x-language	en
Authorization	Bearer `{YOUR_API_TOKEN_HERE}`

# Request params

Parameter	Required	Type	Description
startTime	YES	datetime	Initial DateTime (UTC) for collecting the data
endTime	YES	datetime	Final DateTime (UTC) for collecting the data. The maximum allowed time interval is 30 days
deviceIds	YES	Array of String	Array of Devices ID. The device ID could be specified more than 1 device by comma (,)

# Response

When successful, redirects to the assigned redirect_uri or posts according to the form with the parameters below attached.

Parameter	Type	Description
count	Number	The count of the raw data in the requested period time.
data.date	datetime	UTC datetime of the publish timestamp from the device or summarized devices
data.params	double	the tag code or parameter's values as requested
data.deviceId	String	Device ID


{
    "data": {
        "count": 1,
        "rainfall": [
            {
                "date": "2022-06-12T17:00:00.000Z",
                "deviceId": "616ad4ccf8c8dafcb93cd37d",
                "RAINF": 4,
 
            }
        ]
    }
}

Example

As the response above, we got the Rainfall daily (mm/day) on "2022-06-13" of the device "DEVICE_NAME".

← Smart Logger Data Push Messages (webhooks) →