Reports

This section offers detailed insights into particulate matter (PM) concentrations, including annual averages, daily means, hourly measurements, and diurnal patterns.

1. Comprehensive air quality data analytics for specific grids over customisable time periods

GET {{baseURL}}/analytics/grid/report

This endpoint provides comprehensive air quality data analytics for specific grids over customizable time periods. It endpoints offers detailed insights into particulate matter (PM) concentrations, including annual averages, daily means, hourly measurements, and diurnal patterns. This data enables users to gain deep insights into air quality trends and patterns within their chosen grid.

Body Parameters

Name	Type	Description
grid_id	tring	the Grid ID
start_time	Date	timestamp
end_time	Date	timestamp

Query Parameters

Name	Type	Description
token*	string	the security token

Request Body

{
    "grid_id": "659d036497e611001236cd1b",
    "start_time": "2024-08-01T00:00",
    "end_time": "2024-09-30T00:00"
}

200

{
    "annual_data": {
        "pm10_calibrated": 20.5,
        "pm25_calibrated": 15.8,
        // ... other annual data
    },
    "daily_mean_data": [
        {
            "date": "2024-08-01",
            "pm10_avg": 35.2,
            "pm25_avg": 22.1
        },
        // ... other daily data
    ],
    "hourly_mean_data": [
        {
            "time": "2024-08-01T00:00",
            "pm10_avg": 40.5,
            "pm25_avg": 28.3
        },
        // ... other hourly data
    ],
    // ... other data types
}

401: Unauthorized In case of bad requests

{
"success":false, 
"message":"Invalid authentication", 
"error":"Unauthorized"
}

Usage Instructions

You should note that all API endpoints require authentication using a valid AirQo token. Ensure proper handling of the returned data, as it may include sensitive information about air quality conditions. For optimal performance, consider implementing caching mechanisms for frequently accessed data points.