Skip to main content
POST
Download Report

Overview

Downloads the generated report in the required format such as docx, pdf, and json. The format is passed in the request body.

Endpoint Details

  • Method: POST
  • Endpoint: /api/assets/download_report/

Authentication requirements

  • Include a valid JWT token in your request header
  • If you don’t have a token yet, you can get one from the /auth/token/ endpoint first.

Request

Request Parameter

Header Parameters

Authorization
string
required
JWT token obtained from the Authentication request

Body Parameters

file_type
string
required
Export format. Permitted values: “pdf”, “docx”, “json”
report_id
integer
required
Id of the report to be exported

Response

Successful response will include download the file in the specified format

Authorizations

Authorization
string
header
required

JWT token obtained from the /auth/token/ endpoint.

Body

application/json
report_id
integer
required

ID of the report to be exported.

Example:

84102

file_type
enum<string>
required

Export format.

Available options:
pdf,
docx,
json
Example:

"json"

Response

Report downloaded successfully. Returns binary file for pdf/docx, or structured JSON data for json format.

Structured report data (returned only when file_type is json).