MonitorCheck API

Overzicht

Uptrends biedt verschillende controleregeltypes, zoals uptime-, browser- (full-page check) en multi-step API-controleregels, om de beschikbaarheid en performance van uw websites te volgen. Elke keer dat een controleregel wordt uitgevoerd, genereert deze een controleregelcheck.

Een controle bevat gedetailleerde controleregelmetingen, inclusief foutbeschrijvingen, resolvetijd en andere statistieken die de status en het gedrag van uw website of -service weerspiegelen.

Vereisten

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

• Uptrends API-inloggegevens
• Basiskennis van controleregeltypes en hun configuratie
• Basiskennis van controleregelresultaten

MonitorCheck API-eindpunten

Wanneer u een lijst met controleregelchecks aanvraagt, bevat elke vermelding basisstatistieken voor die controle. Afhankelijk van het controleregeltype kunnen meer gedetailleerde data beschikbaar zijn via aanvullende GET-requests. Wanneer er gerelateerde resources voor een controle bestaan, verschijnen deze in de Relationships-array: elke vermelding bevat Links.Self, wat het pad is om dat detail op te halen (bijvoorbeeld, /MonitorCheck/{monitorCheckId}/MultiStepAPI).

Voor schema’s en interactieve tests, raadpleegt u de Uptrends MonitorCheck API-documentatie.

De MonitorCheck API biedt de volgende GET-eindpunten.

• /MonitorCheck — retourneert controleregelcheckdata voor het account.
• /MonitorCheck/{monitorCheckId} — retourneert één controleregelcheck.
• /MonitorCheck/Monitor/{monitorGuid} — retourneert controleregelcheckdata voor de gespecificeerde controleregel.
• /MonitorCheck/MonitorGroup/{monitorGroupGuid} — retourneert controleregelcheckdata voor de gespecificeerde controleregelgroep.

Eindpunten voor controleregeltype

Deze GET-eindpunten retourneren details voor een specifieke controleregelcheck, afgestemd op het controleregeltype:

• /MonitorCheck/{monitorCheckId}/Http — retourneert details van HTTP- of HTTPS-controles, inclusief URL, responsbody en headers.
• /MonitorCheck/{monitorCheckId}/MultiStepAPI — retourneert details van multi-step API -controles, inclusief URL, statuscode, assertions, request headers en response body.
• /MonitorCheck/{monitorCheckId}/Transaction — retourneert details van transactiecontroles, inclusief stapinformatie. Voor waterval, filmstrip, screenshots, paginabron en console log gebruikt u de specifieke eindpunten in dit artikel.

Eindpunten voor controleregelconfiguratie

Deze GET-eindpunten retourneren waterval, pagina-inhoud en media voor browser- en transactiecontroleregels, indien van toepassing:

• /MonitorCheck/{monitorCheckId}/Waterfall — retourneert watervaldata voor browser- (full-page) of transactiecontroleregels. De respons bevat Core Web Vitals en gerelateerde kengetallen (Cumulative Layout Shift, First Contentful Paint, Largest Contentful Paint en Time to First Byte).
• /MonitorCheck/{monitorCheckId}/PageSource — retourneert paginabron (HTML) voor browser- en transactiecontroleregels.
• /MonitorCheck/{monitorCheckId}/ConsoleLog — retourneert de browser console log voor browser- en transactiecontroleregels.
• /MonitorCheck/{monitorCheckId}/Screenshot/{screenshotId} — retourneert de specifieke screenshotdetails voor de controleregelcheck.
• /MonitorCheck/{monitorCheckId}/Filmstrip — retourneert filmstripdata voor browser- en transactiecontroleregels.

Eindpunt voor gelijktijdige controleregels

• /MonitorCheck/{monitorCheckId}/Concurrent — retourneert alle gedeeltelijke controles voor een gelijktijdige controleregelcheck.

MonitorCheck API-response

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

MonitorCheck API-parameters

De volgende parameters worden gebruikt binnen de MonitorCheck API:

MonitorCheck API-velden

Algemene datastructuur

Het rootobject kan het volgende bevatten:

• Data — een reeks met controleregelchecks, of een enkel controleregelcheckobject (bijvoorbeeld voor GET /MonitorCheck/{monitorCheckId}).
• Links — URL’s voor de huidige pagina en de volgende pagina met resultaten. Zie voor meer informatie het knowledgebase-artikel Links.
• Relationships — gerelateerde resources (controlestationserver, detailtypes, enzovoort). Elk item bevat Id, Type en Links.Self. Zie Relationships.
• Cursors — cursorwaarden voor het doorlopen van een dataset. Zie voor meer informatie het knowledgebase-artikel Cursor.
• Meta — metadata voor de controleregelcheck.

Data- en attributleden

De gemonitorde URL en andere type-specifieke velden worden geretourneerd vanuit de detail-eindpunten (bijvoorbeeld GET /MonitorCheck/{monitorCheckId}/Http of GET .../MultiStepAPI), niet in het basisobject Attributes voor elk controleregeltype.

Problemen oplossen

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

Veelvoorkomende fouten

Veelvoorkomende HTTP-statuscodes en hun beschrijving:

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.

Neem voor verdere ondersteuning contact op met ons Supportteam.

Aanvullende artikelen

Raadpleeg de volgende artikelen voor meer informatie:

• Uptrends MonitorCheck API-documentatie — interactieve API-documentatie met gedetailleerde eindpuntspecificaties.
• API changelog — voor de nieuwste API-updates en meldingen over verouderde API’s.