> ## 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

> Get the current license metrics.



## OpenAPI

````yaml /openapi/adm.openapi.en-0.2.2.json get /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: 0.1.3
servers: []
security: []
tags:
  - name: Audience Targeting
  - description: >

      The Audience Management APIs to seamlessly integrate Audience-related
      data.  


      References:

      - [First-Party
      Data](https://docs.aiderx.io/guides/about-a2/en/first-party-data)
    name: Audience
  - description: >
      APIs for collecting user activity data to enhance ad targeting and
      performance optimization.


      Activity Data captures actual user behavior data like product views,
      searches, cart additions, and purchases across all users, regardless of ad
      interactions.


      References:

      - [First-Party
      Data](https://docs.aiderx.io/guides/about-a2/en/first-party-data)
    name: Activity Log
  - description: >

      The Audience Attribute API provides access to audience attribute data.


      References:

      - [Audience
      Targeting](https://docs.aiderx.io/guides/about-a2/en/audience-targeting)
    name: Audience Attribute
  - description: >

      The Audience Segment API provides access to audience segment data.


      References:

      - [Audience
      Targeting](https://docs.aiderx.io/guides/about-a2/en/audience-targeting)
    name: Audience Segment
  - description: The Analytic API provides access to dashboard and A2 metric data.
    name: Analytic
  - description: >

      The Billing API manages billing information.

      A2 is configured to work with the payment systems used by your retail
      platform.


      To integrate payments, first you need to register an external channel.

      For more information about integrating A2 with external channels, check
      out [the External channels
      page](https://docs.aiderx.io/guides/about-a2/en/external-channel).
    name: Billing
  - description: |

      The Campaign API allows you to manage data related to campaigns.

      References:
      - [Campaign](https://docs.aiderx.io/guides/about-a2/en/campaign)
    name: Campaign
  - description: >

      The Creative API provides comprehensive functionalities for managing
      creative assets and related resources.


      References:

      - [Creative](https://docs.aiderx.io/guides/about-a2/en/creative)
    name: Creative
  - description: >

      The Allocation API provides comprehensive functionalities for managing
      allocation and related resources.


      References:

      - [Allocation](https://docs.aiderx.io/guides/about-a2/en/allocation)
    name: Allocation
  - description: >

      The Media Library API provides comprehensive functionalities for managing
      media library and related resources.


      References:

      - [Media Library](https://docs.aiderx.io/guides/about-a2/en/media-library)
    name: Media Library
  - description: >

      The Catalog Management API provides functionalities for managing catalogs
      and related resources.


      References:

      - [First-Party
      Data](https://docs.aiderx.io/guides/about-a2/en/first-party-data)
    name: Catalog
  - description: >

      The Placement Management API provides comprehensive functionalities for
      managing placements and related resources.


      References:

      - [Placement](https://docs.aiderx.io/guides/about-a2/en/placement)
    name: Placement
  - description: >

      Placement Catalog transforms the placement information into a structured
      “advertising product” that can be easily showcased to advertisers.


      References:

      - To be updated
    name: Placement Catalog
  - description: >

      The System APIs allow you to access and manage system-level settings and
      assets, such as logos and configuration values.


      References:

      - [Yield Optimization
      Settings](https://docs.aiderx.io/guides/about-a2/en/yield-optimization)
    name: System
  - description: >

      The Auth and User API provides authentication and user management
      functionalities.


      References:

      - [Account and
      Budget](https://docs.aiderx.io/guides/about-a2/en/account-and-budget)
    name: Auth and User
  - description: |

      The License API provides license management functionalities.
    name: License
paths:
  /license/metric:
    get:
      tags:
        - License
      summary: Get license metrics
      description: Get the current license metrics.
      operationId: handle_license_metric_license_metric_get
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LicenseResourceStatus'
          description: Successful Response
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPExceptionResponse'
          description: Internal server error
      security:
        - OAuth2PasswordBearer: []
components:
  schemas:
    LicenseResourceStatus:
      description: Schema representing the license resource status.
      properties:
        features:
          $ref: '#/components/schemas/FeatureTierSchema'
        info:
          $ref: '#/components/schemas/LicenseInfoSchema'
        limit:
          description: Maximum allowed resource usage limits for each resource type.
          examples:
            - campaign.analystics.days: 30
          title: Limit
          type: object
        quota:
          description: Maximum allowed resource usage limits for each resource type.
          examples:
            - api.monthly_requests: 1000000
              placement.count: 10
          title: Quota
          type: object
        used:
          description: Current usage count for each resource type.
          examples:
            - api.monthly_requests: 100
              placement.count: 1
          title: Used
          type: object
      required:
        - info
        - quota
        - used
        - limit
        - features
      title: LicenseResourceStatus
      type: object
    HTTPExceptionResponse:
      description: HTTPException response model.
      properties:
        detail:
          description: Detailed explanation for the exception
          title: Detail
          type: string
      required:
        - detail
      title: HTTPExceptionResponse
      type: object
    FeatureTierSchema:
      description: >-
        Schema representing the feature tier configuration.


        This defines what features and capabilities are available for a given
        license tier.

        The features are grouped into different categories like campaign types,
        media storage,

        creative formats, notification methods and analytics access.
      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:
      description: Schema representing the license information.
      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:
      description: represent analytic
      enum:
        - advertiser
        - retailer
      title: AnalyticFeature
      type: string
    CampaignFeature:
      description: represent campaign goal
      enum:
        - impression
        - reach
        - click
        - conversion
      title: CampaignFeature
      type: string
    CreativeFeature:
      description: represent creativeType
      enum:
        - display
        - video
        - native
      title: CreativeFeature
      type: string
    MediaLibraryFeature:
      description: represent media library
      enum:
        - local
        - cloud
      title: MediaLibraryFeature
      type: string
    NotificationFeature:
      description: represent notification
      enum:
        - adm
        - slack
        - email
      title: NotificationFeature
      type: string
  securitySchemes:
    OAuth2PasswordBearer:
      flows:
        password:
          scopes: {}
          tokenUrl: auth/jwt/login
      type: oauth2

````