Search
K

Release Notes

The AirQo API is regularly updated with new features, bug fixes, and performance improvements. You can specify which version of the API to load in the v parameter of the API request.
This changelog lists releases by date and version number, along with associated changes.

2.0.6

29th December 2023

Introduction of Cohort ID Associated IDs Retrieval

This update focuses on enhancing your experience by providing a new endpoint that enables users to retrieve site IDs and device IDs associated with a known Cohort ID.
New Endpoint:
  • Cohort ID Associated IDs Retrieval: Now, users can seamlessly retrieve site IDs and device IDs connected to a specified Cohort ID. This functionality empowers users to efficiently gather relevant IDs and utilise them across various endpoints, simplifying data retrieval for both specific sites and individual devices.
We believe this enhancement will further streamline your data access and retrieval processes. Explore the new endpoint and let us know how it enhances your environmental data analysis.

2.0.5

23rd November 2023

Introduction of Grid ID Associated IDs Retrieval

In our most recent release, marked 2.0.5, we are thrilled to introduce a valuable addition to our API capabilities. This update focuses on enhancing your experience by providing a new endpoint that enables users to retrieve site IDs and device IDs associated with a known Grid ID.
New Endpoint:
  • Grid ID Associated IDs Retrieval: Now, users can seamlessly retrieve site IDs and device IDs connected to a specified Grid ID. This functionality empowers users to efficiently gather relevant IDs and utilise them across various endpoints, simplifying data retrieval for both specific sites and individual devices.
We believe this enhancement will further streamline your data access and retrieval processes. Explore the new endpoint and let us know how it enhances your environmental data analysis.

2.0.4

19th November 2023

Expanded Historical Measurement Query Options

In our latest release, dated November 19, 2023, we are thrilled to introduce enhanced endpoints for historical measurement queries. These additions provide you with more versatility in retrieving data, offering a comprehensive approach to environmental data analysis.
New Query Options:
  1. 1.
    Cohort ID Query: Now, you can efficiently retrieve measurements based on Cohort IDs, simplifying data access for specific device groups.
  2. 2.
    Grid ID Query: Explore measurements using Grid IDs, facilitating spatial analysis and insights for monitoring sites.
  3. 3.
    Device ID Query: Query historical measurements using Device IDs, allowing focused data retrieval for individual devices.
  4. 4.
    AirQloud ID Query: Gain insights by querying historical measurements using AirQloud IDs.
  5. 5.
    Site ID Query: Refine your data retrieval by querying historical measurements using Site IDs.
We believe these enhancements will significantly enhance your data-driven decision-making processes. Please explore and let us know how these features support your environmental monitoring initiatives.

2.0.3

14th October 2023

Enhanced Measurement Querying Options

These improvements in measurement querying options empower you to make more informed decisions, streamline your data analysis, and enhance your environmental monitoring initiatives. We look forward to seeing how these enhancements support your work.
  • Cohort ID Query: You can now query measurements using Cohort IDs, which represent groups of devices. This feature enables more targeted data retrieval, making it easier to access data related to specific device cohorts.
  • Grid ID Query: Another addition is the ability to query measurements using Grid IDs, which signify groups of monitoring sites. This enhancement simplifies data retrieval for spatial analysis and insights..
  • Documentation Optimization: In response to user feedback, we've streamlined our documentation for forecasts. Redundant endpoints have been consolidated into a single endpoint, offering a more efficient and clear approach to forecasting operations.

2.0.2

9th October 2023

Introducing New Endpoints for Enhanced Metadata Retrieval

We are thrilled to introduce a set of powerful new endpoints in AirQo Analytics API version 2.0.2. These additions are designed to empower you with enhanced metadata retrieval capabilities, enabling you to make data-driven decisions and optimise your operations by accessing critical details.
Each metadata retrieval endpoint provides you with detailed information about AirQlouds, sites, devices, cohorts, and grids. These endpoints are designed to help you make more informed decisions and streamline your environmental monitoring initiatives.
  • AirQloud Metadata: Retrieve detailed metadata for AirQlouds. Access valuable insights about each AirQloud to enhance your environmental monitoring efforts..
  • Site Metadata: Fetch comprehensive metadata for monitoring sites. Obtain detailed site information to support your data analysis and research.
  • Device Metadata: Access extensive metadata for monitoring devices. Obtain detailed device information for in-depth analysis and monitoring.
  • Cohort Metadata: Retrieve metadata based on cohort IDs. Organize and analyze metadata by cohorts for more targeted insights and data organization
  • Grid Metadata: Access metadata related to grid-based monitoring. Use grid IDs to gather essential metadata for spatial analysis and insights

