1. Support
  2. Base de connaissances
  3. API d'Uptrends
  4. API Statistics

API Statistics

Vue d’ensemble

L’API Statistics renvoie une liste des métriques de vos accords de niveau de service (SLA) et des informations générales pour chaque vérification de moniteur. Cette API reflète certaines informations figurant dans votre liste ou graphique de données simple.

Exemple d’utilisation

Utilisez la commande d’API Statistics pour obtenir des informations telles que l’objectif SLA, l’indisponibilité, le pourcentage de disponibilité et le nombre d’alertes de moniteur, d’erreurs et de vérifications.

Prérequis

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

Endpoints de l’API Statistics

L’API Statistics fournit les endpoints suivants :

Méthode Endpoint Description
GET /Statistics/Monitor/{monitorGuid} Récupération d’une liste de toutes les métriques SLA et des informations générales de votre moniteur
GET /Statistics/MonitorGroup/{monitorGroupGuid} Récupération d’une liste de toutes les métriques SLA et des informations générales de votre groupe de moniteurs

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 Statistics d’Uptrends (en anglais).

Réponse de l’API Statistics

{
  "Data": [
    {
      "Id": "10/13/2025 8:00:00 PM",
      "Type": "Statistics",
      "Attributes": {
        "StartDateTime": "2025-10-13T20:00:00",
        "EndDateTime": "2025-10-13T21:00:00",
        "Alerts": 0,
        "OperatorResponseTarget": 15,
        "OperatorResponseTime": 0,
        "DowntimePercentage": 0,
        "UptimePercentage": 100,
        "Checks": 62,
        "ConfirmedErrors": 0,
        "UnconfirmedErrors": 0,
        "Uptime": 3590,
        "Downtime": 0,
        "TotalTime": 0.727,
        "ResolveTime": 0.106,
        "ConnectionTime": 0.092,
        "DownloadTime": 0.527,
        "TotalBytes": 5699
      },
      "Relationships": [
        {
          "Id": "6f426452-5d2b-4fdf-84e2-c2b3d7ebf918",
          "Type": "Monitor",
          "Links": {
            "Self": "/Monitor/6f426452-5d2b-4fdf-84e2-c2b3d7ebf918"
          }
        }
      ]
    },
    {
      "Id": "10/13/2025 9:00:00 PM",
      "Type": "Statistics",
      "Attributes": {
        "StartDateTime": "2025-10-13T21:00:00",
        "EndDateTime": "2025-10-13T22:00:00",
        "Alerts": 10,
        "OperatorResponseTarget": 15,
        "OperatorResponseTime": 0,
        "DowntimePercentage": 0,
        "UptimePercentage": 100,
        "Checks": 62,
        "ConfirmedErrors": 0,
        "UnconfirmedErrors": 0,
        "Uptime": 3601,
        "Downtime": 0,
        "TotalTime": 0.7,
        "ResolveTime": 0.089,
        "ConnectionTime": 0.097,
        "DownloadTime": 0.513,
        "TotalBytes": 5699
      },
      "Relationships": [
        {
          "Id": "6f426452-5d2b-4fdf-84e2-c2b3d7ebf918",
          "Type": "Monitor",
          "Links": {
            "Self": "/Monitor/6f426452-5d2b-4fdf-84e2-c2b3d7ebf918"
          }
        }
      ]
    }
    ...
  ]

}

Paramètres de l’API

Utilisez les paramètres suivants pour filtrer des informations dans la réponse de l’API :

