×

Report list

This API retrieves a list of all available reports in the account, including their IDs, names, and the groups they belong to.

How to get data

Request address

To get the data, use the address:  https://<server_address>/api/api.php?

Request method

GET or POST

Request parameters

  • cmd=reports_list — command to get the list of reports
  • node — node number where the command should be executed
 

Example GET request

https://<server_address>/api/api.php?cmd=reports_list&node=1
Response
{
  "code": 0,
  "data": [
    { "id": 266, "name": "Administrative Actions", "group": "Administrator" },
    { "id": 258, "name": "Blocked Users", "group": "Administrator" },
    { "id": 263, "name": "Created Users", "group": "Administrator" },
    { "id": 261, "name": "Disabled User Account", "group": "Administrator" },
    { "id": 265, "name": "Inactive Users", "group": "Administrator" },
    { "id": 267, "name": "Failed Login Attempts", "group": "Administrator" }
  ]
}
In response to the API request, the following is returned:
  • code — result code (0 means the operation was successful)
  • data — array of available reports:
  • id — report ID
  • name — report name
  • group — group the report belongs to