How to Get the List of Draft Dashboards using REST API

This article offers comprehensive guidance to retrieve the list of draft 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/drafts

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

Request Type

• GET: This request type is used to retrieve the list of draft 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: List of draft dashboards has been retrieved successfully.
• 204: Items not found.
• 401: Access denied.
• 403: Access denied for the item.
• 405: Request type was not GET.