---
title: "List the application usage summary"
method: POST
path: "/applications/usage/summary"
tags: ["Application"]
---

# List the application usage summary

`POST /applications/usage/summary`

List a page of application usage summary by filter.

## Query parameters

- `page` integer
- `limit` integer
- `sortField` 'USAGE' | 'PERCENTAGE_USAGE' | 'CLIENTS' | 'USERS' | 'APPLICATION_NAME' | 'CATEGORY_NAME'
- `order` 'ASC' | 'DESC' — Sort Order
- `name` string
- `async` boolean

## Request body

- XiqAppUsageSummaryFilter — Request body for Application Usage Summary Filter
  - `site_ids` integer[] — Filter by Site Ids
  - `application_name` string[] — Filter by application name
  - `category_name` string[] — Filter by category (application group) name
  - `number_filter` XiqAppUsageSummaryNumberFilter[] — Filter by number filter
    - `column_name` string — The column name
    - `filter_type` 'GT' | 'GTE' | 'LT' | 'LTE' | 'EQ' | 'NEQ' | 'BTW' | 'BLANK' | 'NOT_BLANK' — The filter type
    - `value` number, double — The value
    - `min` number, double — The minimum value
    - `max` number, double — The maximum value
    - `data_unit` 'BYTES' | 'KB' | 'MB' | 'GB' — The data unit of App usage

## Response `200`

OK

- PagedXiqAppUsageSummary
  - `page` integer, required — The current page number
  - `count` integer, required — The element count of the current page
  - `total_pages` integer, required — The total page number based on request page size
  - `total_count` integer, required — The total element count
  - `data` XiqAppUsageSummary[] — The data in the current page
    - `application_name` string — The application name
    - `category_name` string — The category name of application
    - `usage` integer — The application summary usage
    - `percentage_usage` number, double — The application summary percentage usage
    - `clients` integer — The total number of clients
    - `users` integer — The total number of users

---

[API](https://skmtc.net/extremecloudiq/apis/extremecloud-iq-api.md) · [All operations](https://skmtc.net/extremecloudiq/apis/extremecloud-iq-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/extremecloudiq/extremecloud-iq-api/versions/5ff7ab84e8e8/schema)
