Create report

CreateReport

Description: Generates a report dynamically based on the selected report index and optional filters. The returned format is a structured UI component schema, typically containing titles, tables, or other data blocks.

Access Control

🛡️ Access Level Required: SESSION_ADMIN or SESSION_MANAGER

---

Request Parameters

Name	Type	Required	Description
index	int	Yes	Report index to identify the report plugin
group	string	No	Optional group mask filter
symbol	string	No	Optional symbol filter
account	string	No	Optional account filter
from	int	No	Start timestamp for range filters
to	int	No	End timestamp for range filters

---

Request Example

{
  "index": 0,
  "group": "standard",
  "from": 1693500000,
  "to": 1696105600
}

---

Response Format

The report output is returned in a declarative UI schema:

Field	Type	Description
type	string	Node type: "div", "table", "h1", "td", "#text", etc.
children	array	Child nodes or data cells

---

Response Example

{
  "type": "div",
  "children": [
    {
      "type": "h1",
      "children": [
        { "type": "#text", "props": { "value": "System Status Report" } }
      ]
    },
    {
      "type": "table",
      "children": [
        {
          "type": "tr",
          "children": [
            { "type": "td", "children": [ { "type": "#text", "props": { "value": "CPU Usage" } } ] },
            { "type": "td", "children": [ { "type": "#text", "props": { "value": "75%" } } ] }
          ]
        },
        {
          "type": "tr",
          "children": [
            { "type": "td", "children": [ { "type": "#text", "props": { "value": "Memory Usage" } } ] },
            { "type": "td", "children": [ { "type": "#text", "props": { "value": "68%" } } ] }
          ]
        }
      ]
    }
  ]
}

---

Error Example

{
  "error": "INVALID_CREATE_REPORT",
  "message": "Failed to generate the report"
}