Skip to content

Web API for Data Retrieval

Mario Frei edited this page Mar 9, 2020 · 3 revisions

The measurement data can be access through a web-interface:

http://www.[YOUR URL.COM]/export.export.php?node_id=[YOUR NODE ID]&token=[YOUR TOKEN]&campaign_name=[YOUR CAMPAIGN NAME]&campaign_description=[YOUR CAMPAIGN DESCRIPTION]&date_start=[YOUR START DATE]&date_end=[YOUR END DATE]

[YOUR NODE ID] is a single node ID (e.g. '801') or a comma-separated list of node IDs (e.g. '801,802,805'). If a campaign name ([YOUR CAMPAIGN NAME]) is provided, [YOUR NODE ID] can be set to 'all'. In that case, all node IDs registered to a campaign name will be retrieved. The output data is json-formatted.

Example:

Node ID: 801
Sensor Description: SHT31
Measured Entities: Air Temperature (indoor), Relative Humidity (indoor)
Measurement Units: °C, %
Sensor Module Type: 2
Number of Values: 2
Campaign Name: "Measurement Campaign Winter 18/19"
Campaign Description: "Building 3"
Measurement Timestamps: 1583780593, 1583780294, 1583779393 (UNIX Timestamps)
Measured Temperatures: 21.7609, 21.8757, :21.7742
Measured Humidities: 51.0765, 50.7057, 48.9708

Node ID: 805
Sensor Description: Heat flux
Measured Entities: Heat Flux
Measurement Units: W/m2
Sensor Module Type: 7
Number of Values: 1
Campaign Name: "Measurement Campaign Winter 18/19"
Campaign Description: "Building 3"
Measurement Timestamps: 1583780845, 1583780545, 1583780245 (UNIX Timestamps)
Measured Heat Flux: 23.8, 27.5, 28.9

JSON Formated Data:

[
   [
      [
         {
            "node_id":801,
            "units":[
               "\u00b0C",
               "%"
            ],
            "description":[
               "SHT31"
            ],
            "entities":[
               "air temperature (indoor)",
               "relative humidity (indoor)"
            ],
            "sensorModuleType":2,
            "number_of_values":2,
            "campaign_name":"Measurement Campaign Winter 18/19",
            "campaign_description":"Building 3"
         }
      ],
      [
         {
            "date":1583780593,
            "value":21.7609
         },
         {
            "date":1583780294,
            "value":21.8757
         },
         {
            "date":1583779393,
            "value":21.7742
         }
      ],
      [
         {
            "date":1583780593,
            "value":51.0765
         },
         {
            "date":1583780294,
            "value":50.7057
         },
         {
            "date":1583779393,
            "value":48.9708
         }
      ]
   ],
   [
      [
         {
            "node_id":805,
            "units":[
               "W\/m2"
            ],
            "description":[
               "Heat flux"
            ],
            "entities":[
               "heat flux"
            ],
            "sensorModuleType":7,
            "number_of_values":1,
            "campaign_name":"Measurement Campaign Winter 18/19",
            "campaign_description":"Building 3"
         }
      ],
      [
         {
            "date":1583780845,
            "value":23.8
         },
         {
            "date":1583780545,
            "value":27.5
         },
         {
            "date":1583780245,
            "value":28.9
         }
      ]
   ]
]