Articles in this section
Category / Section

How to retrieve widget information from a dashboard through REST API?

Published:

To retrieve widget information such as widget ID and associated query, you can use the following API endpoint. This API end point is applicable only for on-premise Bold BI version.

https://<yourdomain>/bi/api/site/<site_identifier>/v4.0/dashboards/<dashboardID>/widgets

Replace <yourdomain>, <site_identifier>, and <dashboardID> with the appropriate values for your specific use case, and use the GET HTTP method for this API request.

If you are using a cloud tenant, use the below endpoint and change the values of the following properties appropriately <yourdomain>and <dashboardID> .

https://<yourdomain>/bi/api/v4.0/dashboards/<dashboardID>/widgets

API Response

The API response will provide you with the necessary widget information, as shown in the below image.

image.png

Note

An access token is required for this API call. For information on how to get the access token, refer here.

Additional References

To know more about Bold BI APIs
To know more about Widget API

Was this article useful?
Like
Dislike
Help us improve this page
Please provide feedback or comments
SM
Written by Soundarya Mani Meharan
Updated:
Comments (0)
Please  to leave a comment
Access denied
Access denied