1. Support
  2. Knowledge base
  3. Synthetic Monitoring
  4. API Monitoring

API Monitoring

An API (Application Programming Interface) is software that enables the communication between applications. Maybe you are using your own APIs and/or you rely on third-party APIs. Either way, the correct functioning of the APIs is crucial to the operation of your website and services, therefore you should monitor them.

API monitoring checks whether the APIs that you rely on are available, function correctly and perform well. More information can be found in the article What is API monitoring?.

Uptrends API monitoring offers different types of monitors to set up API monitoring. The choice of type depends on whether you have to deal with a single step or with a chain of requests consisting of multiple steps. The single-step monitor is defined using the Webservice HTTP or Webservice HTTPS monitor type. The monitor for a sequence of steps is defined using the Multi-step API monitor (MSA monitor) type.

The Uptrends app has a Multi-step API monitor hub where knowledge about these monitors and the current status can be found in one place.

Setting up API monitors

The setup of the different types of monitors is documented in these articles:

Defining Multi-step API monitor steps

When setting up a Multi-step API monitor you have to define the steps containing the HTTP requests that are part of the scenario you want to monitor. For each step you have to set the details for the request and the response part of the step. There are also some definitions for user-defined functions, variables and metrics. These are set globally (available to all steps). Check out the articles in the sections below to learn more about setting up the HTTP steps.


The HTTP step request is set up by providing a method and a URL and the request body, then specifying further details like the authentication. See the articles below for more information.


Within the response of the step you should define assertions. Assertions are checks that go one step beyond the question if there is a response to the request. An assertion will also check if the response is valid or arrives in time. For each step you can define a number of assertions. Find more information about assertions in these articles:

Global definitions

There are a number of things that you can define for all steps and both the request and response part of them. This comes in handy if you want to use a certain value or function across different steps. Read on in the following articles to find out more:

Script view

You can also edit Multi-step API monitor step definitions directly in the script view. See our article on the MSA script editor for more information.

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