API Alert

L' API Alert contient des endpoints qui fournissent les informations d’alerte provenant d’un moniteur ou d’un groupe de moniteurs.

Paramètres de l’API Alert

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

Cursor

Le paramètre Cursor agit comme un curseur qui vous permet de parcourir l’ensemble des données d’alerte. Il permet de déterminer quels enregistrements d’alerte ont été générés et quel enregistrement d’alerte vient ensuite.

Par exemple, imaginons que vous souhaitiez récupérer les alertes 101 à 200 sur un total de 300 alertes de moniteur. L’API Alert vous permet de récupérer un maximum de 100 alertes par lot. La réponse de l’appel adressé à l’API pour récupérer le premier lot génère un objet JSON Cursors contenant les valeurs Next et Self :

{
  ...

  "Cursors": {
    "Next": "qKLVZ/HGD2XeFkiwNFWJK+nRDuOjjBRipct8qOfRjRmGUG8F5P1WzrQ4p3JFfXoErs96xb+DS0SAPW+XDUi9Zw/zdo4uHXL3TYBhodxfQQul3L4mwDk=",
    "Self": "KYhsR26Se8cQbeQm+o3LXawJXu3Pe6NvSefBcMivZ5QA+rFcRUrHTErK+TrhrUN3Ss8QUing/+jUkjgl3QOvB3kf3AZ+EOubhya5s3CWF+HGWEQkQQ=="
  },
  ...
}

Dans cet exemple, vous utiliserez la valeur Next pour récupérer les alertes à partir de la 101e. Vous utiliserez la valeur Self comme curseur pour récupérer le premier lot d’alertes (de 1 à 100).

PresetPeriod

Les options suivantes sont disponibles pour filtrer facilement les alertes au cours d’une période donnée :

• CurrentDay, CurrentWeek, CurrentMonth, CurrentQuarter, CurrentYear
• Previous Day, Previous Week, Previous Month, Previous Quarter, Previous Year
• Last2Hours, Last6Hours, Last12Hours, Last24Hours, Last48Hours
• Last7Days, Last30Days, Last60Days, Last90Days, Last365Days
• Last3Months, Last6Months, Last12Months, Last24Months

Notez que les périodes commençant par “Previous” et “Last” s’appliquent seulement une fois la période entièrement écoulée.

Si vous définissez la valeur PresetPeriod sur Last7Days et que vous générez des enregistrements d’alerte un lundi à 8h00, vous obtiendrez les résultats du dimanche au dimanche, soit les sept derniers jours complets. Le jour (lundi) auquel vous avez généré le rapport n’est pas inclus car cette période n’est pas encore terminée.

De même, si vous définissez la valeur PresetPeriod sur Last12Months et que vous générez des enregistrements le 25 janvier 2025, vous obtiendrez les résultats incluant le 31 décembre 2024 et les 11 mois précédents. Les alertes de janvier 2024 et de janvier 2025 ne sont pas incluses dans le rapport car le mois de janvier n’est pas encore terminé.

Endpoints de l’API Alert

Les méthodes API suivantes sont disponibles :

GET /Alert/Monitor/{monitorGuid}

Cette méthode renvoie les informations d’alerte pour un moniteur spécifique.

{
      "Type": "Alert",
      "Id": "cd73d946-8577-44f7-b7ed-134ae2c0985e",
      "Attributes": {
        "AlertType": "Reminder",
        "MonitorGuid": "a591a38a-16e0-4dd2-9f15-d575b4c5a433",
        "Timestamp": "2025-01-02T05:39:21",
        "FirstError": "2024-12-11T20:11:01",
        "MonitorCheckId": 171204791912,
        "FirstErrorMonitorCheckId": 169412140540,
        "ErrorDescription": "Step 4 (https://galacticshirts.com): Element '.wn-product-btn' not found.",
        "IncidentKey": "9632cd34-0c13-4e2c-92cc-cca104432cd9-0-169412140545"
      },
      "Relationships": [
        {
          "Id": 171204791912,
          "Type": "MonitorCheck",
          "Links": {
            "Self": "/MonitorCheck/171204791912"
          }
        },
        {
          "Id": 169412140540,
          "Type": "MonitorCheck",
          "Links": {
            "Self": "/MonitorCheck/169412140540"
          }
        }
      ],
      ....
}

GET /Alert/MonitorGroup/{monitorGroupGuid}

Cette méthode renvoie les informations d’alerte pour un groupe de moniteurs spécifique.

{
  "Data": [
    {
      "Type": "Alert",
      "Id": "afd846be-ddbf-49e1-ad15-2eee5f6d7544",
      "Attributes": {
        "AlertType": "Error",
        "MonitorGuid": "a591a38a-16e0-4dd2-9f15-d575b4c5a433",
        "Timestamp": "2025-01-02T02:30:46",
        "FirstError": "2024-12-11T20:11:01",
        "MonitorCheckId": 171193848695,
        "FirstErrorMonitorCheckId": 169412140540,
        "ErrorDescription": "Step 4 (https://galacticshirts.com): Element '.wn-product-btn' not found.",
        "IncidentKey": "9632cd34-0c13-4e2c-92cc-cca104432cd9-0-169412140545"
      },
      "Relationships": [
        {
          "Id": 171193848695,
          "Type": "MonitorCheck",
          "Links": {
            "Self": "/MonitorCheck/171193848695"
          }
        },
        {
          "Id": 169412140540,
          "Type": "MonitorCheck",
          "Links": {
            "Self": "/MonitorCheck/169412140540"
          }
        }
      ]
    },
    .....
  ]
}