MonitorCheck API

Überblick

Uptrends stellt verschieden Prüfobjekttypen bereit, darunter Verfügbarkeits-, Browser- (Full Pagecheck) und Multi-Step API-Prüfobjekte, um die Verfügbarkeit und Performance deiner Websites zu überwachen. Jedes Mal, wenn ein Prüfobjekt ausgeführt wird, erzeugt es eine Prüfobjekt-Prüfung.

Eine Prüfung enthält Prüfobjektmessungen einschließlich Fehlerbeschreibungen, Auflösungszeit und weitere Metriken, die den Status und das Verhalten deiner Website oder deines Service widerspiegeln.

Voraussetzungen

Bevor du die MonitorCheck API nutzt, achte darauf, dass du über Folgendes verfügst:

• Uptrends API-Anmeldedaten
• Ein grundlegendes Verständnis der Prüfobjekttypen und ihren Konfigurationen
• Ein grundlegendes Verständnis der Prüfobjektergebnisse

MonitorCheck-API-Endpunkte

Wenn du eine Liste von Prüfobjekt-Prüfdaten abrufst, enthält jeder Eintrag die grundlegenden Werte für diese Prüfung. Abhängig vom Prüfobjekttyp können jedoch auch detailliertere Daten über zusätzliche GET-Abfragen verfügbar sein. Existiert eine zugehörige Ressource für eine Prüfung, erscheint sie im Relationships-Array: Jedes Element enthält Links.Self, den aufzurufenden Pfad, um das Detail abzurufen (zum Beispiel /MonitorCheck/{monitorCheckId}/MultiStepAPI).

Informationen zu Schemata und zu interaktiven Tests findest du in der Uptrends MonitorCheck API-Dokumentation.

Die MonitorCheck API stellt die folgenden GET-Endpunkte bereit:

• /MonitorCheck – Gibt alle Prüfobjekt-Prüfdaten für den Account aus.
• /MonitorCheck/{monitorCheckId} – Gibt eine einzelne Prüfobjekt-Prüfung aus.
• /MonitorCheck/Monitor/{monitorGuid} – Gibt Prüfobjekt-Prüfdaten für das angegebene Prüfobjekt aus.
• /MonitorCheck/MonitorGroup/{monitorGroupGuid} – Gibt Prüfobjekt-Prüfdaten für die angegebene Prüfobjektgruppe aus.

Endpunkte für Prüfobjekttyp

Diese GET-Endpunkte geben Details einer bestimmten Prüfobjekt-Prüfung auf Basis des Prüfobjekttyps zurück:

• /MonitorCheck/{monitorCheckId}/Http – Gibt HTTP- oder HTTPS-Kontrolldetails, einschließlich URL, Antwortinhalt und Header, aus.
• /MonitorCheck/{monitorCheckId}/MultiStepAPI – Gibt Multi-Step API-Kontrolldetails, einschließlich URL, Statuscode, Assertions, Abfrage-Header und Antwortinhalt, aus.
• /MonitorCheck/{monitorCheckId}/Transaction – Gibt Transaktions-Kontrolldetails, einschließlich Informationen zu Schritten, aus. Verwende für Wasserfall, Filmstreifen, Screenshots, Seitenquelle und Konsolenprotokoll die zugehörigen Endpunkte dieses Artikels.

Endpunkte für die Prüfobjektkonfiguration

Die GET-Endpunkte geben Wasserfall, Seiteninhalt und Medien bei Browser- und Transaktionsprüfobjekten, wo zutreffend, aus:

• /MonitorCheck/{monitorCheckId}/Waterfall – Gibt Wasserfalldaten bei Browser- (Full Pagecheck) oder Transaktionsprüfobjekten aus. Die Antwort enthält Core Web Vitals und zugehörige Metriken (Cumulative Layout Shift, First Contentful Paint, Largest Contentful Paint und Time to First Byte).
• /MonitorCheck/{monitorCheckId}/PageSource – Gibt die Seitenquelle (HTML) bei Browser- und Transaktionsprüfobjekten aus.
• /MonitorCheck/{monitorCheckId}/ConsoleLog – Gibt das Browser-Konsolenprotokoll bei Browser- und Transaktionsprüfobjekten aus.
• /MonitorCheck/{monitorCheckId}/Screenshot/{screenshotId} – Gibt die jeweiligen Screenshot-Details der Prüfung aus.
• /MonitorCheck/{monitorCheckId}/Filmstrip – Gibt Filmstreifen-Daten bei Browser- und Transaktionsprüfobjekten aus.

