This page describes the way to get access to the HeyQL REST API by using "HeyQL Metrics for JIRA".

For a more general api documentation please read REST API.

Getting an api key

Every interaction with our REST API needs a valid api key, which must be part of the used URL.

HeyQL Metrics for JIRA provides an api key inside the Configuration page, if the REST API was activated.

Testing the REST API

You can simply perform actions to HeyQL's REST API by visiting the interactiver API documentation.

There for instance you can perform a GET operation to retrieve all metrics of your JIRA instance.

Function De/Activation page

Executed REST request against HeyQL's REST  API