pem.statistics.getStatisticsReport

This method is supported by Operations starting from version 5.0

The method has the following input parameters:

Name

Type

Short Description

  • reports

array of struct

List of reports to produce

  • name

string

Name of report

  • value

string

Report's parameters, which can be specified in the following formats:

  • ParameterName1=Value1, ParameterName2=Value2, etc.
  • ParameterValue1, ParameterValue2, etc.

The list of parameters depends on report.

The method returns:

Name

Type

Short Description

result

array of struct

List of reports

name

string

Friendly name of report

value

string

Report itself, in most cases it is resource usage.

The table below provides a list of the available reports.

Report Name

Description

poaVersion

Operations version

Example of the report:

  • name: poaVersion
  • value: 5.0

ADSync

Total amount of enabled 'Active Directory Synchronization' services.

Example of the report:

  • name: Active Directory Synchronization
  • value: 1000

ADSyncUsers

Total number of users synchronized from on-premise Active Directories. Users are included into the report for subscriptions where the 'Active Directory Synchronization' service is enabled.

Example of the report:

  • name: Synchronized Users (CDI)
  • value: 1000

totalDomains

Total number of active domains (domains are in the Enabled state in Operations)

Example of the report:

  • name: totalDomains
  • value: 1000

Parked domains

Total number of parked domains. Domain is included into the report when the following conditions are satisfied:

  • Domain Parking Hosting only is installed on domain

OR

  • Domain Parking Hosting and Linux-based/Windows-based Hostings are installed on domain

Example of the report:

  • name: Parked domains
  • value: 1000

domainsLinux

Total number of domains with Linux-based Hosting modules. Domain is included into the report when the following conditions are satisfied:

  • Domain has one or more Linux-based Hosting modules installed

AND

  • Domain has no Windows-based Hosting modules installed

Example of the report:

  • name: domainsLinux
  • value: 1000

domainsWindows

Total number of domains with Windows-based Hosting modules. Domain is included into the report when the following conditions are satisfied:

  • Domain has one or more Windows-based Hosting modules installed

AND

  • Domain has no Linux-based Hosting modules installed

Example of the report:

  • name: domainsWindows
  • value: 1000

mailboxesLinux

Total number of CQMail Mailboxes

Example of the report:

  • name: mailboxesLinux
  • value: 1000

mailboxesWindows

Total number of Exchange Mailboxes

Example of the report:

  • name: mailboxesWindows
  • value: 1000

PPPServersLinux

Total number of Plesk Servers on Linux (Plesk is installed on Hardware Node or VPS)

Example of the report:

  • name: PPPServersLinux
  • value: 1000

PPPServersWindows

Total number of Plesk Servers on Windows (Plesk is installed on Hardware Node or VPS)

Example of the report:

  • name: PPPServersWindows
  • value: 1000

PVCServersLinux

Total number of Linux-based VPS Hardware Nodes

Example of the report:

  • name: Virtuozzo containersServersLinux
  • value: 1000

PVCServersWindows

Total number of Windows-based VPS Hardware Nodes

Example of the report:

  • name: Virtuozzo containersServersWindows
  • value: 1000

PVCContainersLinux

Total number of Linux-based VPSs (Shared or Dedicated)

Example of the report:

  • name: Virtuozzo containersContainersLinux
  • value: 1000

PVCContainersWindows

Total number of Windows-based VPSs (Shared or Dedicated)

Example of the report:

  • name: Virtuozzo containersContainersWindows
  • value: 1000

Resellers

Report on Reseller Accounts that are in Enabled state (XML data).

ActiveAccounts

Total number of active Accounts (accounts are in the Enabled state in Operations)

Example of the report:

  • name: Active accounts
  • value: 1000

ActiveSubscriptions

Total number of active Subscriptions (Subscriptions are in the Enabled state in Operations)

Example of the report:

  • name: Active subscriptions
  • value: 1000

ActiveUsers

Total number of active users. It is calculated in the following way:

For each account, MAX(number of active service users from active subscriptions of account, number of active staff members of account) is calculated, then the results are summarized.

Example of the report:

  • name: ActiveUsers
  • value: 10000

Domains

Total number of active domains (domains are in the Enabled state in Operations)

Example of the report:

  • name: Domains
  • value: 1000

DomainsWithSH

Total number of domains with Linux-based Hosting modules. Domain is included into the report when the following conditions are satisfied:

  • Domain has one or more Linux-based Hosting modules installed

OR

  • Linux-based Hosting modules and Windows-based Hosting modules are installed on domain

Example of the report:

  • name: Domains (with shared hosting)
  • value: 1000

DomainsWithWSH

Total number of domains with Windows-based Hosting modules. Domain is included into the report when the following conditions are satisfied:

  • Domain has one or more Windows-based Hosting modules installed

OR

  • Domain has Windows-based Hosting modules and Linux-based Hosting modules installed

Example of the report:

  • name: Domains (Windows Shared)
  • value: 1000

ExchangeMailboxes

Total number of active Exchange Mailboxes.

Example of the report:

  • name: Mailboxes (Hosted Exchange)
  • value: 1000