Nom du champ Description
monitorGuid Identifiant unique du moniteur.
monitorGroupGuid Identifiant unique du groupe de moniteurs
Filter
Chaîne vous permettant de chercher des informations spécifiques dans la réponse d’API. Vous pouvez utiliser un ou plusieurs champs de l’API Statistics comme des valeurs de filtre. Par exemple, Alerts ou Alerts, UptimePercentage.
Start Paramètre de date personnalisé au format YYYY-MM-DDTHH:MM:SS (par exemple, 2025-01-20T08:00:00) utilisé avec le paramètre End pour préciser la date de début pour la réponse d’API. Ce paramètre ne peut pas être utilisé avec le champ PresetPeriod.
End Paramètre de date personnalisé au format YYYY-MM-DDTHH:MM:SS (par exemple, 2025-01-20T08:00:00) utilisé avec le paramètre Start pour préciser la date de fin pour la réponse d’API. Ce paramètre ne peut pas être utilisé avec le champ PresetPeriod.
PresetPeriod Liste de périodes permettant de filtrer des informations pour une période spécifique. Ce champ n’est pas compatible avec les paramètres Start et End. La valeur par défaut est Last24Hours. Pour en savoir plus, vous pouvez lire notre article sur le champ PresetPeriod.

Champs de l’API Statistics

L’API Statistics contient plusieurs champs :

Nom du champ Description
Id L’horodatage marquant le début de chaque intervalle de données dans la réponse. Si la période prédéfinie (PresetPeriod) par défaut est utilisée, soit Last24Hours, les données sont groupées en intervalles d’une heure.
Type Type de données affiché dans la réponse. La valeur par défaut est Statistics.
Attributes
Contient les métriques SLA et les informations générales sur le monitoring, comme la disponibilité, l’indisponibilité, les alertes et les délais de réponse. Pour en savoir plus, vous pouvez consulter la section sur le champ Attributes.
Relationships Ce champ définit la façon dont des données sont liées ou associées à d’autres données, ce qui vous aide à identifier les références à des ressources liées. Pour en savoir plus, vous pouvez vous reporter à notre article sur le champ d’API Relationships.

Champ d’API Attributes

Le champ d’API Attributes contient :

Nom du champ Description
StartDateTime Jour et heure de lancement de l’intervalle de vérification du moniteur
EndDateTime Jour et heure de fin de l’intervalle de vérification du moniteur
Alerts
Nombre d’alertes déclenchées par des erreurs confirmées pendant l’intervalle de vérification du moniteur
OperatorResponseTarget Durée en minutes de l’objectif SLA de réponse opérateur. C’est la durée maximale autorisée pour qu’un opérateur confirme une erreur dans Uptrends.
OperatorResponseTime Temps SLA de réponse opérateur. C’est la durée effective qu’un opérateur enregistre pour confirmer une erreur dans Uptrends.
DowntimePercentage Pourcentage d’indisponibilité (Downtime). Durée totale pendant laquelle un site web ou un service web a été indisponible.
UptimePercentage Pourcentage de disponibilité (Uptime) SLA. Durée totale pendant laquelle un site web ou un service web a été disponible.
Checks Nombre de vérifications de moniteur effectuées pendant l’intervalle de vérification, depuis StartDateTime jusqu’à EndDateTime.
ConfirmedErrors
UnconfirmedErrors Nombre d’erreurs qui ont été signalées mais pas encore vérifiées
Uptime Durée totale en minutes pendant laquelle votre site web a été disponible
Downtime Durée totale en minutes pendant laquelle votre site web a été indisponible
TotalTime Durée totale de la réalisation d’une vérification de moniteur, en secondes
ResolveTime Temps nécessaire pour traduire un nom de domaine ou une URL dans une adresse IP correspondante, en secondes
ConnectionTime Temps nécessaire pour se connecter à l’adresse IP de votre page web ou serveur, en secondes
DownloadTime Temps nécessaire pour télécharger du contenu après qu’une connexion à votre page web ou votre serveur a été établie, en secondes
TotalBytes Montant total de données, en octets, récupérées depuis votre page pendant l’intervalle de vérification du moniteur

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

Erreurs courantes

Codes de statut HTTP courants et leurs descriptions :

Code de statut Description
200 OK : requête réussie
400 Mauvaise requête : les paramètres de requête sont invalides ou des champs obligatoires sont manquants.
401 Non autorisé : les identifiants d’authentification sont invalides ou manquants.
403 Interdit : autorisation refusée
404 Non trouvé : le GUID spécifié n’existe pas.
500 Erreur de serveur interne : une erreur s’est produite du côté serveur.

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 :

En utilisant ce site, vous consentez à l’utilisation de cookies conformément à notre Politique de cookies.