How to Update Dashboard Settings Details of a Specific Site Using the REST API

This article provides guidance on how to update dashboard settings of a specific site using the REST API. Users who have admin rights permissions to dashboard settings can update the dashboard settings.

Note: Cannot set true or enable performance metrics/query metrics, when usage analytics is disabled.

Authorization

To perform this action, an access token must be included in the request header. For details on obtaining the access token, please refer to the relevant documentation here.

Authorization: bearer <token> 

Endpoints

Self-Hosted Server

https://{yourdomain}/bi/api/site/<site_identifier>/v6.0/settings/dashboard-settings

Bold BI Cloud Server

https://{yourdomain}/bi/api/v6.0/settings/dashboard-settings

Request Type

• PUT: This request type is used to update dashboard settings through an API request.

Steps to Update Dashboard Settings Details of a Specific Site Using the REST API

1. Configure the Endpoint
   In your API client, set the request to PUT and use the endpoint:

https://{yourdomain}/bi/api/site/<site_identifier>/v6.0/settings/dashboard-settings

2. Add the Authorization Header
   Include the access token in the request headers:

Authorization: bearer <token> 

• In the Body tab, select raw and set the format to JSON. Provide the details in the following structure

{
 "MakePublicEnabled": true,
 "DefaultViewsEnabled": true,
 "AutoSaveEnabled": true,
 "ThemingEnabled": true,
 "UsageAnaylticsEnabled": true,
 "PerformanceMetricsEnabled": true,
 "QueryMetricsEnabled": true
}

Request Body Schema

• MakePublicEnabled: boolean
  Specify true to enable public dashboard setting.

• DefaultViewsEnabled: boolean
  Specify true to enable default views setting.

• AutoSaveEnabled: boolean
  Specify true to enable autosave filter setting.

• ThemingEnabled: boolean
  Specify true to enable dashboard theming setting.

• UsageAnalyticsEnabled: boolean
  Specify true to enable usage analytics dashboard setting.

• PerformanceMetricsEnabled: boolean
  Specify true to enable the performance metrics dashboard setting.

• QueryMetricsEnabled: boolean
  Specify true to enable the query metrics dashboard setting.

• Example JSON Data

{
 "MakePublicEnabled": true,
 "DefaultViewsEnabled": true,
 "AutoSaveEnabled": true,
 "ThemingEnabled": true,
 "UsageAnaylticsEnabled": false,
 "PerformanceMetricsEnabled": false,
 "QueryMetricsEnabled": false
} 

4. Send the request
   Execute the request by pressing Send icon. If the request is successful, it will return the response as true.

API Output

Responses

• 200 - Dashboard settings have been updated successfully.
• 400 - The content of the request body is missing or incomplete.
• 401 - Access denied.
• 405 - Request type was not PUT.
• 417 - Failed to update site settings details.
• 500 - Error in database while executing the query.

Additional References

• REST API - Settings
• How to Retrieve the Dashboard Settings Details of a Specific Site