> ## 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 a campaign metric

> Retrieves metrics for a specific campaign identified by the query.



## OpenAPI

````yaml /openapi/adm.openapi.en-0.2.2.json post /metric/campaign
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:
  /metric/campaign:
    post:
      tags:
        - Analytic
      summary: Get a campaign metric
      description: Retrieves metrics for a specific campaign identified by the query.
      operationId: handle_campaign_metric_campaign_post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CampaignMetricQuery'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/CampaignMetricBaseSchema'
                title: Response Handle Campaign Metric Campaign Post
                type: array
          description: Successful Response
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPExceptionResponse'
          description: Forbidden
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
          description: Validation Error
      security:
        - OAuth2PasswordBearer: []
components:
  schemas:
    CampaignMetricQuery:
      description: Query for campaign metric.
      properties:
        campaign_id:
          format: uuid
          title: Campaign Id
          type: string
        from_datetime:
          anyOf:
            - format: date-time
              type: string
            - type: 'null'
          title: From Datetime
        to_datetime:
          anyOf:
            - format: date-time
              type: string
            - type: 'null'
          title: To Datetime
      required:
        - campaign_id
      title: CampaignMetricQuery
      type: object
    CampaignMetricBaseSchema:
      description: Schema for base campaign metric entity.
      properties:
        ad_revenue:
          description: Ad revenue
          title: Ad Revenue
          type: number
        budget_spent:
          default: 0
          description: Budget spent
          title: Budget Spent
          type: number
        cid:
          description: The campaign ID
          format: uuid
          title: Cid
          type: string
        click:
          default: 0
          description: Click
          title: Click
          type: integer
        conversion:
          default: 0
          description: Conversion
          title: Conversion
          type: integer
        cpa:
          default: 0
          description: Cost Per Action
          title: Cpa
          type: number
        cpc:
          default: 0
          description: Cost Per Click
          title: Cpc
          type: number
        cpm:
          default: 0
          description: Cost Per Mille
          title: Cpm
          type: number
        finished:
          description: Indicates whether the campaign has ended. 0 = No, 1 = Yes
          title: Finished
          type: integer
        id:
          title: Id
          type: integer
        impression:
          default: 0
          description: Impression
          title: Impression
          type: integer
        reach:
          default: 0
          description: Reach
          title: Reach
          type: integer
        roas:
          default: 0
          description: Return on Ad Spend
          title: Roas
          type: number
        tagid:
          description: The placement ID
          format: uuid
          title: Tagid
          type: string
      required:
        - id
        - cid
        - tagid
        - ad_revenue
        - finished
      title: CampaignMetricBaseSchema
      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
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          title: Detail
          type: array
      title: HTTPValidationError
      type: object
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          title: Location
          type: array
        msg:
          title: Message
          type: string
        type:
          title: Error Type
          type: string
      required:
        - loc
        - msg
        - type
      title: ValidationError
      type: object
  securitySchemes:
    OAuth2PasswordBearer:
      flows:
        password:
          scopes: {}
          tokenUrl: auth/jwt/login
      type: oauth2

````