# Get Entitlement Utilization Summaries

Retrieves comprehensive entitlement utilization summaries that provide real-time visibility into how licenses are being consumed. Entitlement utilization summaries are aggregated reports that show license consumption patterns for each license type and device category. These summaries help organizations understand their license usage.

Endpoint: POST /entitlements/utilizations/query
Version: v0.2.0

## Header parameters:

  - `Content-Type` (string, required)

## Request fields (application/vnd.ruckus.v1.2+json):

  - `filters` (object)
    Filter criteria for dynamic queries including field selections, value filters, and query parameters.

  - `filters.licenseType` (array)
    The list of entitlement types.
    Example: ["APSW"]

  - `filters.isTrial` (boolean)
    Flag indicating if summary is for trial or not.
    Example: false

  - `filters.status` (array)
    The list of status.
    Example: ["VALID"]

  - `filters.expirationDateRange` (object)
    Date range criteria for filtering entitlements based on expiration dates, supporting both past expired and future expiring time frames.

  - `filters.expirationDateRange.lastExpiredDays` (integer)
    The last number of days in which entitlements have expired.
    Example: 30

  - `filters.expirationDateRange.nextExpiringDays` (integer)
    The next number of days in which entitlements will expire.
    Example: 60

  - `filters.sku` (array)
    A list of SKU patterns in regular expression.
    Example: [A-Z]+-[A-Z]+-[A-Z]+-[A-Z]+[0-9]$

  - `filters.skuTier` (array)
    A list of SKU tiers.
    Example: Platinum, Gold, Silver

## Response 200 fields (application/json):

  - `data` (array, required)
    List of entitlement utilization summaries grouped by license type

  - `data.licenseType` (string, required)
    License type (APSW for Device Networking or SLTN_TOKEN for AddOn Solutions)
    Example: APSW

  - `data.isTrial` (boolean, required)
    Indicates if this entry represents trial licenses (true) or paid licenses (false). For non-MSP/VAR tenants, this is always false as trial and paid are combined.
    Example: false

  - `data.quantity` (integer, required)
    Total quantity of licenses available (paid + courtesy for MSP/VAR, or combined for non-MSP/VAR)
    Example: 1025

  - `data.courtesyQuantity` (integer)
    Courtesy quantity. Only present for MSP/VAR tenants with paid licenses (isTrial=false). Not applicable for trial licenses.
    Example: 230

  - `data.remainingQuantity` (integer, required)
    Remaining quantity available for use
    Example: 793

  - `data.selfUsage` (integer, required)
    Number of licenses used by the tenant's own account
    Example: 232

  - `data.mspCustomerUsage` (integer)
    Number of licenses assigned to MSP customers. Only present for MSP/VAR tenants.
    Example: 0

## Response 404 fields (application/vnd.ruckus.v1.2+json):

  - `code` (string)
    Unique error code identifying the specific type of error that occurred.

  - `message` (string)
    Human-readable error message providing details about what went wrong.

  - `reason` (string)
    Detailed explanation of why the error occurred, providing additional context.

  - `suggestion` (string)
    Actionable suggestion or recommendation for how to resolve or avoid this error.

## Response 417 fields (application/vnd.ruckus.v1.2+json):

  - `code` (string)
    Unique error code identifying the specific type of error that occurred.

  - `message` (string)
    Human-readable error message providing details about what went wrong.

  - `reason` (string)
    Detailed explanation of why the error occurred, providing additional context.

  - `suggestion` (string)
    Actionable suggestion or recommendation for how to resolve or avoid this error.

## Response 500 fields (application/json):

  - `requestId` (string)
    Unique identifier for the request that generated this error, used for tracking and debugging purposes.

  - `error` (object)
    Error response containing detailed error information including error codes, messages, reasons, and suggestions for resolution.

  - `error.code` (string)
    Unique error code identifying the specific type of error that occurred.

  - `error.message` (string)
    Human-readable error message providing details about what went wrong.

  - `error.reason` (string)
    Detailed explanation of why the error occurred, providing additional context.

  - `error.suggestion` (string)
    Actionable suggestion or recommendation for how to resolve or avoid this error.