The API Test helps you monitor the performance of your APIs by generating pre-configured test calls and monitoring the API response.
API Test Properties |
|
|---|---|
| Name | A name used to identify this test. |
| Description | Optional additional information about the test |
| Label | Optional Label to assign to this test. (learn more about labels.) |
| Script (dropdown menu) | The scripting language used to create the test API call. (Selenium or Javascript) |
| Script (text field) | The API call script. For information on API Test scripting, read the API Test Scripting Guide. |
| Location | The Product/Folder location of this test (read only) |
| Status | Determines whether this test is current Active or Inactive |
Supported Metrics | |
|---|---|
| # Connections | The total number of TCP connections established during the test. |
| # DNS Failures | The number of times the system was unable to resolve the domain from the endpoint to an IP address. |
| # Purged Runs | The number of test runs manually excluded from calculation for purposes of SLA accuracy. |
| # Runs | Total number of test runs for the defined time period. |
| % Adjusted Availability | Ignoring any purged runs, the percentage of test runs where the enpoint was reached and the test was completed (i.e. there was not a Test Error.) |
| % Availability | The percentage of test runs where the endpoint was reached and the test was completed (i.e. there was not a Test Error.) Availability is calculated as: (# Test Runs - # Test Errors) / # Test Runs |
| % Downtime | The percentage of test runs where the endpoint was unavailable, unreachable, or otherwise failed.) Downtime is calculated as: # Failures / # Test Runs |
| % Frustrated | The percentage of test runs that exceeded the Apdex “frustrated” threshold. |
| % Not Frustrated | The percentage of test runs that completed in less time than the Apdex “frustrated” threshold. This is equivalent to: % Satisfied + % Tolerating |
| % Satisfied | The percentage of test runs that completed in less time than the Apdex “Satisfied” threshold. |
| % Tolerating | The percentage of test runs that exceeded the Apdex “Satisfied” threshold but completed in less time than the “Frustrated” threshold. |
| Apdex | A scoring mechanism that translates performance metrics of diverse applications into generic “User Satisfaction” levels using predefined response time thresholds. You can use default Apdex thresholds or configure your own on a per basis. For more details about Apdex, visit http://www.apdex.org/ |
| Connect (ms) | The time it took to establish a TCP connection with the server. |
| DNS (ms) | The time it took to resolve the domain name to an IP address. |
| Downloaded Bytes | The total number of downloaded bytes from the endpoint. |
| Experience Score | A composite metric that captures the overall experience of a user on a scale of 0-100. |
| Response (ms) | The total time from the initial request until receiving the last packet of response data. |
| Server Response (ms) | The time from when DNS was resolved to receiving the last response packet from server. (This shows the server response exclusive of DNS times) |
| SSL (ms) | The time it took to complete the ssl handshake with the server. |
| Test Time (ms) | One cohesive metric that applies to all test types and indicates the total duration of the test run. Test Time is equivalent to Response, Test Response (Transaction and web tests) and ping RTT (Trace Route tests), and is used when calculating Apdex. Test Time is not available for Request, Host, or Zone charting. |
| Throughput | Measures how efficiently the system was able to retrieve all elements in kilobytes per second. Throughput is calculated as follows: Throughput = Size / Timewhere: Size = (FileSize + HeaderSize)/1024 *converts from bytes to KBs Time = (Wait + Load)/1000 *converts from ms to seconds |
| Time To First Byte (ms) | The total time from the initial DNS request to receiving the first response packet from the server. This is calculated as: |
| Total Downloaded Bytes | The total number of downloaded bytes. |
| Wait (ms) | The time from when the request was sent to the server until the first response packet was received. (Known as "First Byte" in some tools) |