API RUM

Vue d’ensemble

L’API Real User Monitoring (RUM) fournit un ensemble d’endpoints qui vous permettent de gérer les configurations de votre site web RUM.

Exemples d’utilisation

• Gestion des sites web RUM : créez, actualisez et supprimez des configurations telles que le nom d’affichage, l’URL surveillée, le suivi des applications monopage et les fragments d’URL.
• Récupération de métriques RUM agrégées pour créer des rapports ou des intégrations sur mesure

Prérequis

Pour utiliser l’API RUM, vous avez besoin des éléments suivants :

• Les identifiants de l’API d’Uptrends
• Une bonne compréhension des prérequis RUM et de la configuration de vos moniteurs

Endpoints de l’API RUM

L’API RUM fournit les endpoints suivants pour gérer les sites web RUM :

Gestion des sites web RUM

Pour en savoir plus sur les formats des requêtes et des réponses et la réalisation de tests interactifs, vous pouvez consulter la documentation de l’API RUM d’Uptrends (en anglais).

Réponse de l’API RUM

Site web RUM

[
  {
    "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>"
  }
]

Site web RUM avec des métriques

[
  {
    "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
      },
      ...
    ]
  }
]

Paramètres de l’API RUM

Champs de l’API RUM

Les ressources des sites web RUM utilisent les propriétés suivantes dans les corps de requête et de réponse :

Dépannage

Vous trouverez ci-dessous les erreurs HTTP les plus courantes et les étapes à suivre pour résoudre les problèmes liés à l’API RUM.

Erreurs courantes

Codes de statut HTTP courants et leurs descriptions :

Dépannage général

Pensez à :

• Toujours valider les données de votre requête avant d’envoyer les appels d’API.
• Utiliser des méthodes HTTP appropriées pour chaque opération. Pour obtenir de l’aide, veuillez contacter notre équipe de support.

Articles liés

Pour en savoir plus, vous pouvez lire les articles suivants :

• Documentation de l’API RUM d’Uptrends : cette documentation interactive vous fournit des spécifications détaillées sur les endpoints (en anglais).
• Journal de modification des API : cette page rassemble les dernières actualités sur l’API et les avis de retrait.