How to Export Filtered Data Using the Dashboard Export REST API in Bold BI

This article explains how to export dashboards with filtered data when using the export REST API. You can achieve this by using either of the approaches described below.

Approach 1: Apply Filters Using filterParameter in the API Request Body

You can directly apply filters to the exported data by passing the required filter values in the filterParameter section of the request body.

Example Request Body

• Specify the field name
• Provide the filter value(s)
• The export API will return the data that matches the filter conditions. This allows the exported file to include only the filtered data. For more details, you can refer to this article.

Approach 2: Export Dashboard Using an Embedded Application Token (With Filters Included)

If your dashboard is embedded in your application, you may already be generating an embed token that includes the filter values applied in your backend. In that case, you can use the same token in the Export Dashboard REST API to export the data.

How it Works:

You apply filters in your backend before rendering the dashboard

These filters become part of the embedded token.

When exporting using the API, you can use the same token to export data without passing any additional filter parameters.
The export API automatically applies the filters included in the token.

Note: This support is available starting from version 15.1.

Conclusion:

Both approaches allow you to export filtered data:

• Use Approach 1 if you want to send filters directly in the export API request.
• Use Approach 2 if you are embedding dashboards and want to use the access token that already contains filters.

Additional References:

How to export dashboard data at the UI level
How to Schedule a Dashboard View Export in Bold BI