How to get the details of a dashboard using REST API ?

This article offers comprehensive guidance for users who have created dashboards, enabling them to view detailed information on the dashboard effectively via REST API.

Authorization

To execute this action, please ensure that a 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/dashboardId

Steps to Get the Dashboard ID

1. Access the Dashboard: Navigate to the dashboard you wish to retrieve the ID for.
2. Open the Options Menu: Click on the three dots (ellipsis) located in the right corner of the dashboard.
3. Select the Info Icon: From the dropdown menu, click on the info icon.

5. Locate the Dashboard Id: The displayed item ID in the subsequent window is the Dashboard Id you are looking for.

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/dashboardId

Request Type

• GET: This request type is used to view the details of a dashboard.

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: Dashboard detail was retrieved successfully.

Sample Response

{
   "Id": "9b8b84b0-c480-47fd-b074-18f1a172b40a",
   "ItemType": "Dashboard",
   "Name": "Sales Dashboard",
   "Description": "",
   "CreatedById": 1,
   "CategoryId": "73ee8805-30f6-4488-b11a-c895af4d1899",
   "CategoryName": "Test",
   "ItemCreatedDate": "2024-08-26T13:14:49",
   "ItemModifiedDate": "2024-08-27T13:02:36",
   "CreatedDate": "08/26/2024 06:44 PM",
   "ModifiedDate": "08/27/2024 06:32 PM",
   "ModifiedById": 1,
   "Extension": ".sydj",
   "IsPublic": false,
   "IsActive": true,
   "Version": 2,
   "CanRead": true,
   "CanWrite": true,
   "CanDelete": true,
   "IsUnlisted": false,
   "IsMultiDashboard": false
} 

• 400 Bad Request: Item ID is invalid.
• 401 Unauthorized: Access denied for the item.
• 404 Not Found: Item details not found.
• 405 Method Not Allowed: Request type was not GET.

Additional References

To know more about Bold BI APIs