Endpunkte für Parallel-Prüfobjekte

• /MonitorCheck/{monitorCheckId}/Concurrent – Gibt alle Teilprüfungen einer Prüfung von Parallel-Prüfobjekten aus.

MonitorCheck API-Antwort

{
  "Data": [
    {
      "Type": "MonitorCheck",
      "Id": 212790389158,
      "Attributes": {
        "MonitorGuid": "df2bc2d9-755c-45fa-880a-ee82e1eb7793",
        "Timestamp": "2026-04-14T16:52:55",
        "ErrorCode": 0,
        "TotalTime": 101,
        "ResolveTime": 0,
        "ConnectionTime": 0,
        "DownloadTime": 101,
        "ResolvedIpAddress": "104.21.61.23",
        "ErrorLevel": "NoError",
        "ErrorDescription": "OK",
        "ErrorMessage": "",
        "StagingMode": false,
        "ServerId": 1991,
        "IsPartialCheck": false,
        "IsConcurrentCheck": false
      },
      "Relationships": [
        {
          "Id": 1991,
          "Type": "CheckpointServer",
          "Links": {
            "Self": "/Checkpoint/Server/1991"
          }
        },
        {
          "Id": 212790389158,
          "Type": "MultiStepAPICheck",
          "Links": {
            "Self": "/MonitorCheck/212790389158/MultiStepAPI"
          }
        }
      ]
    }
  ],
  "Links": {
    "Next": "/v4/MonitorCheck?Sorting=Descending&Take=100&PresetPeriod=Last24Hours&cursor=r%2b3aDoQMmmzQyn0gZpXRtuTPR9I1p481%2frdq5beRRu9fkwFNbL7g9EqtBTezyrx3cBfwgrEE8eSDh3WpqRTQEg%3d%3d",
    "Self": "/v4/MonitorCheck?Sorting=Descending&Take=100&PresetPeriod=Last24Hours&cursor=Waul03CKWbe9wj%2fZ%2fs%2fYHhAtN5gst9iN3oZ6yP4JvGxZrwiTWxY13mhIivXfKkwKNgN0sY66uVfczabtWzrQMQ%3d%3d"
  },
  "Cursors": {
    "Next": "r+3aDoQMmmzQyn0gZpXRtuTPR9I1p481/rdq5beRRu9fkwFNbL7g9EqtBTezyrx3cBfwgrEE8eSDh3WpqRTQEg==",
    "Self": "Waul03CKWbe9wj/Z/s/YHhAtN5gst9iN3oZ6yP4JvGxZrwiTWxY13mhIivXfKkwKNgN0sY66uVfczabtWzrQMQ=="
  }
}

MonitorCheck API-Parameter

Die folgenden Parameter werden in der MonitorCheck API verwendet:

MonitorCheck API-Felder

Generische Datenstruktur

Das Root Object kann enthalten:

• Data – Eine Reihe Prüfobjekt-Prüfungen oder ein einzelnes Objekt einer Prüfobjekt-Prüfung (zum Beispiel für GET /MonitorCheck/{monitorCheckId}).
• Links – URLs für die aktuelle Seite und die nächste Seite von Ergebnissen. Weitere Informationen findest du im Knowledge-Base-Artikel Links.
• Relationships – verwandte Ressourcen (Checkpoint-Server, Detailtypen usw.). Jedes Element enthält Id, Type und Links.Self. Weitere Informationen findest du unter Relationships.
• Cursors – Cursor-Werte um ein Datenset zu übergehen. Weitere Informationen findest du im Knowledge-Base-Artikel Cursor.
• Meta – Metadaten für die Prüfobjekt-Prüfung.

Daten und Attribute

Die überwachte URL und andere typspezifischen Felder werden von Detail-Endpunkten (zum Beispiel GET /MonitorCheck/{monitorCheckId}/Http oder GET .../MultiStepAPI) ausgegeben, nicht bei den Basis-Attributes-Objekten für jeden Prüfobjekttyp.

Fehlerbehebung

Dieser Abschnitt behandelt übliche HTTP-Fehler und Schritte zur Fehlerbehebung bei der MonitorCheck API.

Übliche Fehler

Übliche HTTP-Statuscodes und ihre Beschreibungen:

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 MonitorCheck 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.