Overzicht
De Status API retourneert controleregelstatusinformatie om controleregelfouten en de oorzaak ervan te helpen identificeren. Deze API weerspiegelt de informatie die wordt weergegeven op de dashboardtegel Details Laatste controle.
Gebruiksvoorbeeld
Gebruik de Status API om toegang te krijgen tot details zoals controletijd, foutniveau, foutbeschrijvingen en controlestationinformatie van de controleregel.
Vereisten
Voordat u de Status API gebruikt, moet u ervoor zorgen dat u over het volgende beschikt:
- Uptrends API-inloggegevens
- De juiste controleregelrechten
- Basiskennis van uw controleregelinstellingen
Status API-eindpunten
De Status API biedt de volgende eindpunten:
| Methode | Eindpunt | Beschrijving |
|---|---|---|
GET |
/Status/Monitor/{monitorGuid} |
Haal statusinformatie op voor een specifieke controleregel. |
GET |
/Status/MonitorGroup/{monitorGroupGuid} |
Haal statusinformatie op voor alle controleregels in een controleregelgroep. |
Raadpleeg de Uptrends Status API-documentatie voor gedetailleerde request- en responsformaten en interactieve API-tests.
Status API-response
Voorbeeldresponse die de status van een controleregel met een bevestigde fout weergeeft:
{
"Data": {
"Id": "ef42495b-26cb-4a2f-8cfc-c933f9716d22",
"Type": "MonitorStatus",
"Attributes": {
"ErrorLevel": "Confirmed",
"LastCheck": "2025-10-15T19:03:52",
"CheckpointId": 212,
"CheckpointName": "Rende",
"ErrorDescription": "HTTP status 200, while 401 expected",
"UptimePercentage": 0,
"ErrorCode": 3040,
"LastMonitorCheckId": 195710454309,
"TotalTime": 377
},
"Relationships": [
{
"Id": "ef42495b-26cb-4a2f-8cfc-c933f9716d22",
"Type": "Monitor",
"Links": {
"Self": "/Monitor/ef42495b-26cb-4a2f-8cfc-c933f9716d22"
}
},
{
"Id": 195710454309,
"Type": "MonitorCheck",
"Links": {
"Self": "/MonitorCheck/195710454309"
}
},
{
"Id": 212,
"Type": "Checkpoint",
"Links": {
"Self": "/Checkpoint/212"
}
}
]
}
}
API-parameters
Gebruik de volgende parameters om informatie in uw API-response te filteren:
| Veldnaam | Beschrijving |
|---|---|
monitorGuid |
De unieke identifier van de controleregel. |
monitorGroupGuid |
De unieke identifier van de controleregelgroep. |
Status API-velden
De Status API bevat verschillende API-velden:
| Veldnaam | Beschrijving |
|---|---|
Id |
The monitorGuid. |
Type |
Het type data dat in de response wordt weergegeven. De standaardwaarde is MonitorStatus. |
Attributes |
Bevat de algemene informatie over de controleregelcheck en het controlestation, zoals het foutniveau en de beschrijving, de totale tijd en de controlestationlocatie. Raadpleeg de sectie Attributes-velden.
|
Relationships |
Definieert hoe de huidige data worden gekoppeld aan of geassocieerd met andere data. Het bevat informatie over hoe u kunt verwijzen naar specifieke bronnen in een API-call voor een controleregel, controleregelcheck en controlestationlocatie. Raadpleeg Relationships voor meer informatie.
|
Attributes API-velden
Het Attributes API-veld bevat:
| Veldnaam | Beschrijving |
|---|---|
ErrorLevel |
De ernst van de fout. Mogelijke waarden zijn:
|
LastCheck |
De datum en tijd waarop de controleregel voor het laatst een controle heeft uitgevoerd. |
CheckpointId |
De unieke identifier van de controlestationlocatie. Raadpleeg Controlestation informatie voor meer informatie over beschikbare controlestations of gebruik de Checkpoint API.
|
CheckpointName |
De naam van het controlestation waar de controleregelcheck is uitgevoerd. |
ErrorDescription |
De foutbeschrijving die is gedetecteerd tijdens de controleregelcheck. |
UptimePercentage |
Het percentage van de tijd dat de website of webservice beschikbaar en operationeel was. Raadpleeg Uptimepercentage berekenen voor meer informatie.
|
ErrorCode |
De numerieke code die overeenkomt met de foutbeschrijving.
|
LastMonitorCheckId |
De unieke identifier van de meest recente controleregelcheck. |
TotalTime |
De totale tijd die nodig is om een controleregelcheck te voltooien, gemeten in milliseconden.
|
Problemen oplossen
In deze sectie worden veelvoorkomende HTTP-fouten en stappen voor probleemoplossing voor de Status API behandeld.
Veelvoorkomende fouten
Veelvoorkomende HTTP-statuscodes en hun beschrijvingen:
| Statuscode | Beschrijving |
|---|---|
| 200 | OK — request succesvol. |
| 400 | Bad request — ongeldige requestparameters of ontbrekende vereiste velden. |
| 401 | Unauthorized — ongeldige of ontbrekende authenticatiegegevens. |
| 403 | Forbidden — toestemming geweigerd. |
| 404 | Not Found — de gespecificeerde GUID bestaat niet. |
| 500 | Internal Server Error — er is een serverfout opgetreden. |
Algemene handleiding voor probleemoplossing
Zorg ervoor dat u:
- Altijd uw request data valideert voordat u API-calls verzendt.
- Voor elke operation de juiste HTTP-methode gebruikt.
Neem voor verdere ondersteuning contact op met ons Support-team.
Gerelateerde artikelen
Raadpleeg voor meer informatie de volgende artikelen:
- Uptrends Status API-documentatie — een interactieve API-documentatie met gedetailleerde eindpuntspecificaties.
- API changelog — voor de laatste API-updates en meldingen over verouderde API’s.