How to retrieve the list of public dashboards via REST API ?

This article offers comprehensive guidance to retrieve the list of public dashboards for the current user via REST API.

Authorization

To execute this action, please ensure that an access token is included in your request header. For details on obtaining the access token, please refer to the relevant documentation here.

Authorization: bearer <token>

Self-Hosted Server

For self-hosted instances, use the following endpoint:

https://{yourdomain}/bi/api/site/<site_identifier>/v5.0/dashboards/public

By following these steps, you can easily find the Dashboard ID for your needs.

Bold BI Cloud Server

For Bold BI Cloud instances, the endpoint is:

https://{yourdomain}/bi/api/v5.0/dashboards/public

Request Type

• GET: This request type is used to retrieve the list of public dashboards for the current user.

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 OK: The list of public dashboards was retrieved successfully.

Sample Response

[
   {
       "Id": "f989acf6-67e7-4f32-b4cb-38fb9e4d4a5c",
       "ItemType": "Dashboard",
       "Name": "Sales Analysis Dashboard",
       "Description": "This dashboard visualizes data that provides a quick and easy way to monitor and analyze sales performance. It displays the key performance indicators (KPIs): total sales, total orders, total products, sales by channel, top 5 countries by sales, top 5 products sold, total orders by shipping mode, top 5 companies by sales, and product details. These metrics help sales teams and management to track progress toward sales goals, identify areas for improvement, and make informed decisions based on data.",
       "CategoryId": "4c9c954b-8aa5-483d-b098-8e0cdb412855",
       "CategoryName": "Sales",
       "CategoryDescription": "",
       "CreatedById": 1,
       "CreatedByDisplayName": "Raghul Umashangar",
       "ModifiedById": 1,
       "ModifiedByFullName": "Raghul Umashangar",
       "CreatedDate": "08/28/2024 11:00 AM",
       "ModifiedDate": "08/28/2024 11:02 AM",
       "ItemCreatedDate": "2024-08-28T11:00:46",
       "ItemModifiedDate": "2024-08-28T11:02:21",
       "IsMultiTabbedDashboard": false,
       "IsFavorite": false
   },
   {
       "Id": "5d6383a7-2ffe-473e-9a7a-948f21fe0eef",
       "ItemType": "Dashboard",
       "Name": "Energy Sustainability Dashboard",
       "Description": "This Energy Sustainability Dashboard provides real-time monitoring, analysis, and visualization of energy consumption, production, and carbon footprints, promoting informed decisions for sustainable practices across residential, commercial, industrial, and transportation sectors.",
       "CategoryId": "6ee95a88-4342-40bb-8f55-ce34d4e141e2",
       "CategoryName": "Sustainability",
       "CategoryDescription": "",
       "CreatedById": 1,
       "CreatedByDisplayName": "Raghul Umashangar",
       "ModifiedById": 1,
       "ModifiedByFullName": "Raghul Umashangar",
       "CreatedDate": "08/28/2024 11:01 AM",
       "ModifiedDate": "08/28/2024 11:02 AM",
       "ItemCreatedDate": "2024-08-28T11:01:03",
       "ItemModifiedDate": "2024-08-28T11:02:06",
       "IsMultiTabbedDashboard": false,
       "IsFavorite": false
   }
] 

• 204 No Content: The public item list is empty; there are no public dashboards available.
• 400 Bad Request: The content of the request body is missing or incomplete.
• 401 Unauthorized: Access denied; the provided token is invalid or missing.
• 405 Method Not Allowed: The request type was not GET; ensure you are using the correct HTTP method.
• 417 Expectation Failed: Failed to get public items; there may be an issue with the request.

Additional References

To know more about Bold BI APIs