Generate interactive API-focused HTML reports directly from Apache JMeter test executions.
The JMeter API Test Report Plugin provides a lightweight reporting solution for API automation and performance testing teams. It generates a consolidated HTML dashboard containing execution statistics, response time metrics, failure analysis, request and response payload details, and interactive filtering capabilities.
Designed specifically for API testing, the plugin helps testers and developers quickly identify failed requests, analyze errors, and share execution results without navigating through multiple JMeter listeners or log files.
Apache JMeter provides built-in reporting capabilities, but API teams often require faster access to failed requests, assertion failures, response details, and execution summaries.
This plugin focuses on simplifying API test result analysis by providing:
- API-centric reporting
- Failure-focused troubleshooting
- Interactive filtering
- Request and response visibility
- Shareable HTML reports
- Dark mode support
- Total Requests
- Passed Requests
- Failed Requests
- Success Percentage
- Test Execution Duration
- Average Response Time
- Minimum Response Time
- Maximum Response Time
- Throughput
- Failure-only filtering
- Response code filtering
- Error message visibility
- Assertion failure tracking
- Request-level execution drill-down
- Failed API identification
- Request payload viewer
- Response payload viewer
- Request method visibility
- Response code visibility
- Timestamp tracking
- Automatic HTML report generation
- Interactive report navigation
- Dark mode support
- Single-file report output
- Easy sharing with QA, Developers, Product Owners, and Stakeholders
| Requirement | Version |
|---|---|
| Apache JMeter | 5.5+ |
| Java | 8+ |
| Maven | 3.x |
Verified with:
- Apache JMeter 5.5
- Apache JMeter 5.6
- Apache JMeter 5.6.1
- Apache JMeter 5.6.2
- Apache JMeter 5.6.3
- Open JMeter
- Navigate to:
Options → Plugins Manager
- Search for:
JMeter API Test Report Plugin
- Click:
Apply Changes and Restart JMeter
Download the latest JAR from the Releases page.
Copy the JAR into:
<JMETER_HOME>/lib/ext/
Restart JMeter.
- Open your JMeter Test Plan.
- Add the listener:
Add → Listener → API Test Report Listener
- Configure the output directory.
- Execute your test.
- Open the generated report.html file in your browser.
Provides an overview of test execution health, including request counts, success percentage, and execution duration.
Displays response time statistics and throughput metrics.
Quickly identify failed requests and investigate associated errors using:
- Failure-only filter
- Response code filter
- Error message visibility
Inspect request and response information directly from the report, including:
- Request payload
- Response payload
- Response code
- Execution status
- Timestamp
Clone the repository:
git clone https://github.com/srenevasanks/jmeter-api-test-report-plugin.gitNavigate to the project:
cd jmeter-api-test-report-pluginBuild the plugin:
mvn clean packageGenerated artifact:
target/jmeter-api-test-report-plugin-1.0.0.jar
Please report issues through GitHub Issues.
When reporting a bug, include:
- Plugin version
- Apache JMeter version
- Java version
- Operating system
- Sample JMX (if possible)
- Screenshot of the report
- Relevant error logs
- PDF export support
- Enhanced API failure categorization
- Improved report performance for large executions
- Failure trend visualization
- Advanced filtering options
- Additional API execution metrics
Contributions are welcome.
- Fork the repository
- Create a feature branch
- Commit your changes
- Push your branch
- Open a Pull Request
Apache License 2.0
Srenevasan
GitHub: https://github.com/srenevasanks