Getting dashboard data via API

Answered

Follow

Amir Kutscher

January 09, 2018 16:03

Hi

Is there an API to retrieve dashboard-specific data (widgets, filters etc.)?

Thanks

Amir

1

• 

  Moti Granovsky January 09, 2018 16:29 (Edited January 09, 2018 16:30)

  Hi Amir,

  Of course there is - the Dashboards API v1.0

  For example, you can retrieve a dashboard by ID:

  http://localhost:8081/api/v1/dashboards/588149043aadeb6c43000012

  Which will return a JSON containing various fields such as datasource (the cube used), filters, and layout.

  The layout is comprised of cells, and alongside the UX properties like the cell's size, you can find the widget ID for each cell. Subsequently, you can find the dashboard's widgets like so:

  http://localhost:8081/api/v1/dashboards/588149043aadeb6c43000012/widgets

  Which will return an array of all widget objects, or a specific widget like so:

  http://localhost:8081/api/v1/dashboards/588149043aadeb6c43000012/widgets/588149603aadeb6c43000015

  Note: when specifying a widget's or dashboard's ID you need the "oid" property and not the "_id" property!

  You can find more information about these APIs in our Online API Reference / V1 / Dashboards

   

   

  1

  Comment actions Permalink
• 

  Oxana Noa Umansky January 10, 2018 18:06

  Thank you Moti!

  0

  Comment actions Permalink
• 

  Amir Kutscher January 11, 2018 10:25

  Hi Moti

  Thanks for the quick response.

  Will this return the data as well?

  I am interested in retrieving a JSON with the actual data- can this be done?

  Thanks

  Amir

  0

  Comment actions Permalink
• 

  Moti Granovsky January 11, 2018 11:54

  Amir, when you say "return the data as well" do you mean the actual data from Elasticube?

  In that case, no. The Dashboard and Widget REST API return metadata - JSON that describes the dashboards and widgets. The Elasticube data is returned in response to each individual widget's query, composed based on that widget's metadata.

  We do not have an API that will return Elasticube data by Widget ID simply because it's not possible - the query depends on interaction with other aspects such as the user's data security permissions, dashboard filters, etc.

  To get started with understanding how our queries work and how you can extract the actual data behind various widgets, I'd recommend taking a look at our JAQL documentation, as well as these forums posts:

  • Extracting data from widgets
  • Viewing the underlying JAQL & SQL of widgets
  • JAQLine - plugin for query visualization

  It can also be helpful if you could specify what it is you're trying to accomplish. Good luck!

  0

  Comment actions Permalink
• 

  Vikas Sharma September 02, 2019 06:19

  Hi Moti,

  Is there any way that instead of list of widgets by Dashboard id, we get all the widgets and only for those dashboards which are shared with a particular user.

  0

  Comment actions Permalink
• 

  David Hertzberg September 05, 2019 10:34

  Hi Vikas,

  You can do that, but not with only one API call.

  You can also do it through queries in the MongoDB. It will be closer to a script than just one query though.

  Best, David.

  0

  Comment actions Permalink
• 

  Luis Santos August 28, 2020 15:54

  Hi Moti Granovsky
  
  Can we get the JAQL code mentioned on step a here but via API call?
  
  BR

  0

  Comment actions Permalink
• 

  Moti Granovsky August 30, 2020 08:05

  Hi Luis, if you mean specifically REST API and not Javascript API (that's still an API) - the answer is no, unfortunately.

  The JAQL query is constructed on the client side and thus only available there.

  You could construct it yourself based on Dashboard and Widget metadata but of course that's a lot more work than using the JS API method in the link.

  0

  Comment actions Permalink

Please sign in to leave a comment.