How to retrieve the dashboard settings details of the specific site via REST API ?
This article explains how to obtain the dashboard settings of a specific site, provided the user has the necessary administrative privileges.
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/settings/dashboard-settings
Bold BI Cloud Server
For Bold BI Cloud instances, the endpoint is:
https://{yourdomain}/bi/api/v5.0/settings/dashboard-settings
Request Type
- GET: This request type is used to how to obtain the dashboard settings details of a specific site.
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:
If the request is successful, the following dashboard setting details will be returned:
-
MakePublicEnabled:
boolean
Indicates if the public dashboard setting is enabled. -
DefaultViewsEnabled:
boolean
Indicates if the default views setting is enabled. -
AutoSaveEnabled:
boolean
Indicates if the autosave filter setting is enabled. -
ThemingEnabled:
boolean
Indicates if the dashboard theming setting is enabled. -
UsageAnalyticsEnabled:
boolean
Indicates if the usage analytics dashboard setting is enabled.
Error Responses
-
401 Access Denied: This response indicates that the user does not have the necessary permissions to access the dashboard settings.
-
405 Request Type Not GET: This response indicates that the request method used is not allowed. Ensure that the request is made using the GET method.
-
417 Failed to Retrieve Dashboard Settings: This response indicates that there was an issue retrieving the dashboard settings. Check the request and try again.
Additional References
To know more about Bold BI APIs
