Überblick
Die Statistics API gibt eine Liste deiner Service Level Agreement (SLA)-Metriken und allgemeine Monitoring-Informationen für jede Prüfung des Prüfobjekts wieder. Diese API spiegelt einige Daten wider, wie sie auch in der Kachel Einfache Daten Liste oder Diagramm zu sehen sind.
Einsatzbereich:
Nutze die Statistics API, um Daten wie SLA-Ziel, Ausfallzeiten, Verfügbarkeit in Prozent und Anzahl an Alarmen, Fehlern und Prüfungen des Prüfobjekts zu erhalten.
Voraussetzungen
Bevor du die Statistics API nutzt, achte darauf, dass du über Folgendes verfügst:
- Uptrends API-Anmeldedaten
- Verständnis über deine SLA-Anforderungen und die Prüfobjektkonfiguration.
Statistics API-Endpunkte
Die Statistics API stellt die folgenden Endpunkte bereit:
| Methode | Endpunkt | Beschreibung |
|---|---|---|
GET |
/Statistics/Monitor/{monitorGuid} |
Rufe eine Liste aller SLA-Metriken und allgemeinen Informationen deines Prüfobjekts ab. |
GET |
/Statistics/MonitorGroup/{monitorGroupGuid} |
Rufe eine Liste aller SLA-Metriken und allgemeinen Informationen der Prüfobjektgruppe ab. |
Mehr Informationen zu den Abfrage- und Antwortformaten und zu interaktiven API-Tests findest du in der Uptrends Statistics API-Dokumentation.
Statistics API-Antwort
{
"Data": [
{
"Id": "10/13/2025 8:00:00 PM",
"Type": "Statistics",
"Attributes": {
"StartDateTime": "2025-10-13T20:00:00",
"EndDateTime": "2025-10-13T21:00:00",
"Alerts": 0,
"OperatorResponseTarget": 15,
"OperatorResponseTime": 0,
"DowntimePercentage": 0,
"UptimePercentage": 100,
"Checks": 62,
"ConfirmedErrors": 0,
"UnconfirmedErrors": 0,
"Uptime": 3590,
"Downtime": 0,
"TotalTime": 0.727,
"ResolveTime": 0.106,
"ConnectionTime": 0.092,
"DownloadTime": 0.527,
"TotalBytes": 5699
},
"Relationships": [
{
"Id": "6f426452-5d2b-4fdf-84e2-c2b3d7ebf918",
"Type": "Monitor",
"Links": {
"Self": "/Monitor/6f426452-5d2b-4fdf-84e2-c2b3d7ebf918"
}
}
]
},
{
"Id": "10/13/2025 9:00:00 PM",
"Type": "Statistics",
"Attributes": {
"StartDateTime": "2025-10-13T21:00:00",
"EndDateTime": "2025-10-13T22:00:00",
"Alerts": 10,
"OperatorResponseTarget": 15,
"OperatorResponseTime": 0,
"DowntimePercentage": 0,
"UptimePercentage": 100,
"Checks": 62,
"ConfirmedErrors": 0,
"UnconfirmedErrors": 0,
"Uptime": 3601,
"Downtime": 0,
"TotalTime": 0.7,
"ResolveTime": 0.089,
"ConnectionTime": 0.097,
"DownloadTime": 0.513,
"TotalBytes": 5699
},
"Relationships": [
{
"Id": "6f426452-5d2b-4fdf-84e2-c2b3d7ebf918",
"Type": "Monitor",
"Links": {
"Self": "/Monitor/6f426452-5d2b-4fdf-84e2-c2b3d7ebf918"
}
}
]
}
...
]
}
API-Parameter
Verwende die folgenden Parameter, um die Informationen aus deiner API-Antwort zu filtern:
| Feldname | Beschreibung |
|---|---|
monitorGuid |
Die einzigartige Kennung des Prüfobjekts. |
monitorGroupGuid |
Die einzigartige Kennung der Prüfobjektgruppe. |
Filter |
Eine Zeichenkette, mithilfe derer du nach bestimmten Informationen in der API-Antwort suchen kannst. Du kannst ein oder mehr Statistics API-Felder als Filterwerte verwenden. Zum Beispiel
Alerts oder Alerts, UptimePercentage. |
Start |
Ein benutzerdefinierter Datumsparameter im Format YYYY-MM-DDTHH:MM:SS (zum Beispiel 2025-01-20T08:00:00) zusammen mit dem End-Parameter, um das Startdatum für die API-Antwort anzugeben. Dieser Parameter kann nicht zugleich mit PresetPeriod verwendet werden. |
End |
Ein benutzerdefinierter Datumsparameter im Format YYYY-MM-DDTHH:MM:SS (zum Beispiel 2025-01-20T16:00:00) zusammen mit dem Start-Parameter, um das Enddatum für die abgerufenen statistischen Aufzeichnungen anzugeben. Dieser Parameter kann nicht zugleich mit PresetPeriod verwendet werden. |
PresetPeriod |
Eine Liste von Zeiträumen, um nach Daten für einen bestimmten Zeitraum zu filtern. Dies kann nicht gleichzeitig mit den Parametern Start und End verwendet werden. Der Standardwert ist Last24Hours. Eine detaillierte Erläuterung findest du unter
PresetPeriod. |
Statistics API-Felder
Die Statistics API enthält verschiedene API-Felder:
| Feldname | Beschreibung |
|---|---|
Id |
Der Zeitstempel, der den Beginn jedes Datenintervalls in der Antwort markiert. Wird die Standard-PresetPeriod von Last24Hours genutzt, werden die Daten in 1-Stunden-Intervallen gruppiert. |
Type |
Der Datentyp, der in der Antwort angezeigt wird. Der Standardwert ist Statistics. |
Attributes |
Enthält SLA-Metriken und allgemeine Monitoring-Daten wie Verfügbarkeit, Ausfallzeiten, Alarme und Antwortzeiten. Weitere Informationen findest du im Abschnitt zum Attributes-Feld.
|
Relationships |
Definiert, wie die aktuellen Daten mit anderen Daten verknüpft oder verbunden sind. Dadurch können Verweise zu zugehörigen Ressourcen identifiziert werden. Weitere Informationen findest du unter Relationships. |
Attributes API-Felder
Das Attributes API-Feld enthält:
| Feldname | Beschreibung |
|---|---|
StartDateTime |
Bezieht sich auf Datum und Uhrzeit, wann das Prüfintervall des Prüfobjekts beginnt. |
EndDateTime |
Bezieht sich auf Datum und Uhrzeit, wann das Prüfintervall des Prüfobjekts endet. |
Alerts |
Die Anzahl Alarme, die aufgrund bestätigter Fehler während des Prüfintervalls des Prüfobjekts ausgelöst werden.
|
OperatorResponseTarget |
Die SLA-Ziel Operator-Reaktionszeit in Minuten. Dies ist die maximal erlaubte Zeit, die ein Operator brauchen darf, um den Fehler in Uptrends zu bestätigen. |
OperatorResponseTime |
Die SLA-Operator-Reaktionszeit in Minuten. Dies ist die tatsächliche Zeit, die ein Operator benötigte, um den Fehler in Uptrends zu bestätigen. |
DowntimePercentage |
Die SLA-Ausfallzeit in Prozent. Dies ist die Gesamtzeit, in der die Website oder der Webservice nicht verfügbar waren. |
UptimePercentage |
Die SLA-Verfügbarkeit in Prozent. Dies ist die Gesamtzeit, in der die Website oder der Webservice verfügbar waren. |
Checks |
Die Anzahl Prüfungen des Prüfobjekts innerhalb des Prüfintervalls von StartDateTime bis EndDateTime. |
ConfirmedErrors |
Die Anzahl bestätigter Fehler.
|
UnconfirmedErrors |
Die Anzahl Fehler, die berichtet, aber nicht verifiziert wurden. |
Uptime |
Die Gesamtzeit, die deine Website verfügbar war, gemessen in Minuten. |
Downtime |
Die Gesamtzeit, die deine Website nicht verfügbar, gemessen in Minuten. |
TotalTime |
Die Gesamtzeit, die benötigt wurde, um die Prüfung abzuschließen, gemessen in Sekunden. |
ResolveTime |
Die Zeit, die es dauerte, bis der Domainname oder die URL in die zugehörende IP-Adresse umgewandelt wurden, gemessen in Sekunden. |
ConnectionTime |
Die Zeit, die benötigt wurde, mit der IP-Adresse deiner Website oder des Servers zu verbinden, gemessen in Sekunden. |
DownloadTime |
Die Zeit, die der Download von Inhalt dauert, nachdem eine Verbindung zu deiner Webseite oder deinem Server hergestellt wurde, gemessen in Sekunden. |
TotalBytes |
Die Gesamtmenge an Daten, in Bytes, die von deiner Seite während des Prüfintervalls abgerufen wurde. |
Fehlerbehebung
Dieser Abschnitt behandelt übliche HTTP-Fehler und Schritte zur Fehlerbehebung bei der Statistics API.
Übliche Fehler
Übliche HTTP-Statuscodes und ihre Beschreibungen:
| Statuscode | Beschreibung |
|---|---|
| 200 | OK – Abfrage erfolgreich. |
| 400 | Ungültige Abfrage – ungültige Abfrageparameter oder fehlende erforderliche Felder. |
| 401 | Nicht autorisiert – ungültige oder fehlende Authentifizierungsdaten. |
| 403 | Verboten – Erlaubnis verweigert. |
| 404 | Nicht gefunden – die angegebene GUID existiert nicht. |
| 500 | Interner Serverfehler – ein serverseitiger Fehler ist aufgetreten. |
Leitfaden zur allgemeinen Fehlerbehebung
Stelle sicher, dass:
- du immer deine Abfragedaten validierst, bevor du einen API-Aufruf sendest.
- du die entsprechenden HTTP-Methoden für jede Operation verwendest.
Solltest du weitere Hilfe benötigen, wende dich bitte an unser Support-Team.
Verwandte Artikel
Weitere Informationen findest du in den folgenden Artikeln:
- Uptrends Statistics API-Dokumentation – eine interaktive API-Dokumentation mit detaillierten Endpunktspezifikationen.
- API-Changelog – mit den neuesten API-Nachrichten und Hinweisen zu nicht fortgeführten Versionen und Endpunkten.