How to Unlisting a Dashboard Using REST API
Unlisted dashboards will not be visible to any users other than the owner, but users with the dashboard link can access them directly with permission. This article provides instructions on how to unlist a dashboard from the listing using the 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>
Steps to Unlist a Dashboard
-
Use the following endpoint in Postman with the PUT method:
https://{yourdomain}/bi/api/site/<site_identifier>/v5.0/dashboards/{dashboardId}/unlist
Replace ‘yourdomain’ with your actual domain and ‘site_identifier’ with the appropriate site identifier. You can find the ‘dashboardId’ by referring to the knowledge base article linked here.
-
Then add the token generated from the ‘token’ endpoint above in the Headers with key as ‘Authorization’ and value as ‘bearer {Your_token}’
-
Include the following parameters in the body of the request in JSON format:
{ "IsUnlisted": true }
-
Click Send. On a successful request, you will receive a success response indicating that the Dashboard has been marked unlisted.
NOTE: Only the user who created the dashboard and the Administrator can unlist the dashboard.
Responses
- 200: Dashboard marked unlisted successfully.
- 400: The content of the request body is missing or incomplete.
- 401: Access denied.
- 412: Mark as public has been restricted.
- 417: Failed to mark dashboard as unlisted.