Overview
The Status API returns monitor status information to help identify monitor errors and their root cause. This API reflects the information shown on the Last check details dashboard tile.
Use case
Use the Status API to access details such as monitor check time, error level, error descriptions, and checkpoint information.
Prerequisites
Before using the Status API, make sure you have:
- Uptrends API credentials
- Appropriate monitor permissions
- A basic understanding of your monitor settings
Status API endpoints
The Status API provides the following endpoints:
| Method | Endpoint | Description |
|---|---|---|
GET |
/Status/Monitor/{monitorGuid} |
Retrieve status information for a specific monitor. |
GET |
/Status/MonitorGroup/{monitorGroupGuid} |
Retrieve status information for all monitors in a monitor group. |
For detailed request and response formats, and interactive API testing, refer to the Uptrends Status API documentation.
Status API response
Example response showing the status of a monitor with a confirmed error:
{
"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
Use the following parameters to filter information in your API response:
| Field name | Description |
|---|---|
monitorGuid |
The unique identifier of the monitor. |
monitorGroupGuid |
The unique identifier of the monitor group. |
Status API fields
The Status API contains various API fields:
| Field name | Description |
|---|---|
Id |
The monitorGuid. |
Type |
The type of data shown in the response. The default value is MonitorStatus. |
Attributes |
Contains the general monitor check and checkpoint information, such as error level and description, total time, and checkpoint location. For more information, refer to the Attributes field section.
|
Relationships |
Defines how the current data is linked or associated with other data. It contains information on how you can reference specific resources in an API call for a monitor, monitor check, and checkpoint location. For more information, refer to Relationships.
|
Attributes API fields
The Attributes API field contains:
| Field name | Description |
|---|---|
ErrorLevel |
The severity level of the error. Possible values are:
|
LastCheck |
The date and time when the monitor last performed a check. |
CheckpointId |
The unique identifier of the checkpoint location. For more information on available checkpoints, refer to Checkpoint information or use the Checkpoint API.
|
CheckpointName |
The name of the checkpoint where the monitor check was performed. |
ErrorDescription |
The error description detected during the monitor check. |
UptimePercentage |
The percentage of time the website or web service was available and operational. For more information, refer to Calculating uptime percentage.
|
ErrorCode |
The numeric code corresponding to the error description.
|
LastMonitorCheckId |
The unique identifier of the most recent monitor check. |
TotalTime |
The total time to complete a monitor check, measured in milliseconds.
|
Troubleshooting
This section covers common HTTP errors and troubleshooting steps for the Status API.
Common errors
Common HTTP status codes and their descriptions:
| Status Code | Description |
|---|---|
| 200 | OK — request successful. |
| 400 | Bad request — invalid request parameters or missing required fields. |
| 401 | Unauthorized — invalid or missing authentication credentials. |
| 403 | Forbidden — permission denied. |
| 404 | Not Found — the specified GUID does not exist. |
| 500 | Internal Server Error — a server-side error occurred. |
General troubleshooting guide
Ensure that you:
- Always validate your request data before sending API calls.
- Use appropriate HTTP methods for each operation.
For further assistance, please reach out to our Support team.
Related articles
For more details, refer to the following articles:
- Uptrends Status API documentation — interactive API documentation with detailed endpoint specifications.
- API changelog — for latest API updates and deprecation notices.