Download report

GET

/api/v1/tenants/{tenant_id}/workspaces/{workspace_id}/reports/{report_id}/download

Download report as PDF or Excel file. Permissions: report:download

Authorizations

• HTTPBearer
• HTTPBearer

Parameters

Path Parameters

report_id

required

Report Id

string format: uuid

Query Parameters

format

Format

string

default: pdf /^(pdf|excel)$/

Header Parameters

X-Workspace-ID

Any of:

string

string

null

null

X-API-Key

Any of:

string

string

null

null

X-Tenant-ID

Any of:

string

string

null

null

Responses

200

Successful Response

Examples

200 response example

{
  "status": "ok",
  "message": "Request completed successfully."
}

422

Validation Error

HTTPValidationError

object

detail

Detail

Array<object>

ValidationError

object

loc

required

Location

Array

msg

required

Message

string

type

required

Error Type

string

Examples

422 response example

{
  "detail": [
    {
      "loc": [],
      "msg": "string",
      "type": "string"
    }
  ]
}