measurements.md

Get measurements(v1)

This is the API method for retrieving device measurements

Parameters

Query

Param	Type	Required	Description
tenant	string	True	The organisation, default is airqo. Otherwise, ensure that you utilise the right tenant key.
site	string	False	Unique name of the site
site_id	objectID	False	Object ID of the site
device	string	If device_id is absent	Unique device name
limit	integer	False	Limit to your query, default limit is 50
skip	integer	False	Number of items to skip in the query.
startTime	string	False	Date in this format: YYYY-MM-DD or the UTC time format in case you would like to access data at specific times, eg: 2021-05-24T12:45:24.000Z
endTime	string	False	Date in this format: YYYY-MM-DD. or the UTC time format in case you would like to access data at specific times, example: 2021-05-24T12:45:24.000
device_id	objectID	If device is absent	Unique object ID of the device
frequency	string	True	Averaging period of the measurements. Can be hourly, daily or raw

Example

curl --location --request GET 'https://api.airqo.net/api/v1/devices/events?tenant=airqo' \
--header 'Authorization: JWT ey123abc'

Responses

200

{
    "isCache": true,
    "success": true,
    "message": "successfully listed the Events",
    "measurements": [
        {
            "_id": "606ef94..........",
            "time": "2021-07-27T16:47:43.000Z",
            "is_test_data": true,
            "pm2_5": {
                "value": 48.12,
                "calibratedValue": null,
                "uncertaintyValue": null,
                "standardDeviationValue": null
            },
            "s2_pm2_5": {
                "value": 35.78,
                "calibratedValue": null,
                "uncertaintyValue": null,
                "standardDeviationValue": null
            },
            "pm10": {
                "value": 58.88,
                "calibratedValue": null,
                "uncertaintyValue": null,
                "standardDeviationValue": null
            },
            "s2_pm10": {
                "value": 44.95,
                "calibratedValue": null,
                "uncertaintyValue": null,
                "standardDeviationValue": null
            },
            "frequency": "raw",
            "battery": {
                "value": 4.21
            },
            "location": {
                "latitude": {
                    "value": null
                },
                "longitude": {
                    "value": null
                }
            },
            "altitude": {
                "value": 110936700000000000000
            },
            "speed": {
                "value": 0
            },
            "satellites": {
                "value": 0
            },
            "hdop": {
                "value": 0
            },
            "internalTemperature": {
                "value": 29
            },
            "externalTemperature": {
                "value": 23.52
            },
            "internalHumidity": {
                "value": 38
            },
            "externalHumidity": {
                "value": 62.68
            },
            "externalAltitude": null,
            "pm1": {
                "value": null,
                "calibratedValue": null,
                "uncertaintyValue": null,
                "standardDeviationValue": null
            },
            "no2": {
                "value": null,
                "calibratedValue": null,
                "uncertaintyValue": null,
                "standardDeviationValue": null
            },
            "deviceDetails": null
        },
        .....
    ]

400

In case of bad requests

{
  "success": false,
  "message": "bad request errors",
  "errors": [
    {
      "value": "airq",
      "msg": "the tenant value is not among the expected ones",
      "param": "tenant",
      "location": "query"
    }
  ]
}

---

Get measurements(v2)

This is the second version for getting device measurements.

Parameters

Query

Param	Type	Required	Description
tenant	string	True	The organisation, default is airqo. Otherwise, ensure that you utilise the right tenant key.
device	string	If device_id is absent	Unique device name
limit	integer	False	Limit to your query, default limit is 50
skip	integer	False	Number of items to skip in the query.
startTime	string	False	Date in this format: YYYY-MM-DD or the UTC time format in case you would like to access data at specific times, eg: 2021-05-24T12:45:24.000Z
endTime	string	False	Date in this format: YYYY-MM-DD. or the UTC time format in case you would like to access data at specific times, example: 2021-05-24T12:45:24.000
device_number	objectID	If device is absent	Number which could also be referred to as the channel ID. This is an integer which uniquely identifies the device. device
format	string	True	This could either be CSV or JSON.

Example

curl --location --request GET 'https://api.airqo.net/api/v2/devices/events?tenant=airqo' \
--header 'Authorization: JWT ey123abc'

Responses

200

A successful request response body.

{
  "success": true,
  "measurements": [
    {
      "site_id": "60d058512wf2fwf0d2d613f",
      "name": "Bukikali,Lwaso Mbale",
      "device": "aq_11314124142323124124232432",
      "device_number": 232434442443434234,
      "latitude": 1.0234234234978,
      "longitude": 24324.233655,
      "timestamp": "2022-08-01T08:00:00.000Z",
      "pm2_5": 77.34249999999996,
      "pm10": 65.08457209340884,
      "pm2_5_raw_value": 69.94911111111111,
      "pm2_5_calibrated_value": 77.34249999999996,
      "pm10_raw_value": 85.963,
      "pm10_calibrated_value": 65.08457209340884,
      "tenant": "airqo"
    }
  ],
  "message": "successfully retrieved the measurements"
}

400

Bad request response body

{
  "success": false,
  "message": "bad request errors",
  "errors": {
    "tenant": "the tenant value is not among the expected ones"
  }
}