Get reports list

GetReportsList¶

Description: Returns a list of all enabled report modules available in the platform. Each report includes stable uuid identity, optional module key, and metadata such as name, description, path, type, and filter mode.

Access Control¶

🛡️ Access Level Required: SESSION_ADMIN or SESSION_MANAGER

Response Parameters¶

Field	Type	Description
name	string	Name of the report
description	string	Short description of the report
path	string	Path to the shared library file (.so)
module_name	string	Name of the module implementing the report
uuid	string	Stable report identifier used for report execution
key	string	Optional report key returned by the module
type	int	Filter type code (see Report Types below)
enable	int	1 if report is enabled, 0 otherwise
version	int	Report version number

Report Types¶

Enum	Value	Description
REPORT_NONE_TYPE	0	No filters required
REPORT_RANGE_TYPE	1	Requires time range
REPORT_DAILY_TYPE	2	Filter by one day
REPORT_ACCOUNT_TYPE	3	Filter by account
REPORT_SYMBOL_TYPE	4	Filter by symbol
REPORT_GROUP_TYPE	5	Filter by group mask
REPORT_RANGE_GROUP_TYPE	6	Time range + group mask
REPORT_DAILY_GROUP_TYPE	7	One day + group mask
REPORT_RANGE_ACCOUNT_TYPE	8	Time range + account
REPORT_DAILY_ACCOUNT_TYPE	9	One day + account
REPORT_RANGE_SYMBOL_TYPE	10	Time range + symbol
REPORT_DAILY_SYMBOL_TYPE	11	One day + symbol
REPORT_RANGE_GROUP_SYMBOL_TYPE	12	Time range + group + symbols
REPORT_DAILY_GROUP_SYMBOL_TYPE	13	One day + group + symbols

Response Example¶

{
  "rows": [
    {
      "name": "Daily Activity",
      "description": "Shows all user activity per day",
      "path": "/opt/plugins/reports/daily_activity.so",
      "module_name": "daily_activity",
      "uuid": "16baf545-f3ab-5a97-9c9f-4e6c9f5bb1df",
      "key": "daily_activity",
      "type": 2,
      "enable": 1,
      "version": 1
    }
  ]
}

Error Example¶

{
  "error": "INVALID_DATA",
  "message": "Validation error"
}