How to get the list of favourite dashboards via REST API ?

This article provides guidance on how to retrieve a list of favorite dashboards for the current user.

Authorization

To execute this action, please ensure a access token is included in your request header. For details on obtaining the access token, please refer to the provided guidelines here.

Authorization: bearer <token>

To get the list favorite dashboards, you will need to send a GET request to the appropriate endpoint based on your server type as shown below :

Self-Hosted Server

For self-hosted instances, use the following endpoint:

https://{yourdomain}/bi/api/site/<site_identifier>/v4.0/dashboards/favorite

Bold BI Cloud Server

For Bold BI Cloud instances, the endpoint is:

https://{yourdomain}/bi/api/v4.0/dashboards/favorite

Request Type

• GET: This request type is used to update the favorite dashboards.

Example Request

Here is an example of how to structure your GET request:

Responses

The API will return different responses based on the outcome of the request:

• 200: List of favorite dashboards was retrieved successfully.

• 204: No favorite items.
• 401: Access denied.
• 405: Request type was not GET.
• 417: Failed to get favorite items.

Additional References

To know more about Bold BI APIs