#
Daten auslesen
Mit Ihrem KliServ-IoT API-Key können Sie Daten von Geräten auslesen, die Sie auch in Dashboard sehen können.
Ihr API-Key muss die entsprechende Berechtigung aufweisen.
Der API-Endpoint ist: https://my-instance.kliserv-iot.com/api/v1/device/data
Die HTTP-Methode ist: GET
Ihren API-Key geben Sie im Header im Feld: Authorization:
an.
Als Parameter müssen die folgenden angegeben werden:
serialNumber
: Ist die Seriennummer des Gerätes, dessen Daten Sie auslesen möchten.filterProfile
: Ist das FIlter-Profil, von welchem Zeitraum Sie die Daten auslesen möchten.
Verfügbare Profile sind:
-lastHour
-> Alle Daten der letzten Stunde.
-past24hours
-> Alle Daten der letzten 24 Stunden.
-past48hours
-> Alle Daten der letzten 48 Stunden.
-custom
-> Damit können Sie selbst einen Zeitraum über die ParameterfromTimeUTC
unduntilTimeUTC
definieren.
Nur nötig, wenn"filterProfile" = "custom"
:fromTimeUTC
: Ist der UTC Zeitstempel, ab wann Daten ausgelesen werden sollen. Folgendes Format muss verwendet werden: ISO 8601untilTimeUTC
: Ist der UTC Zeitstempel, bis wann Daten ausgelesen werden sollen. Folgendes Format muss verwendet werden: ISO 8601
Der Server gibt ein JSON objekt zurück, wobei der Parameter success
true/false
sein kann, je nachdem, ob der Request erfolgreich war.
Der Parameter data beinhaltet die eigentlichen Daten, wobei die Parameter von Gerät zu gerät variieren, je nach dem, was das Gerät für Daten sendet.
In diesem Variablen Parameter befindet sich dann eine Liste mit den eigentlichen Daten. Dabei beinhaltet value
den Wert und timeStamp
den Zeitpunkt, zudem der Messwert bei KliServ-IoT eingegangen ist.
{"success": true, "data": {"state": [{"value": "ON", "timeStamp": "2023-08-10T13:46:09.641032+00:00"}, {"value": "ON", "timeStamp": "2023-08-10T13:46:10.543324+00:00"}]}}