How do I pass filter parameters when exporting by API?

In Bold Reports® Cloud, users with read access to a report can export it with the REST API. Send the report details, filter parameters, and export type (Microsoft Excel, PDF, HTML, PPT, CSV, XML or Word) in the request body.

How to export a report with filter parameters

Before you export a report with filter parameters through the REST API, make sure you have:

  1. Open the Postman application and create a new POST HTTP request.

  2. First, generate the authentication token.

  3. In request URL, provide your Bold Reports® Report Server URL and append /api/v1.0/reports/{reportId}/{exportType}/export-filter for export report

  4. In the Headers section, add Authorization as the key, and enter bearer followed by the generated token as the value.

Postman Authorization header with bearer token for the export request

  1. In the Body section, select raw, and then select JSON.

  2. Pass the report ID and export type as path parameters, and pass the filter parameter values in JSON.

  3. Click Send. The response is the exported report as an array of bytes.

Postman export request with filter parameter values in the JSON body

Frequently asked questions

What does the export filter API return?

The Bold Reports® Cloud export filter API returns the exported report as an array of bytes.

How is a filtered export different from a plain export?

A filtered export passes report parameter values in the JSON body, so they are applied before export. For a plain export, see Export the report using API.

How do I send the access token in the request?

Add an Authorization header with the value bearer followed by the token. Generate the token first with the Authentication API.