2.0.1

15th September 2023

Empowering Data-Driven Decisions with Forecasting Capabilities

We're excited to introduce powerful forecasting capabilities to the AirQo Analytics API with version 2.0.1. This update equips you with essential tools to enhance your data-driven decisions. You can now access hourly and daily forecasts based on site or device ID, empowering you to proactively address air quality challenges and optimize your operations.
  • Hourly Forecast: Retrieve precise hourly air quality forecasts by site or device ID.
  • Daily Forecast: Access comprehensive daily air quality forecasts for informed planning.
  • Improved Decision-Making: Leverage forecasting to make data-driven choices.
  • Enhanced API Functionality: Continuously evolving the AirQo Analytics API to meet your needs.

2.0.0

28th August 2023

Introducing Enhanced Features and Security to the AirQo Analytics API

We are thrilled to announce a series of updates that bring enhanced security and new features to the AirQo Analytics API. These improvements include strengthened authentication with the introduction of client IDs, expanded data retrieval capabilities through new endpoints, a transition to v2 endpoints for the latest enhancements, and the ability to query measurements using both AirQloud and Site IDs. These enhancements collectively elevate your experience and empower you to make the most of the API's capabilities.
  • Enhanced Security: Introducing client ID for more secure authentication.
  • Extended Data Retrieval: New endpoints for comprehensive data retrieval.
  • Version Update: Transition to v2 endpoints for the latest enhancements.
  • Advanced Querying: Query measurements using both AirQloud and Site IDs.

1.7.4

29th July 2022

Changes to V2 of Get Device Measurements

  • Added support for CSV responses with the introduction of a new query parameter (format)
  • Responses are now in descending order with the most recent measurements at the top.
  • Applied compression algorithms which have greatly decreased the size of the response body and hence increased the speed of the product.
  • Addressed challenges with the datetime query parameters where the results were the start and end datetimes returned were not reflective of the exact query parameter values entered.
  • Sanitised the timestamp output format, Initially, the timestamp returned as an object instead of just the string value.

1.7.3

7th October 2021

Changed

  • Removed extra/unnecessary fields from events endpoint (s2_pm2_5 s2_pm10).
  • The returned pollutant values (PM2.5 and PM10) is now the averages of the two sensors for each pollutant.
  • Minimum frequency is now hourly , not raw values.
  • Removes empty objects, arrays, empty strings, NaN, null and undefined values from response.
  • Makes the query parameter recent=no as the default for the GET Events endpoint

1.7.3

7th October 2021

Changed

  • Removed extra/unnecessary fields from events endpoint (s2_pm2_5 s2_pm10).
  • The returned pollutant values (PM2.5 and PM10) is now the averages of the two sensors for each pollutant.
  • Minimum frequency is now hourly , not raw values.
  • Removes empty objects, arrays, empty strings, NaN, null and undefined values from response.
  • Makes the query parameter recent=no as the default for the GET Events endpoint

1.7.2

24th September, 2021

Changed

  • Remove extra/unnecessary fields (s2_pm2_5).
  • The returned pollutant values are averages of the two sensors
  • Minimum frequency of hourly , not raw values.
  • Removes empty objects, arrays, empty strings, NaN, null and undefined values from response

Added

  • Added a new query parameter (external) whose default is always "yes".

1.7.1

10th September, 2021

Fixed

  • For the GET Events, one can now be able to retrieve hourly data using the frequency query parameter.

Changed

  • Changed the device field in the JSON response from _id to device.

Added

  • Added the metadata query parameter when fetching events. So a person can be able to select the type of metadata they want. Can either be device or site_id accordingly.