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

RUM API

Overzicht

De Real User Monitoring (RUM) API biedt een set eindpunten om uw RUM-websiteconfiguraties te beheren.

Gebruiksscenario’s

  • Beheer RUM-websites — creëer, update en verwijder configuraties zoals displaynaam, gemonitorde URL, Single Page Application (SPA)-tracking en URL-fragmenten.
  • Haal geaggregeerde RUM-statistieken op voor aangepaste rapportage of integraties.

Vereisten

Voordat u de RUM API gebruikt, moet u ervoor zorgen dat u beschikt over:

RUM API-eindpunten

De RUM API biedt de volgende eindpunten voor het beheren van RUM-websites:

RUM’s beheren

Methode Eindpunt Beschrijving
GET /RUM/Website Retourneert alle RUM-websites en hun configuraties.
POST /RUM/Website Creëert een RUM-website met behulp van de request body.
GET /Rum/Website/{rumWebsiteGuid} Retourneert de gespecificeerde RUM-website en zijn configuratie.
PUT /Rum/Website/{rumWebsiteGuid} Werkt de gespecificeerde RUM-website bij.
PATCH /Rum/Website/{rumWebsiteGuid} Werkt de gespecificeerde RUM-website gedeeltelijk bij.
DELETE /Rum/Website/{rumWebsiteGuid} Verwijdert de gespecificeerde RUM-website.
GET /Rum/Website/{rumWebsiteGuid}/Metrics Retourneert statistieken voor de gespecificeerde RUM-website.
GET /Rum/Website/Metrics Retourneert statistieken voor alle RUM-websites.

Voor gedetailleerde request- en responsformaten en interactieve API-tests, raadpleegt u de Uptrends RUM API-documentatie.

RUM API-respons

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 met statistieken 

[
  {
    "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-parameters

Veldnaam Beschrijving
includeScripts RUM-trackingscript (<script>...</script>) ingesloten in uw website.
rumWebsiteGuid De unieke identifier van de RUM-website. Gebruikt voor de eindpunten PUT, PATCH en DELETE. Vergelijkbaar met de waarde van het veld RumWebsiteId.
Start Een aangepaste datumparameter in het formaat JJJJ-MM-DDTHH:MM:SS (bijvoorbeeld 2025-01-20T08:00:00) die samen met de parameter End wordt gebruikt om de startdatum voor de API-respons te specificeren. Deze parameter kan niet samen met de PresetPeriod worden gebruikt.
End Een aangepaste datumparameter in het formaat JJJJ-MM-DDTHH:MM:SS (bijvoorbeeld 2025-01-20T16:00:00) die samen met de parameter Start wordt gebruikt om de einddatum voor de geretourneerde statistische records te specificeren. Deze parameter kan niet samen met PresetPeriod worden gebruikt.
PresetPeriod
Een lijst met tijdsduren om informatie binnen een specifieke periode te filteren. Dit kan niet samen met de parameters Start en Eind worden gebruikt. De standaardwaarde is Last24Hours. Zie PresetPeriod voor een meer gedetailleerde uitleg.
WebsiteFilter Filterstring voor RUM-websitebeschrijvingen. Jokertekens zoals ? en * worden ondersteund. Gebruik het symbool | als scheidingsteken om meerdere patronen te filteren.

RUM API-velden

RUM-websitebronnen gebruiken de volgende eigenschappen in de request- en responsbody’s:

Veldnaam Beschrijving
RumWebsiteId De unieke identifier van de RUM-website. Vergelijkbaar met de waarde van het veld rumWebsiteGuid.
Description Displaynaam van uw RUM-website.
Url Gemonitorde URL van uw RUM-website.
IsSpa Retourneert true als de geconfigureerde RUM-website een SPA is, een type website dat in eerste instantie één HTML-pagina laadt en vervolgens de inhoud dynamisch bijwerkt. Anders false.
IncludeUrlFragment Retourneert true als de geconfigureerde RUM-website URL-fragmenten accepteert, het laatste deel van een URL dat na het #-symbool verschijnt.
RumScript Het RUM-script (<script>...</script>) dat in uw website is ingevoegd.
Metric

Geeft het type statistiek weer dat op uw RUM-website wordt gemeten. Mogelijke waarden:

  • PageViews
  • LoadTime
  • TimeToFirstByte
  • PageReadyTime
  • NetworkDuration
  • RedirectDuration
  • DnsDuration
  • ConnectDuration
  • BackendDuration
  • SendDuration
  • ReceiveDuration
  • FrontEndDuration
  • DomDuration
  • RenderDuration
  • DownloadTime
Median Retourneert een geheel getal: de mediaan van de geaggregeerde waarden voor de geselecteerde Metric (middelste waarde wanneer gesorteerd).
Minimum Retourneert een geheel getal: de minimale geaggregeerde waarde voor de geselecteerde Metric.
Maximum Retourneert een geheel getal: de maximale geaggregeerde waarde voor de geselecteerde Metric.
Average Retourneert een geheel getal: het rekenkundig gemiddelde van de geaggregeerde waarden voor de geselecteerde Metric.
Count Retourneert een geheel getal: het totaal voor de geselecteerde Metric. Bijvoorbeeld het totale aantal paginaweergaven wanneer Metric PageViews is.

Problemen oplossen

Deze sectie behandelt veelvoorkomende HTTP-fouten en stappen voor probleemoplossing voor de RUM API.

Veelvoorkomende fouten

Veelvoorkomende HTTP-statuscodes en hun beschrijving:

Statuscode Beschrijving
200 OK — request succesvol.
204 No content — de request is succesvol voltooid en er is geen respons geretourneerd. Dit geldt voor DELETE, PUT, PATCH en POST requests.
400 Bad request — ongeldige requestparameters of ontbrekende verplichte velden.
401 Unauthorized — ongeldige of ontbrekende authenticatiegegevens.
403 Forbidden — er zijn een of meer validatiefouten opgetreden. Dit kan verband houden met accountmachtigingen.
404 Not Found — de gespecificeerde GUID bestaat niet.
500 Internal Server Error — er is een serverfout opgetreden.

Algemene handleiding voor probleemoplossing

Zorg ervoor dat u:

  • Altijd uw request data valideert voordat u API-calls verstuurt.
  • Voor elke operation de juiste HTTP-methoden gebruikt.

Voor verdere hulp kunt u contact opnemen met ons Supportteam.

Aanvullende artikelen

Raadpleeg de volgende artikelen voor meer informatie:

Door deze website te gebruiken, stemt u in met het gebruik van cookies in overeenstemming met ons Cookiebeleid.