API MonitorCheck

Vue d’ensemble

Pour surveiller la disponibilité et la performance de vos sites web, Uptrends fournit plusieurs types de moniteurs, y compris des moniteurs de disponibilité, des moniteurs de navigateur (Full Page Check) et des moniteurs d’API multi-étapes. À chaque fois qu’un moniteur s’exécute, il effectue une vérification.

La vérification fournit des mesures de surveillance détaillées, y compris les descriptions d’erreur, le temps de résolution et d’autres métriques qui reflètent le statut et le comportement de votre site web ou de votre service.

Prérequis

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

• Les identifiants de l’API d’Uptrends
• Une compréhension de base des types de moniteurs et de leur configuration
• Une compréhension rudimentaire des résultats des moniteurs

Endpoints de l’API MonitorCheck

Lorsque vous demandez une liste de vérifications de moniteur, chaque entrée contient des métriques élémentaires issues de la vérification. Selon le type de moniteur, des données plus détaillées peuvent être obtenues au moyen de requêtes GET supplémentaires. Lorsque des ressources sont associées à la vérification, elles apparaissent dans le tableau Relationships : chaque élément inclut Links.Self, qui correspond au chemin à appeler pour récupérer ces détails (par exemple, /MonitorCheck/{monitorCheckId}/MultiStepAPI).

Pour accéder aux schémas et aux tests interactifs, reportez-vous à la documentation de l’API MonitorCheck d’Uptrends (en anglais).

L’API MonitorCheck fournit les endpoints GET suivants :

• /MonitorCheck : renvoie les données de la vérification pour le compte.
• /MonitorCheck/{monitorCheckId} : renvoie une vérification de moniteur unique.
• /MonitorCheck/Monitor/{monitorGuid} : renvoie les données de la vérification pour le moniteur précisé.
• /MonitorCheck/MonitorGroup/{monitorGroupGuid} : renvoie les données de la vérification pour le groupe de moniteurs précisé.

Endpoints spécifiques au type de moniteur

Ces endpoints GET renvoient des données pour une vérification effectuée par un moniteur spécifique, selon le type de moniteur :

• /MonitorCheck/{monitorCheckId}/Http : renvoie les données de vérification issues du moniteur HTTP ou HTTPS, y compris l’URL, le corps de réponse et les en-têtes.
• /MonitorCheck/{monitorCheckId}/MultiStepAPI : renvoie les données de vérification issues du moniteur d’API multi-étapes, y compris l’URL, le code de statut, les en-têtes de requête et le corps de réponse.
• /MonitorCheck/{monitorCheckId}/Transaction : renvoie les données de vérification issues du moniteur de transaction, y compris les informations sur les étapes. Pour les graphiques en cascade, les captures d’écran successives, le code source de la page et le journal de la console, utilisez les endpoints correspondants présentés dans la suite de cet article.

Endpoints pour la configuration du moniteur

Ces endpoints GET renvoient les graphiques en cascade, le contenu de la page et les médias pour les moniteurs de navigateur et de transactions, selon le cas :

• /MonitorCheck/{monitorCheckId}/Waterfall : renvoie les données des graphiques en cascade pour les moniteurs de navigateur (Full Page Check) et les moniteurs de transactions. La réponse inclut les Core Web Vitals et les métriques liées (Cumulative Layout Shift, First Contentful Paint, Largest Contentful Paint et Time to First Byte).
• /MonitorCheck/{monitorCheckId}/PageSource : renvoie le code source de la page (HTML) pour les moniteurs de navigateur et les moniteurs de transactions.
• /MonitorCheck/{monitorCheckId}/ConsoleLog : renvoie le journal de console du navigateur pour les moniteurs de navigateur et les moniteurs de transactions.
• /MonitorCheck/{monitorCheckId}/Screenshot/{screenshotId} : renvoie les données des captures d’écran issues de la vérification de moniteur.
• /MonitorCheck/{monitorCheckId}/Filmstrip : renvoie les données des captures d’écran successives pour les moniteurs de navigateur et les moniteurs de transactions.

Endpoint pour la surveillance simultanée

• /MonitorCheck/{monitorCheckId}/Concurrent : renvoie tous les contrôles partiels pour une vérification simultanée effectuée par un moniteur.

Réponse de l’API MonitorCheck

{
  "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=="
  }
}

Paramètres de l’API MonitorCheck

Les paramètres suivants sont disponibles dans l’API MonitorCheck :

Champs de l’API MonitorCheck

Structure de données générique

L’objet racine peut inclure les éléments suivants :

• Data : un tableau de vérifications de moniteurs ou un objet unique de vérification de moniteur (par exemple, pour GET /MonitorCheck/{monitorCheckId}).
• Links : URL pour la page en cours et la page de résultats suivante. Pour en savoir plus, lisez notre article sur le champ Links.
• Relationships : ressources associées (serveur de checkpoint, types d’informations, etc.). Chaque élément inclut les valeurs Id, Type et Links.Self. Pour en savoir plus, lisez notre article sur le champ Relationships.
• Cursors : les valeurs de curseur permettant de parcourir un ensemble de données. Pour en savoir plus, lisez l’article sur le champ Cursor.
• Meta : métadonnées de la vérification de moniteur.

Champs de données et attributs

L’URL surveillée et les autres champs spécifiques au type de moniteur sont disponibles via les endpoints de détail (par exemple, GET /MonitorCheck/{monitorCheckId}/Http ou GET .../MultiStepAPI), et non dans l’objet Attributes de base commun à tous les types de moniteurs.

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

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 en savoir plus, veuillez contacter notre équipe de support.

Articles liés

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

• Documentation de l’API MonitorCheck 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.