Get custom JQL from a gadget in a dashboard via API

[Asier Vadillo]

So I want to get the custom JQL of every gadget in every dashboard. I hoped that the endpoint https://your-domain.atlassian.net/rest/api/3/dashboard would be enough, but it is not.
I then tried https://your-domain.atlassian.net/rest/api/3/dashboard/10201/gadget, but it only gives you the ID, title, position, etc. of the gadget — not really useful information.

Is there any way to get this info?

My main objective is to check if there is a dashboard that uses a custom JQL with the name of a status that has been changed. We have a lot of dashboards, and it’s not viable to search through each one manually for this information.

Thanks in advance!

[Marc - Devoteam]

Hi @Asier Vadillo 

Reviewing the rest API inside of Jira Cloud, it shows that there is no single way to get this information.

To do this, you first need to call the Get Dashboard Gadgets endpoint documented here to return a list of all gadgets on the dashboard and to store their ID's in a variable.

You then need to call the Get Dashboard Item Property Key for each ID using the property key of config to get details of the configuration of each dashboard gadget and if it has a filterId in its config, then you can extract this to update.

I hope this information helps.

[Asier Vadillo]

Hello @Marc - Devoteam Thanks for the response,

When I get the Gadgets for a Dashboard I get something like:

{

"id": 11657,

"moduleKey": "com.atlassian.plugins.atlassian-connect-plugin:com.oldstreetsolutions.atlassian.jira.custom-charts__custom-chart-dashboard-item",

"color": "blue",

"position": {

"row": 4,

"column": 0

},

"title": "chart title"

}

What do I do with that info and the Get Dashboard item Property Key? Are all gadgets Items? Every field of the Json I displayed are the properties? If true I don't see any property that will show me the filter or custom JQL that is being used.

[Marc - Devoteam]

Hi @Asier Vadillo 

The gadget you are referring to is not an ootb Jira gadget, but a gadget from a 3rd party app.

Namely, Custom Charts for Jira.

But Yes, all fields shown are properties, you will need the property "id".

But as mentioned, could be that you can't get more information as its not an ootb gadget.

[Lucas Knorr]

Hi @Asier Vadillo

Since most gadgets are based on filters, you should query filters instead of dashboards, as the gadgets typically use filters saved in the system.

You can query the filters via this endpoint. As an admin, you’ll be able to access all filters by providing the overrideSharePermissions parameter.