ReGENESIS verfügt über eine Programmierschnittstelle, die dynamisch Daten aus den verschiednenen Statistiken als JSON zur Verfügung stellt. Die Schnittstelle unterstützt das Filtern und Gruppieren der Daten nach allen enthaltenen Attributen. So können aus einer Tabelle etwa alle Werte eines bestimmten Jahres gefiltert, und dann nach Kreis aggregiert werden.
Daten aus der ReGENESIS-API können in interaktiven Visualisierungen genutzt werden, sodass diese stets aktuelle Werte ausweisen. Die Ergebnisse der API werden gecached, um eventuelle Lastspitzen durch eine Verlinkung auf vielbesuchten Seiten abzufangen.
Die ReGENESIS-API basiert auf dem freien Softwarepaket Cubes, einer Komponente der DataBrewery.
Die vollständige Dokumentation der HTTP-API von Cubes ist auf der Webseite des Projekts verfügbar.
Falls Sie die API von ReGENESIS in Ihren Projekten nutzen, dann teilen Sie uns das gerne mit! Wir würden gerne erfahren, wie und wofür dieses Angebot genutzt wird.
friedrich@pudo.org
Zur Nutzung der API können die Endpunkte genutzt werden, die auf den Infoseiten zu einzelnen Statistiken verfügbar sind. Neben der Dokumentation der HTTP-API hier einige Beispiele, die auf der Insolvenzstatistik (52411) basieren. Alle verfügbaren Attribute und Messwerte sind auf der Infoseitezur Statistik ausgewiesen. Die URL des Endpunkts ist:
http://api.regenesis.pudo.org/cube/52411kj002/aggregate
Ruft man ihn direkt auf, so erhält man eine JSON-Antwort mit einem
summary-Objekt. Dieses weist die Summe aller Insolvenzen
(isv001_sum) und die Gesamtzahl der Datenzeilen (15702)
aus.
Mit dem cut-Parameter können die Einträge gefiltert werden.
Die Insolvenzstatistik verfügt über ein jahr-Attribut,
welches mit dem folgenden Query auf das Jahr 2011 eingegrenzt werden kann:
.../aggregate?cut=jahr.text:2011
Neben dem jahr können wir auch andere Attribute filtern,
etwa die Art des Verfahrens (Attribut isvat3):
.../aggregate?cut=jahr.text:2011|isvat1.name:isvart01
Das summary-Objekt in der Antwort weist nun nur noch 413
Zeilen aus: eine Insolvenzstatistik für jeden Kreis. Zur Darstellung,
z.B. auf einer Karte, wollen wir diese Kreise einzeln ausgewiesen haben.
Dazu ist der drilldown-Parameter geeignet:
.../aggregate?cut=jahr.text:2011|isvat1.name:isvart01
&drilldown=kreise
Die Antwort enthält nun neben der summary ein cells-Objekt, in
dem für jeden Kreis dessen Name, AGZ und die Zahl der eröffneten Insolvenzverfahren
ausgewiesen ist.
Neben den hier vorgestellten Optionen können auch Paginierung und Sortierung beeinflusst werden. Mehr Informationen dazu enthält die Dokumentation.