> ## Documentation Index
> Fetch the complete documentation index at: https://docs.aiderx.io/llms.txt
> Use this file to discover all available pages before exploring further.

# Get License Metrics

> Returns license quota, current usage, and feature information.



## OpenAPI

````yaml /openapi/adm.openapi.en-dev.json get /api/manager/license/metric
openapi: 3.1.0
info:
  description: >
    ## Introduction

    The Data Management APIs comprehensively oversees the **diverse data** used
    by advertising and recommendation systems, ensuring that the Decision API
    runs accurately and efficiently.


    From registering, updating, and deleting campaigns and placements to **log
    and statistics analysis**, it provides the insights necessary for effective
    system operation.


    The resulting data and metrics are used by the Decision API to **optimize ad
    and content decisions**, ultimately boosting the overall performance of the
    advertising and recommendation system.
  title: Data Management APIs
  version: dev
servers: []
security: []
tags:
  - description: >-
      Authentication endpoints. All roles (admin, operator, advertiser) use
      these to log in, refresh tokens, and manage their own credentials.
    name: Auth
  - description: >-
      Advertiser account management. Operators and admins onboard advertisers,
      manage their budgets, and deactivate accounts. Advertisers can only read
      their own profile and balance — they cannot create, delete, or modify
      another advertiser's account.
    name: Advertisers
  - description: >-
      Internal user (operator / admin) account management. Admin only. Covers
      creating operator accounts, changing roles, toggling activation status,
      and hard-deleting accounts. Operators have no access to this resource.
    name: Users
  - description: >-
      The AdUnit Management API provides comprehensive functionalities for
      managing ad units and related resources. AdUnits are organized in a
      hierarchical path structure derived from their code and parent path. Only
      admin and operator roles have access — advertisers cannot access raw
      inventory. References:
      [Placement](https://docs.aiderx.io/guides/about-a2/en/placement)
    name: AdUnit
  - description: >-
      Ad catalog management. CRUD for ad catalogs plus public shared-view access
      via a share link.
    name: Ad Catalogs
  - description: >-
      Ad source (demand partner) management. CRUD for external ad sources that
      supply demand to ad units.
    name: AdSource
  - description: >-
      Allocation management. An allocation binds a line item to a serving target
      such as an ad unit. Covers CRUD, status counts, and single-allocation
      lookup.
    name: Allocations
  - description: >-
      Associated items pool (admin). Bulk upsert/delete and lookup of
      associated-items pools used by the recommendation pipeline.
    name: AssociatedItemsPool
  - description: >-
      Custom targeting segment management. CRUD and bulk operations for custom
      targeting segments.
    name: Custom Targeting Segment
  - description: Audit log access. Read the system audit log of administrative actions.
    name: Audit Logs
  - description: >-
      Creative block list. List, block, and unblock creatives to exclude them
      from serving.
    name: Blocked Creative
  - description: Catalog item management. List and update catalog (product/data) items.
    name: Catalogs
  - description: >-
      Creative asset management. Operators and admins manage creatives;
      advertisers see only their own. Deletion is blocked while any line-item
      association (LICA) still exists.
    name: Creatives
  - description: >-
      Dashboard aggregates. Summary data, inventory, and line-item metric
      rollups for the console dashboard.
    name: Dashboard
  - description: Experiment management. CRUD for A/B and optimization experiments.
    name: Experiment
  - description: >-
      External creative inspection. Read-only access to creatives ingested from
      external demand sources.
    name: External Creative
  - description: >-
      Third-party integration management. Manage integration sources (external
      data/serving connectors), probe connectivity, and read public
      (sensitive-config-redacted) configs.
    name: Integration
  - description: >-
      Line Item–Creative Associations (LICA). Associates creatives with line
      items, including batch create and delete (max 100, partial failure
      allowed) and dashboard counts.
    name: LICAs
  - description: License information. Read available license features and usage metrics.
    name: License
  - description: >-
      Line item management within an order. Covers create, update, delete, batch
      operations (max 100, partial failure allowed), and status transitions. A
      line item defines budget, goal, schedule, and targeting under its parent
      order.
    name: LineItems
  - description: Media library. List, upload, and delete media files used by creatives.
    name: Media Library
  - description: >-
      Metric query endpoints. Retrieve aggregated metrics for ad units,
      creatives, line items, and related entities.
    name: Metric
  - description: >-
      Advertiser order management. Operators and admins create and manage orders
      that group line items under a single budget; advertisers can read their
      own. Includes batch operations (max 100) and draft-only deletion rules.
    name: Orders
  - description: >-
      Placement management. A placement maps ad units to a serving surface.
      Endpoints cover CRUD and replacing the ad units bound to a placement.
    name: Placements
  - description: >-
      System settings. Read and update system configuration, including site
      logo, public URL, TLS, and access-token regeneration.
    name: Settings
  - description: System resources. Public static resources such as the site logo.
    name: System
  - description: >-
      Operational/developer control endpoints. Low-level ext patches and health
      checks intended for internal operation, not general API consumers.
    name: developer
  - description: >-
      Operational allocation control. Update allocation ext or force-update
      status (admin only).
    name: developer/control/allocations
  - description: >-
      Ad-serving monitoring (operational). Read ad-serving status, ad-unit
      monitoring history, and alerts.
    name: developer/monitoring
  - description: Internal health and probe endpoints.
    name: internal
  - description: >-
      Manager-level utility endpoints (e.g. service health) not tied to a
      specific resource.
    name: manager
  - description: Manage mappings between ad units, native formats, and native styles.
    name: Ad Unit Native Style
  - description: Manage custom targeting keys, including lifecycle and bulk operations.
    name: Custom Targeting Key
  - description: >-
      Manage values belonging to custom targeting keys, including lifecycle and
      bulk operations.
    name: Custom Targeting Value
  - description: Manage native formats and the fields that define each format.
    name: Native Format
  - description: List templates available for native styles.
    name: Native Style Template
  - description: Manage native rendering styles.
    name: Native Style
paths:
  /api/manager/license/metric:
    get:
      tags:
        - License
      summary: Get License Metrics
      description: Returns license quota, current usage, and feature information.
      operationId: handle_get_license_metric_api_manager_license_metric_get
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LicenseResourceStatus'
          description: Successful Response
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPExceptionResponse'
          description: Unauthorized
        '500':
          content:
            application/json:
              example:
                detail:
                  code: LICENSE.FILE_NOT_FOUND
                  message: License file not found. Contact your system administrator.
          description: License file not found. Contact your system administrator.
      security:
        - HTTPBearer: []
components:
  schemas:
    LicenseResourceStatus:
      properties:
        features:
          $ref: '#/components/schemas/FeatureTierSchema'
        info:
          $ref: '#/components/schemas/LicenseInfoSchema'
        limit:
          additionalProperties:
            type: integer
          description: Static limits for feature behavior.
          title: Limit
          type: object
        quota:
          additionalProperties:
            type: integer
          description: Maximum allowed resource usage limits.
          title: Quota
          type: object
        used:
          additionalProperties:
            type: integer
          description: Current usage count for each resource type.
          title: Used
          type: object
      required:
        - info
        - quota
        - used
        - limit
        - features
      title: LicenseResourceStatus
      type: object
    HTTPExceptionResponse:
      properties:
        detail:
          description: Detailed explanation for the exception
          title: Detail
          type: string
      required:
        - detail
      title: HTTPExceptionResponse
      type: object
    FeatureTierSchema:
      properties:
        analytic:
          description: Supported user roles to view analytics
          items:
            $ref: '#/components/schemas/AnalyticFeature'
          title: Analytic
          type: array
        campaign:
          description: Supported campaign goals
          items:
            $ref: '#/components/schemas/CampaignFeature'
          title: Campaign
          type: array
        creative:
          description: Supported creative types
          items:
            $ref: '#/components/schemas/CreativeFeature'
          title: Creative
          type: array
        media_library:
          description: Supported media library storage
          items:
            $ref: '#/components/schemas/MediaLibraryFeature'
          title: Media Library
          type: array
        name:
          description: The name of the license tier
          title: Name
          type: string
        notification:
          description: Supported notification types
          items:
            $ref: '#/components/schemas/NotificationFeature'
          title: Notification
          type: array
      required:
        - name
        - campaign
        - media_library
        - creative
        - notification
        - analytic
      title: FeatureTierSchema
      type: object
    LicenseInfoSchema:
      properties:
        customer_id:
          description: The customer ID
          title: Customer Id
          type: string
        expiry_date:
          description: The license expiry date
          title: Expiry Date
          type: string
        license_type:
          description: The license type
          title: License Type
          type: string
      required:
        - customer_id
        - expiry_date
        - license_type
      title: LicenseInfoSchema
      type: object
    AnalyticFeature:
      enum:
        - advertiser
        - retailer
      title: AnalyticFeature
      type: string
    CampaignFeature:
      enum:
        - impression
        - reach
        - click
        - conversion
      title: CampaignFeature
      type: string
    CreativeFeature:
      enum:
        - display
        - video
        - native
      title: CreativeFeature
      type: string
    MediaLibraryFeature:
      enum:
        - local
        - cloud
      title: MediaLibraryFeature
      type: string
    NotificationFeature:
      enum:
        - adm
        - slack
        - email
      title: NotificationFeature
      type: string
  securitySchemes:
    HTTPBearer:
      description: >-
        Bearer authentication. Pass the access token in the `Authorization:
        Bearer <token>` header.
      scheme: bearer
      type: http

````