ExchnageVersions

Total number of active Mailboxes for each version of Exchange Server.

Example of the report:

  • name: Exchange 2013 Active Mailboxes
  • value: 500

QmailMailboxes

Total number of CQMail Mailboxes

Example of the report:

  • name: Mailboxes (Qmail)
  • value: 1000

ServersWeb

Total number of web servers (VPSs and Hardware Nodes). Server is included into the report when the following conditions are satisfied:

  • Apache service is installed on server and there are more than 5 Apache Web Hosting modules provided by this service

OR

  • AWStats service is installed on server

Note: If one or more different (by type) services are installed on the same server, it is included into the report only once.

Example of the report:

  • name: Servers (Web)
  • value: 1000

ServersMail

Total number of mail servers (VPSs and Hardware Nodes). Server is included into the report when the following conditions are satisfied:

  • clustered-qmail service is installed on server

OR

  • DrWeb daemon service is installed on server

OR

  • SpamAssassin service is installed on server and there is one or more Mailboxes protected by this service

Notes:
1. If one or more different (by type) services are installed on the same server, it is included into the report only once.
2. If QMail is deployed in the cluster mode, each cluster node is included into the report.

Example of the report:

  • name: Servers (Qmail)
  • value: 1000

ServersDB

Total number of database servers (VPSs and Hardware Nodes). Server is included into the report when the following conditions are satisfied:

  • MySQL service is installed on server and there is one or more customer databases hosted by this service

OR

  • PgSQL service is installed on server and there is one or more customer databases hosted by this service

Note: If one or more different (by type) services are installed on the same server, it is included into the report only once.

Example of the report:

  • name: Servers (databases)
  • value: 1000

ExchangeLight

Total number of Exchange Mailboxes where the MAPI protocol is in the disabled state (Outlook access is in the disabled state in CCP).

Example of the report:

  • name: Exchange Light
  • value: 1000

ExchangeFull

Total number of Exchange Mailboxes where the MAPI protocol is in the enabled state (Outlook access is in the enabled state in CCP).

Example of the report:

  • name: Exchange Full
  • value: 1000

VPSDistribution

This report provides information how VPSs are distributed on VPS Hardware Nodes according to specified thresholds.

Thresholds are defined in the following format: number1,...,numberN

There are the following intervals: [0,number1], (number1,number2],...,(numberN,infinity).

For example: when 5 and 10 thresholds are defined, there are the following intervals: [0,5], (5,10], (10,infinity).

Example of the report for 5 and 10 thresholds:

  • name: 10 VZ VPS
  • value: 13 – the total number of VPSs distributed among VPS Hardware Nodes of Total VZ servers with up to 10 VZ VPS class
  • name: 5 VZ VPS
  • value: 9 – the total number of VPSs distributed among VPS Hardware Nodes of Total VZ servers with up to 5 VZ VPS class
  • name: >10 VZ VPS
  • value: 35 – the total number of VPSs distributed among VPS Hardware Nodes of Total VZ servers with more than 10 VZ VPS class
  • name: Total VZ servers with more than 10 VZ VPS
  • value: 1 – total number of VPS Hardware Nodes where a number of VPSs > 10
  • name: Total VZ servers with up to 10 VZ VPS
  • value: 2 – total number of VPS Hardware Nodes where a number of VPSs > 5 and number of VPSs <= 10
  • name: Total VZ servers with up to 5 VZ VPS
  • value: 7 – total number of VPS Hardware Nodes where a number of VPSs <= 5

Note: Thresholds are mandatory report's parameters.

VPSLinuxNoPlesk

Total number of Linux-based VPSs without Plesk

Example of the report:

  • name: Active Linux VPSes without Plesk
  • value: 1000

VPSWindowsNoPlesk

Total number of Windows-based VPSs without Plesk

Example of the report:

  • name: Active Windows VPSes without Plesk
  • value: 1000

VPSLinuxPlesk

Total number of Linux-based VPSs with Plesk

Example of the report:

  • name: Active Linux VPSes with Plesk
  • value: 1000

VPSWindowsPlesk

Total number of Windows-based VPSs with Plesk

Example of the report:

  • name: Active Windows VPSes with Plesk
  • value: 1000

SPLA

Exchange SPLA report (at the beginning of the current month)

Example of the report:

  • name: Hosted Exchange Basic SAL
  • value: 10
  • name: Hosted Exchange Enterprise Plus SAL
  • value: 20
  • name: Hosted Exchange Enterprise SAL
  • value: 30
  • name: Hosted Exchange Standard Plus SAL
  • value: 40
  • name: Hosted Exchange Standard SAL
  • value: 50

report-for-cep

CEP report (XML data).

report-for-billing

Billing report (XML data).

APSApplications

APS Applications (XML data), see Appendix A. APSApplications Report Format

Notes:

1. Resource usage is returned for active Subscriptions only (Subscriptions are in the Enabled state in Operations).
2. Each Operations Hosting Module provides a set of reports. When a report is requested for not-installed Hosting Module, Operations returns empty result for this report.