ITRS named a Visionary in the 2025 Gartner® Magic Quadrant™ for Digital Experience Monitoring.

  1. Support
  2. Knowledge base
  3. Uptrends' API
  4. Statistics API

Statistics API

Overview

The Statistics API returns a list of your Service Level Agreement (SLA) metrics and general monitoring information for every monitor check. This API reflects some information shown on your Simple data list or chart.

Use case

Use the Statistics API to access details such as SLA target, downtime, uptime percentage, and number of monitor alerts, errors, and checks.

Prerequisites

Before using the Statistics API, make sure you have:

Statistics API endpoints

The Statistics API provides the following endpoints:

Method Endpoint Description
GET /Statistics/Monitor/{monitorGuid} Retrieve a list of all your monitor’s SLA metrics and general information.
GET /Statistics/MonitorGroup/{monitorGroupGuid} Retrieve a list of all your monitor group’s SLA metrics and general information.

For detailed request and response formats and interactive API testing, refer to the Uptrends Statistics API documentation.

Statistics API response 

{
  "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"
          }
        }
      ]
    }
    ...
  ]
  
}

API Parameters

Use the following parameters to filter information from your API response:

Field name Description
monitorGuid The unique identifier of the monitor.
monitorGroupGuid The unique identifier of the monitor group.
Filter
A string that lets you search for specific information from the API response. You can use one or more Statistics API fields as filter values. For example, Alerts or Alerts, UptimePercentage.
Start A custom date parameter in YYYY-MM-DDTHH:MM:SS format (for example, 2025-01-20T08:00:00) used with the End parameter to specify the start date for the API response. This parameter cannot be used along with the PresetPeriod.
End A custom date parameter in YYYY-MM-DDTHH:MM:SS format (for example, 2025-01-20T16:00:00) used with the Start parameter to specify the end date for the returned statistics records. This parameter cannot be used along with the PresetPeriod.
PresetPeriod A list of time duration to filter information within a specific period. This cannot be used along with the Start and End parameters. The default value is Last24Hours. For more detailed explanation, refer to PresetPeriod.

Statistics API fields

The Statistics API contains various API fields:

Field name Description
Id The timestamp marking the start of each data interval in the response. When using the default PresetPeriod of Last24Hours, data is grouped into one-hour intervals.
Type The type of data shown in the response. The default value is Statistics.
Attributes
Contains SLA metrics and general monitoring details, such as uptime, downtime, alerts, and response times. For more information, refer to the Attributes field section.
Relationships Defines how the current data is linked or associated with other data, helping you identify references to related resources. For more information, refer to Relationships.

Attributes API fields

The Attributes API field contains:

Field name Description
StartDateTime Refers to the date and time of when the monitor check interval starts.
EndDateTime Refers to the date and time of when the monitor check interval ends.
Alerts
The number of alerts triggered from confirmed errors during the monitor check interval.
OperatorResponseTarget The SLA operator response target time in minutes. This is the maximum time allowed for an operator to confirm an error in Uptrends.
OperatorResponseTime The SLA operator response time in minutes. This is the actual time an operator took to confirm an error in Uptrends.
DowntimePercentage The SLA downtime percentage. This is the total time the website or web service was unavailable.
UptimePercentage The SLA uptime percentage. This is the total time the website or web service was up and running.
Checks The number of monitor checks within the check interval, from StartDateTime to EndDateTime.
ConfirmedErrors
The number of confirmed errors.
UnconfirmedErrors The number of errors that were reported but not yet verified.
Uptime The total time your website was up and running, measured in minutes.
Downtime The total time your website was down and unavailable, measured in minutes.
TotalTime The total time to complete a monitor check, measured in seconds.
ResolveTime The time it takes to translate a domain name or URL to a corresponding IP address, measured in seconds.
ConnectionTime The time it takes to connect to the IP address of your webpage or server, measured in seconds.
DownloadTime The time taken to download content after a connection to your webpage or server has been established, measured in seconds.
TotalBytes The total amount of data, in bytes, retrieved from your page during the monitor check interval.

Troubleshooting

This section covers common HTTP errors and troubleshooting steps for the Statistics 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.

For more details, refer to the following articles:

By using the Uptrends website, you consent to the use of cookies in accordance with our Cookie Policy.