Please open a support ticket to enable access to the API from your IP addresses.

LoadView has an easy to use API that provides access to the Loadview Test datasets. Leverage simple HTTP(S) requests to the LoadView API to query stress test data and results, clone existing tests, and run or abort a stress test. You can develop a software application that uses LoadView capabilities or integrate LoadView service functionality into your own environment. This article gives you a general introduction to the LoadView API and the methods available to create the custom requests.

Adding Integration Unique Identifier

To set up an integration with LoadView, you must have access to an active LoadView account and create a Load Testing Web API Unique Identifier to use in the authentication request:

  1. Log in to the LoadView account.
  2. In LoadView, create an integration UID under Configure > Integrations > Add Integration > Load Testing Web API.

Available Methods

You need to be authenticated before any API request. Authentication expires after 60 seconds of inactivity.

The table below shows which actions are supported.

Request Method URI(s) Description
GET /StressTest Return the list of available tests.
GET /StressTest/{id}/Clone Create a new test by cloning the existed one.
POST /StressTest/{id}/Run Start a test. Change the status of the test to RUN.
GET /StressTest/{id}/AbortTest Abort test execution at any stage. Change the status of the test to AbortTest.

No test results are returned.

GET /StressTest/{id}/StopLoad Stop load emulation. Change the status of the test to StopLoad.
GET /StressTest/{id}/Result Get the test results by ID.
GET /StressTest/{id} Get the test settings by ID.

Error Handling

Upon receiving both API method errors, or errors generated when a test was not started due to exceeding package limits or absence of available LIs, the LoadView API returns an HTTP code 400. For more information, see  Error Handling.