Statistics Settings

Statistics settings can be received from Plesk server in the get response packet. The stat node of the get response packet is defined by the domainStat data type (plesk_domain.xsd) and contains a collection of statistics data for the specified domains. This node is structured as follows:

• The traffic node is required. It returns the traffic (in bytes) spent by the domain during the current month. Data type: size (unsignedLong).
• The subdom node is required. It holds the number of subdomains created on the domain. Data type: unsignedInt.
• The wu node is required. It holds the number of web users created on the domain. Data type: unsignedInt.
• The box node is required. It holds the number of email boxes created for the domain. Data type: unsignedInt.
• The redir node is required. It returns the number of redirects created for the domain. Data type: unsignedInt.
• The mg node is required. It returns the number of mailing groups created on the domain. Data type: unsignedInt.
• The resp node is required. It returns the number of autoresponders created on the domain. Data type: unsignedInt.
• The maillists node is required. It returns the number of mailing lists created on the domain. Data type: unsignedInt.
• The db node is required. It holds the number of databases created for the domain. Data type: unsignedInt.
• The webapps node is required. It returns the number of Java applications installed on the domain. Data type: unsignedInt.
• The traffic_prevday node is required. It returns the traffic (in bytes) spent by the domain during the previous day. Data type: unsignedLong.

The following response packet returns statistics settings for two filtered domains (ID 2435 and ID 2567):

<packet version="1.4.2.0">

<domain>

<get>

   <result>

      <status>ok</status>

      <filter-id>2435</filter-id>

      <id>2435</id>

      <data>

          <stat>

             <traffic>12458966221478885</traffic>

             <subdom>12</subdom>

             <wu>134</wu>

             <box>1024</box>

             <redir>2</redir>

             <mg>16</mg>

             <resp>124</resp>

             <maillists>4<maillists>

             <db></db>

             <webapps>8</webapps>

             <traffic_prevday>15241632184739856</traffic_prevday>

          </stat>

      </data>

   </result>

   <result>

      <status>ok</status>

      <filter-id>2567</filter-id>

      <id>2567</id>

      <data>

          <stat>

             <traffic>5896615637124</traffic>

             <subdom>10</subdom>

             <wu>18</wu>

             <box>102</box>

             <redir></redir>

             <mg>11</mg>

             <resp>12</resp>

             <maillists>6<maillists>

             <db>2</db>

             <webapps>5</webapps>

             <traffic_prevday>152562874868127</traffic_prevday>

          </stat>

      </data>

   </result>

</get>

</domain>

</packet>

This packet is specific for API RPC 1.4.2.0: the response contains the filtering parameter (the filter-id node). The request packet filtered the domain by domain ID, so the filter-id node of the response packet returns this filtering parameter, and the id node returns the domain identifier. Note that the earlier versions of API RPC protocol do not support this feature.