Monitoring-Methoden

API-Dokumentation der SISTRIX Toolbox

monitoring.projects

Liefert einen Überblick über alle verfügbaren Projekte inklusive der benötigen Projekt-ID zurück. Übergeben werden muss einzig der API-Key - es werden alle Projekte, die mit dem Account verbunden sind, aufgelistet

Benötigte Parameter: api_key

http://api.sistrix.net/monitoring.projects?api_key=$key

monitoring.folders

Mit dieser Methode werden alle Ordner eines Projektes aufgelistet. Liefert den Ordnernamen, die Ordner-ID sowie die ID des übergeordneten Ordners (so vorhanden). Neben dem API-Key muss die Projekt-ID aus der Methode ?monitoring.projects? übergeben werden.

Benötigte Parameter: api_key, project

http://api.sistrix.net/monitoring.folders?api_key=$key&project=$project

monitoring.folder

Diese Methode (Singular) liefert die in einem Ordner angelegten Abfragen zurück. Zurückgegeben werden Name der Abfrage, Abfrage-ID, Typ der Abfrage sowie ID des Ordners. Übergeben werden müssen Projekt-ID und Ordner-ID.

Benötigte Parameter: api_key, project, folder

http://api.sistrix.net/monitoring.folder?api_key=$key&project=$project&folder=$filder

monitoring.check

Durch diese Methode werden alle Informationen, die im Zusammenhang mit einzelnen Abfragen stehen, ausgegeben. Als Parameter werden die Projekt-ID, die Ordner-ID sowie die Abfrage-ID erwarter. Optional kann noch der Parameter ?history=true? angegeben werden. Mit diesem werden nicht nur die aktuellen Daten, sondern alle vorliegenden, historischen Informationen zu dieser Abfrage ausgegeben. Da hier in der Regel viele Daten anfallen, von der Option bitte nicht als Standard Gebraucht machen.

Benötigte Parameter: api_key, project, folder, check
Optionale Parameter: history

http://api.sistrix.net/monitoring.check?api_key=$key&project=$project&folder=$filder&check=$check&history=true

monitoring.reports

Liefert alle mit einem Projekt verknüpften Reports zurück. Als Parameter wird die Projekt-ID benötigt. Zurückgegeben werden Report-Name sowie Report-ID. Die ID ist zum Abfragen des jeweiligen Reports über die Methode ?monitoring.report? (Singular) nötig.

Benötigte Parameter: api_key, project

http://api.sistrix.net/monitoring.reports?api_key=$key&project=$project

monitoring.report

Durch diese Methode werden Informationen für einen Report angezeigt. Übergeben werden müssen die Projekt-ID sowie die Report-ID. Die Rückgabe der Funktion besteht auf dem Reportnamen, der Report-ID, der Frequenz, in der dieser Report versendet wird (?daily?, ?weekly? und ?monthly?), dem Format des Report (?pdf? oder ?xls?), einer Auflistung der Reportempfänger (mit Hinweis, ob der Empfänger ein Toolbox-Account oder eine E-Mail-Adresse ist) sowie der Liste aller in der Vergangenheit erstellen Reports mit dem jeweiligen Datum.

Benötigte Parameter: api_key, project, report

http://api.sistrix.net/monitoring.report?api_key=$key&project=$project&report=$report

monitoring.report.download

Diese Methode erlaubt den Download von Reports aus dem Archiv. Als Parameter werden Projekt-ID, Report-ID sowie das Report-Datum benötigt. Dieses ist aus der Auflistung vorhandener Reports durch die Methode ?monitoring.report? ermittelbar. Achtung: Diese Methode liefert kein XML zurück, sondern den archivierten Report als PDF oder XLS-Datei.

Benötigte Parameter: api_key, project, report, date

http://api.sistrix.net/monitoring.report.download?api_key=$key&project=$project&report=$report&date=2010-03-13T00%3A00%3A00%2B01%3A00
de
de