API: Get live CO2 concentration data points

One of the most popular use case is the data collect from a BOS. Let's see here how third parties can query the BOS graph database to get real-time information.

Let's assume that you know nothing about the building content and didn't explore available assets. You just want to get real-time CO2 concentration data points.

Ok, let's analyze this:

• You want real-time points, then v1/Operate/points is the query you need
• You're looking at CO2 concentration meaning:
  • It's a Measure (see Linksper data models) → pointType=Measure
  • It's a Concentration → dimension=Concentration
  • You specifically ask for CO2 (not N02, TVOC...). If you check on the Point data model, you will find that the dimension Concentration is used with the qualifier: concentrationType → concentrationType='CO2'
• The v1/Opeate/points takes a query as parameter.
  • The query uses a syntax called NEQL (Niagara Entity Query Language) is based on the semantics
  • The query parameter will look like pointType='Measure' and dimension='Concentration' and concentrationType='CO2'

Let's summarize the query:

GET {{base-api-url}}/v1/operate/points?query=pointType='Measure' and dimension='Concentration' and concentrationType='CO2'

And see the result:

You want to learn more about each data points? You can ask for additional fields such as "allTags":

You can apply the same principle to any type of data point, any dimension etc. For more information on some possible combinations see Point Data Model combinations