How to search JQL used in dashboards/filters

[Julie Beltz]

We are moving a JSM request type from one project to another.  However, we are finding that a lot of users built their dashboard JQL with the request type name and project,  like Get Help (IS).   Is their a way to search all dashboards / filters JQL statements to see if they have it with the project name so we can fix it?    Otherwise, we have to wait for them to realize they are missing tickets and ask for help.

[David Nickell · Accepted solution]

You can get a list of filters and associated JQL with the REST APIs.   First, if you are logged into your atlassian site, try this in a browser (using your site):

https://ecosystem.atlassian.net/rest/api/3/filter/search?expand=jql&maxResults=100

you should see something like this:

  "self": "https://ecosystem.atlassian.net/rest/api/3/filter/search?expand=jql&maxResults=100&startAt=0",
  "nextPage": "https://ecosystem.atlassian.net/rest/api/3/filter/search?expand=jql&maxResults=100&startAt=100",
  "maxResults": 100,
  "startAt": 0,
  "total": 5159,
  "isLast": false,
  "values": [
    {
      "expand": "description,owner,jql,viewUrl,searchUrl,favourite,favouritedCount,sharePermissions,editPermissions,isWritable,approximateLastUsed,subscriptions",
      "self": "https://ecosystem.atlassian.net/rest/api/3/filter/63457",
      "id": "63457",
      "name": "!disturbed Rotation",
      "jql": "project = 28214 AND reporter = 5cb4ae0e4b97ab11a18e00c7"
    },
    {
      "expand": "description,owner,jql,viewUrl,searchUrl,favourite,favouritedCount,sharePermissions,editPermissions,isWritable,approximateLastUsed,subscriptions",
      "self": "https://ecosystem.atlassian.net/rest/api/3/filter/71681",
      "id": "71681",
      "name": "\"Overall time to done\" breached since Jan 1",
      "jql": "\"Overall Time to Done\" = everBreached() AND project = 28452 AND created \u003E= 2025-01-01 AND summary !~ \"Partner verification\" AND (issuetype = \"App Review\" OR issuetype = \"CF Approval Request\" OR issuetype = \"DC App Approval Request\")"
    },
    {
      "expand": "description,owner,jql,viewUrl,searchUrl,favourite,favouritedCount,sharePermissions,editPermissions,isWritable,approximateLastUsed,subscriptions",
      "self": "https://ecosystem.atlassian.net/rest/api/3/filter/64602",
      "id": "64602",
      "name": "(ECOHELP) Open Internal Escalations",
      "jql": "statusCategory != Done AND \"Internal Escalation[Checkboxes]\" is not EMPTY AND status in (\"Waiting for Internal Team\") ORDER BY \"Severity level\" ASC, \"Time to resolution\" ASC"
    },

You can download the results into a text file as a one time exercise.

If you have more than 100 filters, you will need to decide if this method is usable (using the "next" link provided in results until you get them all).  Or if you prefer, I can whip up an excel sheet for you with the paginated results (meaning you'd get them all at once).   It won't take a minute and I won't charge you anything.  

Good luck

[Bill Sheboy]

Hi @Julie Beltz 

Yes, and...to the suggestions from @David Nickell 

Some addon / marketplace dashboard gadgets do not use Jira saved filters, and thus would need additional investigation to identify the JQL / settings they use.  Please check with your Product Admin to learn of any such gadgets and their usage.

Kind regards,
Bill

[Julie Beltz]

Thanks @David Nickell . We definitely have more than 100. Excel would be amazing.  Our environment has gotten out of hand and changing the name of a request type or moving it wreaks havoc.

[David Nickell]

Cool.... I have created and tested the spreadsheet against my own installation and am currently running a second test against the ecosystem site.   To use the spreadsheet the first time, you will need to provide three parameters (URL, Email, and an API Token).   I have instructions on how to do that on the first tab.    You may also be prompted for how to connect (ANONYMOUS) and/or privacy (ORGANIZATION). 

The ecosystem test is still running -- I see from what I posted above there are over 5,000 filters.  This may take a few more minutes. 

I can't attach a file to a post like this, so I'll add a link here to my website when it is ready.  Or, you can send me an email (dnickell3030@gmail.com).  I'll send the file to you and we can address any questions via email outside of the forum.

Let me know how you want to proceed.   And "REST Easy" as I like to say.  ;-)  

[Trudy Claspill]

Hello @Julie Beltz 

There is not a native method to do that through the UI.

You might be able to accomplish it through multiple API calls that would get all the gadgets from all the dashboard, check if they are based on a filter, then API calls to retrieve all those filters, then parsing through the retrieved filter output for references to the project. I'm not guaranteeing it could be done because I have not tried to work out the details. 

Do you have the skill set and the time to invest in this?

You might also explore the Atlassian Marketplace to see if there is an app that could help. I don't know of any specific apps that match this scenario, but that doesn't mean one doesn't exist.

[Julie Beltz]

Thanks @Trudy Claspill .  We don't have the skillset in house.  I've tried looking on Marketplace and haven't found a match but might not be using right words.

[Trudy Claspill]

It sounds like @David Nickell is willing to do the work for you.