How to Export Dashboard with Filter using Bold BI REST API

Authentication

When you sign in to Bold BI, an authentication token is provided that should be attached in the request header (Authorization) for all subsequent API calls to authenticate the requests. To get the authorized token, refer to the following help documents:

• Password Authentication
• Embed Secret Authentication

Refer to the screen shot below to get the authorization token. For the token API, use the content type x-www-form-urlencoded or application/json

Use the generated authorization token in the request header. Refer to the sample request header as shown below.

API Endpoint

Sample URL for Bold BI Embedded Analytics Server:

{domain_name}/bi/api/site/{site_identifier}/v4.0/dashboards/export

Replace{domain_name} with your server’s domain name and{site_identifier} with the unique identifier of the site.

Sample URL for Bold BI Cloud Analytics Server:​​​

{domain_name}/bi/api/v4.0/dashboards/export

Replace {domain_name} with your server’s domain name

Request Body

Sample Request Body for Single Value in Filter Parameter

{
    "DashboardId": "2023a285-6889-4de5-83dc-a6172e490ece",
    "ServerPath": "Health Care",
    "ExportType": "Pdf",
    "FilterParameter":"Department= Cardiology"
}

Sample Request Body for Multiple Values in Filter Parameter

{
    "DashboardId": "2023a285-6889-4de5-83dc-a6172e490ece",
    "ServerPath": "Health Care",
    "ExportType": "Pdf",
    "FilterParameter":"Department= IN(Cardiology,Neurology)"
}

Sample Request Body for Multiple Columns in Filter Parameter

{
    "DashboardId": "2023a285-6889-4de5-83dc-a6172e490ece",
    "ServerPath": "Health Care",
    "ExportType": "Pdf",
    "FilterParameter":"Department= Cardiology & Year(Date)=2021"
}

Note: To know more about supported operators and parameters in filter value, please refer to the Filter Value documentation.

Response Schema

Sample Response

Additional References

• Export Dashboard - Bold BI REST API Reference
• Site Information
• Generate Embed Secret using API
• Embed Secret Settings