Runscope Documentation

Runscope Radar: API Monitoring and Testing

The Basics

A Runscope Radar test is a group of one or more HTTP requests executed sequentially. For each request in the test plan, you can define Assertions on expected response data and Variables containing extracted response data to be used in subsequent requests. For advanced assertion or data extraction scenarios, you can use JavaScript.

A test Passes if all the assertions pass. A test Fails if any assertion fails, or another error is encountered like a network connection problem or a reference to an undefined variable.

Tests can be run from the cloud or behind your firewall against any public or private API. When a test completes, notifications can be sent via email, webhook, PagerDuty, Slack, HipChat, and more.

Create Your First Test

If you haven't yet, sign up for your free Runscope account. After completing the walkthrough, start by creating a new test (or Radar > Create Test). You can name it anything you like.

1. Add a Request

After creating a test, click Add Request to create a new HTTP request template. The template is pre-configured with some sample data:

New HTTP request

Our sample URL is guaranteed to return a 200 OK status code. Later on, when building your own tests, you can define requests with your own methods, URLs, headers, parameters, or body content.

2. Define Assertions

With a request added, we can move on to defining expected response data. Click on the request to expand it, and view its details. Select Assertions, and add the following assertions (we've created one for the status code automatically):

Sample API test assertions

The assertions are evaluated after the request is executed for every test run. If any assertion fails, the test will fail. For your tests, you can create assertions that check response time, JSON or XML content, HTTP response headers and more.

3. Run Your Test!

Click Save & Run to start a new test run. The request will be executed and upon completion, each assertion will be checked. If everything checks out, you should see that the test run Passed. Select the test run from the results list to view the full HTTP request, response and test output.

Next Steps

Next: Assertions →

Everything is going to be 200 OK

Sign Up — Free