API Reporters

What are API Reporters?

Qase API reporters are packages we maintain to help you integrate your automated testing framework with Qase. Think of them as the bridge between your test code and your test runs in Qase — they collect your test results and push them into Qase automatically, so you can track everything in one place.

We’ve got reporters for a range of frameworks including, in JavaScript, Python, Java, PHP, and more. You’ll find all of them on our GitHub. If your framework isn’t supported out of the box, don’t worry — you can use our SDKs and public API to build a custom integration.

We provide pre-generated API clients for Python, JavaScript, Java, and Go — these are created using OpenAPI Generator. If you need a client in a language we don’t support yet, you can generate your own using our API spec.

All reporters are built on top of the Qase API, which follows standard REST conventions. All Reporters these endpoints:

• GET /project
• POST /run/{code}
• POST /result/{code}/{id}/bulk
• PATCH /run/{code}/{id}/complete

You’ll find more endpoints in the full API reference, along with everything you need to build your own client or integration.

Where Should I Start?

We recommend starting with the introduction pages next — they’ll guide you through:

• Picking the right reporter for your framework
• Configuring it for your test setup
• Running your tests and reporting results
• Common troubleshooting tips

After this, you can dive into the specific reporter documentation for your language, with code examples and config options to help you get up and running quickly.

Error Codes