v1

latestOpenAPI 3.0.2cPanel License2026-08-06657427.1 MB
StatsManager
Weblog Settings

Returns weblog analyzers' configuration

This function lists the configuration of the web log anayzers for each domain on the cPanel account.

Important:

When you disable the WebServer role the system disables this function. For more information, read our How to Use Server Profiles documentation.

Note

Additional web log analyzer configuration such as if the user can edit their own configuration is provided in the metadata section of the return.

get/StatsManager/get_configuration

Response

HTTP Request was successful.

apiversioninteger

The version of the API.

funcstring

The name of the method called.

modulestring

The name of the module called.

Example response

{
  "apiversion": 3,
  "func": "get_configuration",
  "module": "StatsManager",
  "result": {
    "data": [
      {
        "analyzers": [
          {
            "enabled": 1,
            "enabled_by_user": 1,
            "name": "awstats"
          },
          {
            "enabled": 0,
            "enabled_by_user": 0,
            "name": "analog"
          },
          {
            "enabled": 0,
            "enabled_by_user": 1,
            "name": "webalizer"
          }
        ],
        "domain": "domain.com"
      }
    ],
    "metadata": {
      "analyzers": [
        {
          "available_for_user": 1,
          "enabled_by_default": 0,
          "name": "analog"
        },
        {
          "available_for_user": 1,
          "enabled_by_default": 1,
          "name": "awstats"
        },
        {
          "available_for_user": 1,
          "enabled_by_default": 0,
          "name": "webalizer"
        }
      ],
      "transformed": 1
    },
    "status": 1
  }
}