---
title: "Return resource usage and custom statistics"
method: GET
path: "/ResourceUsage/get_usages"
tags: ["ResourceUsage", "Resource Usage and Statistics"]
---

# Return resource usage and custom statistics

`GET /ResourceUsage/get_usages`

This function retrieves resource usage and custom statistics for a cPanel user account.

## 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 resource usage information from the account's query.
      - `description` string — The resource's UI display name.
      - `error` string, nullable — An error message, if applicable.
      - `formatter` union — The resource's defined output format. * `format_bytes` * `format_bytes_per_second` * `percent` * `null` — No defined output format. **Note:** Third-party modules will return their defined formatter value.
        - 'format_bytes' | 'format_bytes_per_second' | 'percent', nullable — The resource's defined output format.
        - string — A third-party module's defined formatter value.
      - `id` string — The resource's reference name. * `disk_usage` * `filesusage` - This function **only** returns this value if the *Display File Usage information in the cPanel stats bar* setting is enabled in the *Display* section of WHM's [*Tweak Settings*](https://go.cpanel.net/whmdocsTweakSettings#display) interface (*WHM >> Home >> Server Configuration >> Tweak Settings*). * `cachedmysqldiskusage` * `cachedpostgresdiskusage` - This function **only** returns this value if [PostgreSQL® databases](https://go.cpanel.net/cpaneldocsPostgreSQLDatabases) are enabled. * `bandwidth` * `addon_domains` * `subdomains` * `aliases` * `email_accounts` * `mailing_lists` - This function **only** returns this value if the Mailman service is enabled in WHM's [*Service Manager*](https://go.cpanel.net/whmdocsServiceManager) interface (*WHM >> Home >> Service Configuration >> Service Manager*). * `autoresponders` * `forwarders` * `email_filters` * `ftp_accounts` - This function **only** returns this value if FTP accounts exist on the server. * `mysql_databases` - This function **only** returns this value if MySQL® databases are enabled. * `postgresql_databases` **Note:** Certain `id` values may **not** appear, based on the [server's current profile](https://go.cpanel.net/howtouseserverprofiles#profiles).
      - `maximum` integer, nullable — The resources's maximum usage value. **Note:** This function returns an null value for an (unlimited) quota.
      - `url` string, url-path — The resource's defined URL link to its corresponding interface, in applicable.
      - `usage` integer — The resource's current usage value.
    - `errors` string[], nullable — List of errors if the API failed.
    - `messages` string[], nullable — List of messages generated by the API.
    - `metadata` object
    - `status` 0 | 1 — - `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 an 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)