✨ Improvements

Properties active and started have been added to the segment object to the /devices and /locations endpoints. The active field is used to distinguish between devices that are currently paired to an account and devices that have been unpaired and removed from the account, but still have historical measurements.

The segment object now has the following structure:

{
  "id": "91f7fc45-8006-4279-9b0a-fa8b812020fa",
  "name": "My device name",
  "started": "2020-08-07T06:53:04",
  "active": true
}

🚀 Feature Release

Two endpoints have been added for fetching full history of samples for mold values:

• /devices/{serialNumber}/mold-samples
• /segments/{segmentId}/mold-samples

This is considered a beta feature, and it might change in the future.

🚀 Feature Release

The webhooks will now receive an event when a new mold risk indicator value is calculated. The event type will be airthings-webhook-cloudevent-virtual-sample-feed for these samples.

✨ Improvements

• Mold sensor values has been added to /latest-samples for devices and locations.

✨ Improvements

• Samples in the API now also returns light data.

📝 Documentation

• The website has been updated with swagger documentation, the swagger was previously hosted in accounts.airthings.com. It can now be found here: API documentation.

✨ Improvements

• A correction has been made to the samples API to provide appropriate rounding, i.e. rounding in-line with the precision of the sensors.
• Pressure sensor unit has been updated to return hPA instead of Pa.

✨ Improvements

Setting up API clients has been moved from accounts.airthings.com to dashboard.airthings.com/integrations and is now part of the Airthings for Business dashboard. This can be accessed for all business users. If you are not yet an Airthings for Business user and want access, please reach out to Airthings for Business Support.

✨Improvement

Setting up Webhooks has been moved from accounts.airthings.com to dashboard.airthings.com/integrations and is now part of the Airthings for Business dashboard. This can be accessed for all business users. If you are not yet an Airthings for Business user and want access, please reach out to Airthings for Business Support.

💥 Breaking Change

Graduating Airthings REST API from Beta

Over the last few months we have been iterating the Airthings REST API together with our passionate early users. We have received a lot of valuable feedback and implemented updates accordingly.

With this release we are graduating the Airthings REST API from Beta. The motivation for the changes in this update is to improve consistency and usability of the API. We do not foresee any more breaking changes, and potential future breaking changes will result in a version update of the API.

The Swagger documentation has been updated to reflect these changes. Play with the new version, and download it here. (API documentation will be updated as well).

The API will be updated on 2019-11-25.

We hope that the changes do not cause you any inconvenience. Please reach out to Airthings for Business Support for any clarifications or with any questions.

✨ Improvements

Planned changes (swagger-diff):

• new endpoints for getting location and latest sample of all devices in a location
  • get /locations/{}
  • get /locations/{}/latest-samples
• new response attributes
  • get /devices
    • new attribute in response: segment/id (in: body, type: string)
    • new attribute in response: segment/name (in: body, type: string)
    • new attribute in response: location/id (in: body, type: string)
    • new attribute in response: location/name (in: body, type: string)
  • get /devices/{}
    • new attribute in response: segment/id (in: body, type: string)
    • new attribute in response: segment/name (in: body, type: string)
    • new attribute in response: location/id (in: body, type: string)
    • new attribute in response: location/name (in: body, type: string)
  • get /locations
    • new attribute from response: locations[]/name (in: body, type: string). This replaces removed attribute locations[]/locationName
  • get /segments
    • new attribute in response: segments[]/deviceId (in: body, type: string). This replaces removed attribute segments[]/serialNumber
    • new attribute in response: location/id (in: body, type: string)
    • new attribute in response: location/name (in: body, type: string)

Example GET /segments endpoint:

• locationName is replaced by an object.
• serialNumber is deviceId.

The old vs. new response from the GET /segments endpoint:

{
  "segments": [
    {
        "id": "f3f247b7-829b-427e-8add-b9d58e94ba75",
        "started": "2032-02-05T23:57:12Z",
        "ended": "2019-07-23T10:05:45Z",
        "name": "Bedroom",
        "locationId": "3cc69a8b-5b51-416f-8e01-31ccc7fbda9b",
        "serialNumber": "2930999999"
    }
  ]
}

{
  "segments": [
    {
        "id": "f3f247b7-829b-427e-8add-b9d58e94ba75",
        "started": "2032-02-05T23:57:12Z",
        "ended": "2019-07-23T10:05:45Z",
        "name": "Bedroom",
        "location": {
            "id": "3cc69a8b-5b51-416f-8e01-31ccc7fbda9b",
            "name": "Home"
        },
        "deviceId": "2930999999"
    }
  ]
}

Example GET /locations endpoint:
The old vs. new response from GET /locations:

{
  "locations": [
    {
      "id": "b4e8231b-672f-4e75-b7f0-04ccbd499508",
      "locationName": "Drammensveien 288"
    }
  ]
}

{
  "locations": [
    {
      "id": "b4e8231b-672f-4e75-b7f0-04ccbd499508",
      "name": "Drammensveien 288"
    }
  ]
}

📝 Documentation

The developer documentation has been updated with tutorials on how to use the Airthings API. This includes two guides on how to fetch your Airthings data using either python or node.js and a guide for setting up an automatic SMS messaging service by combining Twillio and Airthings webhooks. The former two guides will help you register your application and provide a starting point for developing an Airthings integrated solution, whereas the latter guide can be utilized to send SMS notifications in the case a threshold value is breached, such as high radon levels or high temperatures.