1. Support
  2. Knowledge Base
  3. Uptrends' API
  4. RUM API

RUM API

Überblick

Das Real User Monitoring (RUM) API liefert eine Reihe von Endpunkten, sodass du deine RUM Website-Konfigurationen verwalten kannst.

Einsatzbereiche

  • RUM Websites verwalten – erstelle, aktualisiere und lösche Konfigurationen wie Anzeigename, überwachte URL, Überwachen von Single Page Application (SPA) und URL-Fragmente.
  • Rufe aggregierte RUM-Metriken für benutzerdefiniertes Reporting oder Integrationen ab.

Voraussetzungen

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

RUM API-Endpunkte

Die RUM API bietet die folgenden Endpunkte, um RUM Websites zu verwalten:

RUMs verwalten

Methode Endpunkt Beschreibung
GET /RUM/Website Gibt alle RUM Websites und ihre Konfigurationen aus.
POST /RUM/Website Erstellt eine RUM Website anhand des Request Body.
GET /Rum/Website/{rumWebsiteGuid} Gibt die angegebene RUM Website und ihre Konfiguration aus.
PUT /Rum/Website/{rumWebsiteGuid} Aktualisiert die angegebene RUM Website.
PATCH /Rum/Website/{rumWebsiteGuid} Aktualisiert die angegebene RUM Website zum Teil.
DELETE /Rum/Website/{rumWebsiteGuid} Löscht die angegebene RUM Website.
GET /Rum/Website/{rumWebsiteGuid}/Metrics Gibt Messwerte für die angegebene RUM Website aus.
GET /Rum/Website/Metrics Gibt Messwerte für alle RUM Websites aus.

Mehr Informationen zu den Abfrage- und Antwortformaten und zu interaktiven API-Tests findest du in der Uptrends RUM API-Dokumentation.

RUM API-Antwort

RUM Website 

[
  {
    "RumWebsiteId": "a8686c1f-f662-424d-a1b2-0c1d0170e2f1",
    "Description": "Production website - www.example.com",
    "Url": "https://www.example.com",
    "IsSpa": true,
    "IncludeUrlFragment": true,
    "RumScript": "<script>\n      var _urconfig = { sid: \"89c1bfcc-fbfc-4d19-b5a5-963e606af25b\", aip: 0, usePageProtocol: false };\n      (function (d, s) {\n          var js = d.createElement(s),\n              sc = d.getElementsByTagName(s)[0];\n          js.src = \"https://hit.uptrendsdata.com/rum.min.js\";\n          js.async = \"async\";\n          sc.parentNode.insertBefore(js, sc);\n      }(document, \"script\"));\n    </script>"
  }
]

RUM Website mit Metriken 

[
  {
    "RumWebsiteId": "a8686c1f-f662-424d-a1b2-0c1d0170e2f1",
    "Description": "Production website - www.example.com",
    "Url": "https://www.example.com",
    "IsSpa": true,
    "IncludeUrlFragment": true,
    "MetricValues": [
      {
        "Metric": "PageViews",
        "Median": 869,
        "Minimum": 1,
        "Maximum": 245764,
        "Average": 2054,
        "Count": 19571
      },
      {
        "Metric": "DnsDuration",
        "Median": 0,
        "Minimum": 0,
        "Maximum": 19918,
        "Average": 14,
        "Count": 29379
      },
      {
        "Metric": "BackendDuration",
        "Median": 297,
        "Minimum": 0,
        "Maximum": 71692,
        "Average": 437,
        "Count": 29379
      },
      ...
    ]
  }
]

RUM API-Parameter

Feldname Beschreibung
includeScripts RUM Tracking-Skript (<script>...</script>), das in deiner Website eingebettet ist.
rumWebsiteGuid Die einzigartige Kennung der RUM Website. Dies wird für die Endpunkte PUT, PATCH und DELETE genutzt. Ähnlich zum Wert des Felds RumWebsiteId.
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.
WebsiteFilter Filter-String für RUM Website-Beschreibungen. Wildcards wie ? und * werden unterstützt. Um mehrere Muster zu filtern, kann das |-Symbol als Trennzeichen verwendet werden.

Felder der RUM API

RUM Website-Ressourcen verwenden die folgenden Eigenschaften in Abfrage- und Antwort-Inhalten:

Feldname Beschreibung
RumWebsiteId Die einzigartige Kennung der RUM Website. Ähnlich zum Wert des Felds rumWebsiteGuid.
Description Anzeigename der RUM Website.
Url Die überwachte URL der RUM Website.
IsSpa Gibt true aus, wenn die konfigurierte RUM Website ein SPA ist, eine Art von Website, die anfangs eine HTML-Seite lädt und dann dynamisch den Inhalt aktualisiert. Andernfalls lautet es false.
IncludeUrlFragment Gibt true aus, wenn die konfigurierte RUM Website URL-Fragmente, der letzte Teil einer URL, die nach dem #-Symbol erscheint, akzeptiert.
RumScript Das RUM Skript (<script>...</script>), dass in deine Website eingesetzt wird.
Metric

Gibt die Art der gemessenen Metrik deiner RUM Website aus. Mögliche Werte:

  • PageViews
  • LoadTime
  • TimeToFirstByte
  • PageReadyTime
  • NetworkDuration
  • RedirectDuration
  • DnsDuration
  • ConnectDuration
  • BackendDuration
  • SendDuration
  • ReceiveDuration
  • FrontEndDuration
  • DomDuration
  • RenderDuration
  • DownloadTime
Median Gibt eine Ganzzahl aus: der Median aggregierter Werte der ausgewählten Metric (Mittelwert nach Sortierung).
Minimum Gibt eine Ganzzahl aus: kleinster aggregierter Wert der ausgewählten Metric.
Maximum Gibt eine Ganzzahl aus: höchster aggregierter Wert der ausgewählten Metric.
Average Gibt eine Ganzzahl aus: arithmetisches Mittel aggregierter Werte der ausgewählten Metric.
Count Gibt eine Ganzzahl aus: Gesamtwert der ausgewählten Metric. Zum Beispiel Gesamtzahl der Seitenaufrufe, wenn PageViews die Metric ist.

Fehlerbehebung

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

Übliche Fehler

Übliche HTTP-Statuscodes und ihre Beschreibungen:

Statuscode Beschreibung
200 OK – Abfrage erfolgreich.
204 Kein Inhalt – die Abfrage wurde erfolgreich gesendet und es wurde keine Antwort zurückgegeben. Dies ist der Fall bei DELETE-, PUT-, PATCH- und POST-Abfragen.
400 Ungültige Abfrage – ungültige Abfrageparameter oder fehlende erforderliche Felder.
401 Nicht autorisiert – ungültige oder fehlende Authentifizierungsdaten.
403 Verboten – es gab einen oder mehrere Validierungsfehler. Das kann in Verbindung mit Accountberechtigungen auftreten.
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 RUM 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.
Durch die Nutzung dieser Website stimmen Sie der Verwendung von Cookies gemäß unserer Cookie-Richtlinien zu.