How to get a Dashboard programmatically?

Hello everybody,

how do I get a Dashboard by JavaCode. The Dashboard has already been created in JIRA and I want to access this dashboard. Is there any possibilities to get the dashboard by id or name.

An answer would help me to go on with the development of my JIRA Plugin.

2 answers

1 accepted

Thx for the advice. I've already seen this Service. Can you give a Code Sample, please?

ComponentAccessor.getComponent(PortalPageService.class).getPortalPage(new JiraServiceContextImpl(user), dashboardId)

Try this.

how do I get/find the dashboard id?

I know it doesn't belong to the question above, but are there any event listener for dashboards? For example when you update an dashboard, an event will be triggered in the background.

OK, the dashboard Id can be found in the URL as an URL parameter leading to your dashboard. This URL parameter is the selectPageId corresponding to your dashboard id.

E.g.: http://host/jira/secure/Dashboard.jspa?selectPageId=10201

Is there a possibility now to get all the gadgets with the portalpage-instance or do I need another approach?

It would be very helpful again if you show me a sample code.

Suggest an answer

Log in or Join to answer
Community showcase
Sarah Schuster
Posted Jan 29, 2018 in Jira

What are common themes you've seen across successful & failed Jira Software implementations?

Hey everyone! My name is Sarah Schuster, and I'm a Customer Success Manager in Atlassian specializing in Jira Software Cloud. Over the next few weeks I will be posting discussion topics (8 total) to ...

3,156 views 13 19
Join discussion

Atlassian User Groups

Connect with like-minded Atlassian users at free events near you!

Find a group

Connect with like-minded Atlassian users at free events near you!

Find my local user group

Unfortunately there are no AUG chapters near you at the moment.

Start an AUG

You're one step closer to meeting fellow Atlassian users at your local meet up. Learn more about AUGs

Groups near you
Atlassian Team Tour

Join us on the Team Tour

We're bringing product updates and pro tips on teamwork to ten cities around the world.

Save your spot