Metadata

Simplify your experience with the Air Quality Metadata API, designed to provide seamless access to essential information. This page serves as your gateway to various endpoints, each offering publicly

Endpoint Overview

Explore the wealth of metadata through the following endpoints:

1. Grid Metadata

Access information about geographical grids for effective data organisation.

Get all publicly available Grids

GET https://api.airqo.net/api/v2/devices/metadata/grids

Retrieve all publicly available Sites

Path Parameters

Name	Type	Description
grid_id	String	An object ID which is a unique identifier for a Grid

Query Parameters

Name	Type	Description
token*	string	the security token

200

```json
{
    "success": true,
    "message": "There are no records for this search",
    "grids": []
}
```

401: Unauthorized In case of bad requests

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

2. Cohort Metadata

Retrieve details about cohorts to understand logical groupings of devices.

Get all publicly available Cohorts

GET https://api.airqo.net/api/v2/devices/metadata/cohorts

Retrieve all publicly available Sites

Path Parameters

Name	Type	Description
cohort_id	String	An object ID which is a unique identifier for a Cohort

Query Parameters

Name	Type	Description
token*	string	the security token

200

```json
{
    "success": true,
    "message": "There are no records for this search",
    "cohorts": []
}
```

401: Unauthorized In case of bad requests

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

3. Device Metadata

Obtain essential information about individual devices for precise data retrieval.

Get all publicly available Devices

GET https://api.airqo.net/api/v2/devices/metadata/devices

Retrieve all publicly available Sites

Path Parameters

Name	Type	Description
device_id	String	An object ID which is a unique identifier for a Device

Query Parameters

Name	Type	Description
token*	string	the security token

200

```json
{
    "success": true,
    "message": "There are no records for this search",
    "devices": []
}
```

401: Unauthorized In case of bad requests

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

4. Site Metadata

Access publicly available details about specific air quality monitoring sites.

Get all publicly available Sites

GET https://api.airqo.net/api/v2/devices/metadata/sites

Retrieve all publicly available Sites

Path Parameters

Name	Type	Description
site_id	String	An object ID which is a unique identifier for a Site

Query Parameters

Name	Type	Description
token*	string	the security token

200

```json
{
    "success": true,
    "message": "There are no records for this search",
    "sites": []
}
```

401: Unauthorized In case of bad requests

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

5. Generate Site and Device IDs associated with a Grid

Generate all the site and device IDs associated with a Grid

Retrieve Site and Device IDs associated with Grid ID

GET https://api.airqo.net/api/v2/devices/grids/{GRID_ID}/generate

Retrieve all publicly available Sites

Path Parameters

Name	Type	Description
grid_id*	String	An object ID which is a unique identifier for a Grid

Query Parameters

Name	Type	Description
token*	string	the security token

200

```json
{
    "success": true,
    "message": "There are no records for this search",
    "sites": []
}
```

401: Unauthorized In case of bad requests

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

6. Generate Site and Device IDs associated with a Cohort

Generate all the site and device IDs associated with a Cohort

Retrieve Site and Device IDs associated with Cohort ID

GET https://api.airqo.net/api/v2/devices/cohorts/{COHORT_ID}/generate

Retrieve all publicly available Sites

Path Parameters

Name	Type	Description
cohort_id*	String	An object ID which is a unique identifier for a Cohort

Query Parameters

Name	Type	Description
token*	string	the security token

200

```json
{
    "success": true,
    "message": "There are no records for this search",
    "sites": []
}
```

401: Unauthorized In case of bad requests

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

Usage Instructions

Effortlessly integrate metadata retrieval into your applications. Navigate through each section to learn how to utilise the provided endpoints, gaining valuable insights into grids, cohorts, devices, and sites. Enhance your air quality data understanding with detailed metadata, empowering your applications with context and accuracy.