Skip to Content
Browse documentation

usagestatistics — Reseller API

Read account usage statistics through the Reseller API, with request fields, response details, errors and cURL/Python/PHP examples.

POST/api/v1/usagestatistics/Also accepts GET

Returns stored account records from the authenticated reseller accounts list, keyed by username, with current-month recorded quota_usage and bandwidth_usage in MB. Reseller entries also include reseller_data and reseller usage fields. Metric read failures become zero through safe_call; zero does not prove a fresh measurement. Unreadable account records are skipped; missing or invalid reseller-list data returns an empty object. No date-range or pagination fields are declared.

Request

PropertyValue
MethodsGET, POST
Versioned path/api/v1/usagestatistics/
Default path/api/usagestatistics/
AuthenticationReseller API credentials.
HeaderRequired value
X-RESELLERThe reseller account owning these API credentials.
X-API-USERYour Reseller API username.
X-API-PASSWORDIts API password.

No endpoint-specific query or body fields are required.

Replace server.example.com, examplereseller, billing_api and YOUR_API_PASSWORD in each standalone example. Replace operation sample values with your actual target and an existing package where required. Python needs Requests; PHP needs the cURL extension. These examples make real calls when run.

Success response

HTTP 200. Illustrative values; account records and server values vary. Stored account examples show only selected fields.

{
  "data": {
    "users": {
      "exampleuser": {
        "user": "exampleuser",
        "domain": "example.com",
        "is_suspended": "no",
        "is_reseller": "no",
        "quota_usage": 128,
        "bandwidth_usage": 512
      }
    }
  },
  "info": "Eenos usage metics",
  "status": 200
}
FieldTypeMeaning
statusinteger200 on the documented success branch.
infostringOperation description.
dataobjectOperation data described below.
data.usersobjectAccount records keyed by username, including recorded usage.

Account record contents are not a fixed public schema. Fields such as user/domain and nested limits depend on account configuration; reseller_data appears only where the handler adds it. Do not expose entire administrator responses to an end-user browser.

is_suspended and is_reseller are strings (yes/no), not booleans. quota_usage and bandwidth_usage are recorded current-month MB values; reseller records also contain quota_usage_reseller and bandwidth_usage_reseller.

Errors and demo mode

ConditionActual HTTP statusResponse behavior
Missing credentials with no other authenticated identity403detail: Authentication credentials were not provided.
Rejected password or source IP403detail: Invalid API credentials
Demo server400error: Demo server; info: Api Operations not available in demo server; JSON status: 403.
Caught backend exception400Exception text in error; JSON status: 500.
Unsupported method405 after authenticationMethod-not-allowed response.

Check both the HTTP status and JSON shape. Authentication failures do not use the operation envelope. Unexpected uncaught server errors are not guaranteed to return the documented JSON shape. Do not automatically retry account creation, password changes, deletions or SSO generation after a timeout: confirm the actual state first.

See Reseller API authentication and connection troubleshooting.