LoadView provides a simple, powerful API that gives programmatic access to your load-testing data and workflows. With straightforward HTTP(S) requests, you can retrieve stress-test results, clone existing tests, and start or abort test runs. This allows you to build applications that leverage LoadView’s capabilities or integrate LoadView functionality directly into your own systems.
This article provides an overview of the LoadView API methods available for creating custom requests.
Available Methods
The table below shows which actions are supported.
| Request Method | URI(s) | Description |
|---|---|---|
| GET | /StressTest | Return the list of all available tests. |
| GET | /StressTest/{id}/Clone | Create a new test by cloning the test with the selected ID. |
| 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. |
| GET | /GroupStressTest | Get a list of Stress Groups. |
| GET | /GroupStressTest/{GroupID}/config | Get Stress Group info. |
| GET | /GroupStressTest/{GroupID}/result | Get Stress Group results. |
| POST | /GroupStressTest/Run | Start the group of load tests and change its status to RUN. |
| GET | /GroupStressTest/{GroupID}/AbortTest | Abort execution of the tests included in the stress group with the specified id and change their status to AbortTest. No test results are returned. |
| GET | /GroupStressTest/{GroupID}/StopLoad | Stop load emulation for the stress group with the specified ID. Results that have been received during the test execution period will be available. |
Error Handling
Upon receiving API method errors—or errors that occur when a test cannot start due to package limits or unavailable LIs—the LoadView API returns an HTTP 400 response. For more details, see Error Handling.
