How do I create a dashboard view using Bold BI REST API?

Published:

This article explains how to create dashboard views (filtered views of dashboards) using the REST API in Bold BI. The API allows you to create a new dashboard view with specific filters and settings.

Endpoint

Parameter	Value
URL	Cloud BI: {your_domain}/bi/api/v4.0/dashboards/views Embedded BI: {your_domain}/bi/api/site/{site_identifier}/v4.0/dashboards/views
Method	Post
Content Type	application/json
Authorization	bearer< token>

Request Body Schema

{
  "ViewName": "string",
  "ItemId": "string<guid>",
  "ChildItemId": "string<guid>",
  "QueryString": "string",
  "IsPublic": boolean
}

Sample Response Body

{
  "ViewName": "DateView",
  "ItemId": "ba2f719d-466c-442b-b895-23f74e74871c",
  "ChildItemId": "06af4ee8-6a74-4019-ba34-c8345425604a",
  "QueryString": "Year(OrderDate)=1996",
  "IsPublic": true
}

API Parameters

Parameter	Required	Description
ViewName	Yes	The name of the dashboard view
ItemId	Yes	The ID of the dashboard
ChildItemId	No	The ID of the child dashboard, if provided ItemId is multi-tab dashboard's ID
QueryString	Yes	The filter value for the widget. You can mention the column name and the corresponding value in the query string. You can also add multiple filter values in this parameter, like 'ShipCountry=“USA”&ShipCity=“San Francisco” ’
IsPublic	Yes	True to set the dashboard view as public

Response

{
  "ApiStatus": true,
  "Data": {},
  "Status": true,
  "StatusMessage": "string",
  "Message": "string"
}

Conditions

If the user has Read access in Specific Dashboards scope, then the user can create Dashboard Views in those dashboards.
The created Dashboard Views cannot be updated/deleted by other users.
The owner of the Dashboard View only has share permission on the Dashboard View.
The shared Dashboard Views can be modified and saved as another view as the users cannot modify the actual ones.