API – Dokumentation

Schnellstart

Unsere API ist eine REST API. Die Rückgabewerte sind String enkodiert.

https://api.everyonecounts.de/influxdbquery?measurement=webcam&startTime=2020-05-01&endTime=2020-06-01&output_format=json

Den Access Token im Header Key: „x-api-key“ übergeben.

Zugriff kann mit Hilfe von API Keys erhalten werden, welche nach Anfrage an kontakt@everyonecounts.de erhalten werden können.

Zugriffspunkt

https://api.everyonecounts.de/influxdbquery

Authentifizierung

Zur Authentifizierung muss beim Request an die API der Header: „x-api-key“ mit übergeben werden. Der Wert des Header Keys ist der Token, den Sie von uns bekommen. Wenn Sie noch keinen Token haben, schreiben Sie uns eine Mail an kontakt@everyonecouts.de.

Parameter

Mögliche Parameter können in der nachfolgenden Liste gefunden werden:

ParameterBeschreibungBeispiele
measurementDie gewünschte Datenquelle‚webcam-customvision‘, ‚airquality‘, ‚bikes‘
startTimeUntere Datumsgrenze„2020-05-01″,“2020-06-15T15:21:13.164893“
endTimeObere Datumsgrenze
output_formatAusgabeformatjson, csv

Rückgabewerte

Der Body der Response aus dem Request, ist ein Json als String encodiert.

Ein Rückgabewert kann wie folgt aussehen:

‚{

‚0‘:   {

index‚: 0,                                                   : Datensatzindex

_time‚: 1593329520000,                          : Zeitstempel im UNIX Format

_value‚: 5.0,                                              : Gemessener Wert

_field‚: ‚personenzahl‘,                             : Beschreibung des Messwertes

_id‚: ‚8_8421‘,                                           : ID

_measurement‚: ‚webcam‘,                     : Messwertgruppe

ags‚: ‚8421‘,                                               : Allgemeiner Gemeindeschlüssel

bundesland‚: ‚Baden-Württemberg‘,      : Bundesland

districtType‚: ‚Stadtkreis‘,                        : Art des Distrikts

landkreis‚: ‚Ulm‘,                                      : Landkreis

name‚: ‚Ulm Olgastrasse‘,                        : Benennung

origin‚: ‚https://… ‚                                   : Quellenangabe

},

‚1‘:   { … }

}‘

Stand: 07/2020