...
The scenario to run is specified in the Request Body using either a Scenario Name or a Scenario ID. Generally, the scenario name will be used in the request body along with a set of options which define how the scenario should be run. The scenario ID will be returned in the Response Body of the API call and can be used on subsequent calls to the API to get the status of or abort the scenario.
Return Load Test Metrics
A number of metrics related to a load test result can be returned from the LTP API using the following call:
Code Block |
---|
curl -X GET --url "https://api-alt-us1.apicasystems.com/v1/selfservicejobs/id/summary?token={users_api_token}" |
Metric | Description |
---|---|
Average network connect time (ms) | Displays the time to open a new network connection to the web server before data is sent (socket open time) |
Average network throughput | The average value of the total network bandwidth which was generated by the Load Test |
Average network throughput unit of measurement | The unit of measurement of the average network throughput, e.g. KBit/s or MBit/s |
Average response time per loop (s) | The measured average response time per web surfing session. The average is calculated over all web pages, simulated users and loops |
Average response time per page (s) | The measured average response time per page. The average is calculated over all web pages, simulated users and loops |
Average session time per loop (s) | The measured average time of the web surfing session per executed Load Testing Loop - including all users' think times. The average is calculated over all simulated users and loops |
Http keep-alive efficiency | Displays the percentage of re-used network connections. This value is only greater than zero if the HTTP protocol version 1.1 has been used and the web server supports the 'keep-alive' option |
Session failure rate (soft errors, %) | The proportion of failed loops with errors that do not hinder the page from being downloaded, e.g. a missing style sheet or image file. Soft errors do not block the completion of the loop |
Total failed loops | The number of loops, i.e. web surfing sessions, which have failed |
Total http(s) calls | The total number of HTTP(S) calls during the load test |
Total passed loops | The number of loops, i.e. web surfing sessions, with no errors |
Total transmitted bytes | The total amount of data transmitted during the URL calls of the load test |
Url error rate (hard errors, %) | The proportion of failed loops with fatal errors that block the page load, e.g. HTTP 404 or 500. Hard errors block the completion of the loop |
Web transaction rate (Hits/s) | The measured number of successful completed URL calls per second (hits per second), counted over all simulated users |