API Module Reseller retrieveStatisticsResellerRequest

From Openprovider API documentation

(Difference between revisions)
Jump to: navigation, search
(Created page with '==Module Reseller > Retrieve Statistics== {| border="1" cellpadding="4" |- style="background-color:#BBBBBB;" |'''Module''' |reseller |- style="background-color:#EEEEEE;" |'''Comm…')
(→Module Reseller > Retrieve Statistics)
 
(3 intermediate revisions not shown)
Line 17: Line 17:
|'''Output'''
|'''Output'''
|
|
 +
Statistics around every type of objects in reseller account:
*customer
*customer
*domain
*domain
Line 33: Line 34:
===Raw XML===
===Raw XML===
 +
''Please note that newlines and leading spaces are added only for readability. Those whitespaces should be excluded from your XML command before sending it to Openprovider.''
  <?xml version="1.0" encoding="UTF-8"?>
  <?xml version="1.0" encoding="UTF-8"?>
  <openXML>
  <openXML>
Line 40: Line 42:
   </credentials>
   </credentials>
   <retrieveStatisticsResellerRequest />
   <retrieveStatisticsResellerRequest />
 +
</openXML>
 +
 +
<?xml version="1.0" encoding="UTF-8"?>
 +
<openXML>
 +
  <reply>
 +
    <nowiki><code>0</code></nowiki>
 +
    <desc></desc>
 +
    <data>
 +
      <customer>
 +
        <total>447</total>
 +
        <modified>2016-06-17 13:13:02</modified>
 +
      </customer>
 +
      <currency>
 +
        <modified>2010-08-01 09:30:54</modified>
 +
      </currency>
 +
      <domain>
 +
        <byStatus>
 +
            <ACT>11</ACT>
 +
            <FAI>24</FAI>
 +
            <PEN>0</PEN>
 +
            <REQ>3</REQ>
 +
        </byStatus>
 +
        <total>42</total>
 +
      </domain>
 +
      <ssl>
 +
        <byStatus>
 +
          <ACT>1</ACT>
 +
          <FAI>73</FAI>
 +
          <PEN>0</PEN>
 +
          <REQ>13</REQ>
 +
        </byStatus>
 +
        <total>100</total>
 +
      </ssl>
 +
      <dns>
 +
        <total>1433</total>
 +
      </dns>
 +
      <spamExperts>
 +
        <exists>1</exists>
 +
        <status>deleted</status>
 +
        <incomingCount>0</incomingCount>
 +
        <incomingLimit>10</incomingLimit>
 +
        <outgoingCount>0</outgoingCount>
 +
        <outgoingLimit>1</outgoingLimit>
 +
        <withOutgoingFilter>1</withOutgoingFilter>
 +
        <createdAt>2012-10-29 10:48:30</createdAt>
 +
        <activatedAt>2012-10-29 10:48:30</activatedAt>
 +
        <expiredAt>2016-04-05 08:50:34</expiredAt>
 +
      </spamExperts>
 +
      <license>
 +
        <total>0</total>
 +
      </license>
 +
    </data>
 +
  </reply>
  </openXML>
  </openXML>

Current revision as of 11:24, 17 June 2016

Contents

Module Reseller > Retrieve Statistics

Module reseller
Command name modifyResellerRequest
Use Retrieves quantitative information about your reseller account
Input

-

Output

Statistics around every type of objects in reseller account:

  • customer
  • domain
  • ssl
  • license
  • dns

Examples

Using PHP class

$request = new OP_Request;
$request->setCommand('retrieveStatisticsResellerRequest')
 ->setAuth(array('username' => 'username', 'password' => 'password'))
 ->setArgs(array(
));

Raw XML

Please note that newlines and leading spaces are added only for readability. Those whitespaces should be excluded from your XML command before sending it to Openprovider. 

<?xml version="1.0" encoding="UTF-8"?>
<openXML>
  <credentials>
    <username>username</username>
    <password>password</password>
  </credentials>
  <retrieveStatisticsResellerRequest />
</openXML>

<?xml version="1.0" encoding="UTF-8"?>
<openXML>
  <reply>
    <code>0</code>
    <desc></desc>
    <data>
      <customer>
        <total>447</total>
        <modified>2016-06-17 13:13:02</modified>
      </customer>
      <currency>
        <modified>2010-08-01 09:30:54</modified>
      </currency>
      <domain>
        <byStatus>
           <ACT>11</ACT>
           <FAI>24</FAI>
           <PEN>0</PEN>
           <REQ>3</REQ>
        </byStatus>
        <total>42</total>
      </domain>
      <ssl>
        <byStatus>
          <ACT>1</ACT>
          <FAI>73</FAI>
          <PEN>0</PEN>
          <REQ>13</REQ>
        </byStatus>
        <total>100</total>
      </ssl>
      <dns>
        <total>1433</total>
      </dns>
      <spamExperts>
        <exists>1</exists>
        <status>deleted</status>
        <incomingCount>0</incomingCount>
        <incomingLimit>10</incomingLimit>
        <outgoingCount>0</outgoingCount>
        <outgoingLimit>1</outgoingLimit>
        <withOutgoingFilter>1</withOutgoingFilter>
        <createdAt>2012-10-29 10:48:30</createdAt>
        <activatedAt>2012-10-29 10:48:30</activatedAt>
        <expiredAt>2016-04-05 08:50:34</expiredAt>
      </spamExperts>
      <license>
        <total>0</total>
      </license>
    </data>
  </reply>
</openXML>
Retrieved from "https://doc.openprovider.eu/API_Module_Reseller_retrieveStatisticsResellerRequest"
Views
Personal tools