---
title: "Return cPanel account statistics"
method: GET
path: "/StatsBar/get_stats"
tags: ["StatsBar", "Resource Usage and Statistics"]
---

# Return cPanel account statistics

`GET /StatsBar/get_stats`

This function retrieves a cPanel account's statistics.

## Query parameters

- `display` string, required
- `infinityimg` string, nullable
- `infinitylang` string, nullable
- `rowcounter` string, nullable
- `warninglevel` integer, nullable
- `warnings` 1 | 0, nullable
- `warnout` 1 | 0, nullable

## Response `200`

HTTP Request was successful.

- object
  - `apiversion` integer — The version of the API.
  - `func` string — The name of the method called.
  - `module` string — The name of the module called.
  - `result` object
    - `data` object[] — An array of objects containing results from the queried account.
      - `_count` string — The queried data's value.
      - `_max` string — The queried parameter's limit.
      - `_maxed` 1 | 0 — Whether the queried value reached its maximum value. * `1` — Reached maximum value. * `0` — Has **not** reached maximum value.
      - `condition` 1 | 0 — Whether the queried data's value possesses a conditional requirement. * `1` — Possesses a condition. * `0` — Does **not** possess a condition. **Note:** The function will **only** return this value if it determines that the related statistic meets the subsystem installation requirements.
      - `count` string — The queried data's value.
      - `feature` string — The queried item's feature name.
      - `id` string — The queried item's reference name.
      - `is_maxed` 1 | 0 — Whether the queried value has reached its maximum value. * `1` — The queried value has reached its maximum value. * `0` — The queried value has **not** reached its maximum value.
      - `item` string — A human-readable version of the queried item.
      - `max` string — The queried value's maximum limit.
      - `maxed_phrase` string — The [`maketext`-formatted](https://go.cpanel.net/locale) message that the interface displays when the user reaches their maximum allowed value.
      - `module` string — The module that retrieved the information.
      - `name` string — The display key.
      - `near_limit_phrase` string — The [`maketext`-formatted](https://go.cpanel.net/locale) message that the interface displays when the user approaches their maximum allowed value.
      - `normalized` 1 | 0 — Whether the function normalized the output values. * `1` — Normalized. * `0` — Did **not** normalize.
      - `percent` integer — The percentage of value, if applicable.
      - `percent10` integer — The percentage of value that the system rounds to the nearest ten, if applicable.
      - `percent20` integer — The percentage of value that the system rounds to the nearest twenty, if applicable.
      - `percent5` integer — The percentage of value that the system rounds to the nearest five, if applicable.
      - `phrase` string — The human-readable name of the queried item.
      - `role` 'CalendarContact' | 'DNS' | 'FileStorage' | 'FTP' | 'MailLocal' | 'MailReceive' | 'MailSend' | 'MySQL' | 'Postgres' | 'SpamFilter' | 'Webmail' | 'WebDisk' | 'WebServer' — The queried value's role. * `CalendarContact` * `DNS` * `FileStorage` * `FTP` * `MailLocal` * `MailReceive` * `MailSend` * `MySQL` * `Postgres` * `SpamFilter` * `Webmail` * `WebDisk` * `WebServer`
      - `rowtype` 'even' | 'odd' — The queried value's row type. * `even` * `odd`
      - `units` string — The queried value's unit of measure.
      - `zeroisunlimited` 1 | 0 — Whether a value of `0` means unlimited or zero. * `1` — Unlimited. * `0` — Zero.
    - `errors` string[], nullable — List of errors if the API failed.
    - `messages` string[], nullable — List of messages generated by the API.
    - `metadata` object
    - `status` 1 | 0 — * `1` — Success. * `0` — Failed. Check the `errors` field for more details.
    - `warnings` string[], nullable — List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.

---

[API](https://skmtc.net/cpanel/apis/cpanel-uapi.md) · [All operations](https://skmtc.net/cpanel/apis/cpanel-uapi/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/cpanel/cpanel-uapi/revisions/632e2f8e6d04/schema)