For AI agents and LLMs: a machine-readable index is available at llms.txt. A plain-Markdown version of any documentation page is available by appending .md to its URL.
Skip to main content
Performance TestingRetrieve a summary of performance testing results for a specific job.
TestMu AI
StatusCommunityBlog
Performance Testing

Retrieve a summary of performance testing results for a specific job.

This API provides an overview of performance test results for a given job, including job ID, execution time, duration, request count, bandwidth, throughput, response times, ramp time, and user count. It helps assess the system's overall performance and scalability.

GET
/v1.0/performance/summary/{jobId}
Retrieve a summary of performance testing results for a specific job.
curl --request GET \
--url "https://api.hyperexecute.cloud/v1.0/performance/summary/{jobId}" \
--header "Authorization: Basic <encoded-value>"
{
"type": "summary",
"data": {
"job_id": "493bac0f-e412-445b-b85a-88df79f56de3",
"start_timestamp": "2025-10-16T08:11:21.000000000Z",
"end_timestamp": "2025-10-16T08:13:06.000000000Z",
"duration": 105000,
"total_requests": 669,
"total_errors": 668,
"error_rate": 99.85052316890882,
"avg_bandwidth": 0,
"avg_throughput": 9.416666666666666,
"min_response_time": 0,
"max_response_time": 6127,
"avg_response_time": 570.9144927998836,
"avg_latency": 570.9144927998836,
"ramp_time": 0,
"users": 1
}
}

Authorizations

Authorizationstringheaderrequired

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Path Parameters

jobIdstringrequired

Enter your HyperExecute JobID

Response

application/json

Successful operation

typestringrequired

Type of response data

dataobjectrequired
data.job_idstring
Example: "493bac0f-e412-445b-b85a-88df79f56de3"
data.start_timestampstring
Example: "2025-10-16T08:11:21.000000000Z"
data.end_timestampstring
Example: "2025-10-16T08:13:06.000000000Z"
data.durationnumber
Example: 105000
data.total_requestsnumber
Example: 669
data.total_errorsnumber
Example: 668
data.error_ratenumber
Example: 99.85052316890882
data.avg_bandwidthnumber
Example: 0
data.avg_throughputnumber
Example: 9.416666666666666
data.min_response_timenumber
Example: 0
data.max_response_timenumber
Example: 6127
data.avg_response_timenumber
Example: 570.9144927998836
data.avg_latencynumber
Example: 570.9144927998836
data.ramp_timenumber
Example: 0
data.usersnumber
Example: 1
Retrieve a summary of performance testing results for a specific job.
curl --request GET \
--url "https://api.hyperexecute.cloud/v1.0/performance/summary/{jobId}" \
--header "Authorization: Basic <encoded-value>"
{
"type": "summary",
"data": {
"job_id": "493bac0f-e412-445b-b85a-88df79f56de3",
"start_timestamp": "2025-10-16T08:11:21.000000000Z",
"end_timestamp": "2025-10-16T08:13:06.000000000Z",
"duration": 105000,
"total_requests": 669,
"total_errors": 668,
"error_rate": 99.85052316890882,
"avg_bandwidth": 0,
"avg_throughput": 9.416666666666666,
"min_response_time": 0,
"max_response_time": 6127,
"avg_response_time": 570.9144927998836,
"avg_latency": 570.9144927998836,
"ramp_time": 0,
"users": 1
}
}