How do I export a report with the Cloud Reporting API?

In Bold Reports® Cloud, users with read access to reports can export them with the REST API by providing the report details and export type (Microsoft Excel, PDF, HTML, PPT, CSV, XML or Word) in the request body. The response will be an array of bytes.

How to export a report using the REST API

To export a report, send a POST request to reporting/api/site/v1.0/reports/export with an access token and a JSON body that contains the report ID and export type.

Before you export a report with 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 reporting/api/site/v1.0/reports/export for export report.

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

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

  6. In the body, enter the report ID and export type as JSON, for example {"ReportId":"<report-id>","ExportType":"Pdf"}.

  7. Click Send. The response returns the exported file as an array of bytes. Postman export request body with report ID and export type

Frequently asked questions

How do I export a report with filter parameters?

Follow Export the report with filter parameter using API. That request passes the report ID and export type in the path and the filter values in JSON.

How do I send the access token in the export request?

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

Where is the export report API reference?

The export operation is documented in the REST API v1.0 reference.