Überblick
Die Status API gibt Informationen zum Prüfobjektstatus aus, damit Prüfobjektfehler und die Ursachen identifiziert werden können. Diese API spiegelt Daten wider, wie sie in der Dashboard-Kachel Details der letzten Überwachung zu sehen sind.
Einsatzbereich
Nutze die Status API, um Daten wie Prüfzeiten des Prüfobjekts, Fehlerlevel, Fehlerbeschreibung und Checkpoint-Informationen zu erhalten.
Voraussetzungen
Bevor du die Status API nutzt, achte darauf, dass du über Folgendes verfügst:
- Uptrends API-Anmeldedaten
- Entsprechende Prüfobjektberechtigungen
- Ein grundlegendes Verständnis deiner Prüfobjekteinstellungen
Status API-Endpunkte
Die Status API stellt die folgenden Endpunkte bereit:
| Methode | Endpunkt | Beschreibung |
|---|---|---|
GET |
/Status/Monitor/{monitorGuid} |
Rufe Statusinformationen für ein bestimmtes Prüfobjekt ab. |
GET |
/Status/MonitorGroup/{monitorGroupGuid} |
Rufe Statusinformationen für alle Prüfobjekte einer Prüfobjektgruppe ab. |
Mehr Informationen zu den Abfrage- und Antwortformaten und zu interaktiven API-Tests findest du in der Uptrends Status API-Dokumentation.
Status API-Antwort
Beispielantwort mit dem Status eines Prüfobjekts, bei dem ein Fehler bestätigt wurde:
{
"Data": {
"Id": "ef42495b-26cb-4a2f-8cfc-c933f9716d22",
"Type": "MonitorStatus",
"Attributes": {
"ErrorLevel": "Confirmed",
"LastCheck": "2025-10-15T19:03:52",
"CheckpointId": 212,
"CheckpointName": "Rende",
"ErrorDescription": "HTTP status 200, while 401 expected",
"UptimePercentage": 0,
"ErrorCode": 3040,
"LastMonitorCheckId": 195710454309,
"TotalTime": 377
},
"Relationships": [
{
"Id": "ef42495b-26cb-4a2f-8cfc-c933f9716d22",
"Type": "Monitor",
"Links": {
"Self": "/Monitor/ef42495b-26cb-4a2f-8cfc-c933f9716d22"
}
},
{
"Id": 195710454309,
"Type": "MonitorCheck",
"Links": {
"Self": "/MonitorCheck/195710454309"
}
},
{
"Id": 212,
"Type": "Checkpoint",
"Links": {
"Self": "/Checkpoint/212"
}
}
]
}
}
API-Parameter
Verwende die folgenden Parameter, um die Informationen deiner API-Antwort zu filtern:
| Feldname | Beschreibung |
|---|---|
monitorGuid |
Die einzigartige Kennung des Prüfobjekts. |
monitorGroupGuid |
Die einzigartige Kennung der Prüfobjektgruppe. |
Status API-Felder
Die Status API enthält verschiedene API-Felder:
| Feldname | Beschreibung |
|---|---|
Id |
Die monitorGuid. |
Type |
Der Datentyp, der in der Antwort angezeigt wird. Der Standardwert lautet MonitorStatus. |
Attributes |
Enthält die allgemeinen Prüfobjektcheck- und Checkpoint-Informationen wie Fehlerlevel und Beschreibung, Gesamtzeit und Checkpoint-Standort. Weitere Informationen findest du im Abschnitt zum Attributes-Feld.
|
Relationships |
Definiert, wie die aktuellen Daten mit anderen Daten verknüpft sind oder zu diesen in Beziehung stehen. Es sind Informationen enthalten, wie du auf bestimmte Ressourcen in einem API-Aufruf auf ein Prüfobjekt, Prüfobjektcheck und Checkpoint-Standort verweisen kannst. Weitere Informationen findest du unter Relationships.
|
Attributes API-Felder
Das Attributes API-Feld enthält:
| Feldname | Beschreibung |
|---|---|
ErrorLevel |
Der Schweregrad des Fehlers. Mögliche Werte sind:
|
LastCheck |
Datum und Uhrzeit, wann das Prüfobjekt zuletzt ausgeführt wurde. |
CheckpointId |
Einzigartige Kennung des Checkpoint-Standorts. Weitere Informationen zu verfügbaren Checkpoints findest du unter Checkpoint-Informationen oder nutze die Checkpoint API.
|
CheckpointName |
Der Name des Checkpoints, bei dem der Prüfobjektcheck ausgeführt wurde. |
ErrorDescription |
Die Beschreibung des Fehlers, der während des Prüfobjektchecks erkannt wurde. |
UptimePercentage |
Zeit in Prozent, in der die Website oder der Webservice verfügbar und betriebsbereit waren. Weitere Informationen findest du unter Berechnen der Verfügbarkeitsrate.
|
ErrorCode |
Der numerische Code entsprechend der Fehlerbeschreibung.
|
LastMonitorCheckId |
Die einzigartige Kennung des neuesten Prüfobjektchecks. |
TotalTime |
Die Gesamtzeit, die gebraucht wurde, um ein Prüfobjektcheck vollständig auszuführen, gemessen in Millisekunden.
|
Fehlerbehebung
Dieser Abschnitt behandelt übliche HTTP-Fehler und Schritte zur Fehlerbehebung bei der Status 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 Status 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.