Readings

GET {baseURl}/readings
Return a list of raw hardware readings in time descending order. The purpose of this API is for internal usage and special projects, therefore most of the clients' API keys won't have access to this API. Please use GET /measurements to retrieve air quality data.

Example: https://clarity-data-api.clarity.io/v1/readings

Headers

x-api-key: the API key string.

Request

parameter		description
`code`	string	The short device ID(s) to filter on. `code` is a short ID that's labeled on the physical device, usually starting with "A". Use comma separated string to query multiple devices. Measurements will only be returned for devices specified. Note: `device` and `code` are mutually exclusive. If both are provided, only one of them will be used.
`startTime`	string	Timestamp of earliest measurement desired. If provided, all measurements with time earlier than startTime will be filtered out. Date string is expected to be in ISO 8601 format. Example: `startTime=2019-01-01T00:00:00Z`
`endTime`	string	Timestamp of the most recent measurement desired. If provided, all measurements with time later than endTime will be filtered out. Date string is expected to be in ISO 8601 format. Default: UTC current time. Example: `endTime=2019-01-02T00:00:00Z`
`skip`	integer	The number of records to skip. Default: 0
`limit`	integer	The maximum number of measurements to be returned. Default: 500 Min: 1 Max: 3,000 Example: `limit=100`

Response

Example 200 Response

[
    {
        "_id": "5d82a14163070f050fdf08d1",
        "nodeStatus": {
            "inputPowerStatus": {
                "errorCode": 0,
                "current": 77,
                "voltage": 5.248760223388672
            },
            "chargingStatus": {
                "status": 0
            },
            "switchingIcStatus": {
                "isRegulated": true
            },
            "ec2xStatus": {
                "signalQuality": 31
            },
            "lastStateRevision": 0
        },
        "specNo2Reading": {
            "errorCode": 0,
            "vGas": 1022.7490234375,
            "no2Conc": 6.872159004211426,
            "vRef": 2047.62109375,
            "vTemperature": 1279.046875
        },
        "shtReading": {
            "errorCode": 0,
            "temperature": 35.598533630371094,
            "relHumidity": 41.960784912109375
        },
        "recId": "A0000001|48434",
        "ptPmsReading": {
            "errorCode": 0,
            "pm1MassConc": 0,
            "pm1NumConc": 0.20000000298023224,
            "pm2_5MassConc": 0,
            "pm2_5NumConc": 0.20000000298023224,
            "pm10MassConc": 0.9411764740943909,
            "pm10NumConc": 0.21882355213165283
        },
        "analog420Ch1Reading": {
            "errorCode": 0,
            "current": 15.87596321105957
        },
        "receivedAt": "2019-09-18T21:27:29.947Z",
        "deviceCode": "A0000001"
    }
]