> ## 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 experiment bucket metrics

> Returns an experiment's bucket-level metrics as a time series.



## OpenAPI

````yaml /openapi/adm.openapi.en-dev.json post /api/manager/metric/experiment
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/metric/experiment:
    post:
      tags:
        - Metric
      summary: Get experiment bucket metrics
      description: Returns an experiment's bucket-level metrics as a time series.
      operationId: handle_experiment_metric_api_manager_metric_experiment_post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ExperimentMetricQuery'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/MetricResponseSchema_list_BucketMetricBaseSchema__BucketHourlyMetricSchema_
          description: Successful Response
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
          description: Validation Error
      security:
        - HTTPBearer: []
components:
  schemas:
    ExperimentMetricQuery:
      description: Query for experiment (A/B test) bucket metrics.
      example:
        experiment_id: <experiment_id>
        from_datetime: '2026-05-01T00:00:00+09:00'
        timezone: Asia/Seoul
        to_datetime: '2026-05-31T23:59:59+09:00'
      properties:
        experiment_id:
          description: The experiment ID to query bucket metrics for
          format: uuid
          title: Experiment Id
          type: string
        from_datetime:
          examples:
            - '2017-07-21T17:32:28Z'
          format: date-time
          title: From Datetime
          type: string
        interval:
          $ref: '#/components/schemas/TimeInterval'
          default: daily
        timezone:
          default: Asia/Seoul
          title: Timezone
          type: string
        to_datetime:
          examples:
            - '2017-07-22T17:32:28Z'
          format: date-time
          title: To Datetime
          type: string
      required:
        - experiment_id
        - from_datetime
        - to_datetime
      title: ExperimentMetricQuery
      type: object
    MetricResponseSchema_list_BucketMetricBaseSchema__BucketHourlyMetricSchema_:
      properties:
        timeseries:
          items:
            $ref: '#/components/schemas/BucketHourlyMetricSchema'
          title: Timeseries
          type: array
        total:
          items:
            $ref: '#/components/schemas/BucketMetricBaseSchema'
          title: Total
          type: array
      required:
        - total
        - timeseries
      title: >-
        MetricResponseSchema[list[BucketMetricBaseSchema],
        BucketHourlyMetricSchema]
      type: object
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          title: Detail
          type: array
      title: HTTPValidationError
      type: object
    TimeInterval:
      enum:
        - hourly
        - daily
        - weekly
        - monthly
      title: TimeInterval
      type: string
    BucketHourlyMetricSchema:
      description: A single bucket's aggregated metric point for one time bucket.
      properties:
        bucket_id:
          description: Bucket identifier within the experiment
          title: Bucket Id
          type: integer
        click:
          default: 0
          title: Click
          type: integer
        conversion:
          default: 0
          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
        cps:
          default: 0
          description: Cost per sale
          title: Cps
          type: number
        ctr:
          default: 0
          description: Click-through rate
          title: Ctr
          type: number
        cvr:
          default: 0
          description: Conversion rate
          title: Cvr
          type: number
        impression:
          default: 0
          title: Impression
          type: integer
        line_items:
          items:
            $ref: '#/components/schemas/BucketLineItemMetricSchema'
          title: Line Items
          type: array
        pub_revenue:
          default: 0
          description: Publisher revenue attributed to this bucket
          title: Pub Revenue
          type: number
        reach:
          default: 0
          title: Reach
          type: integer
        sales:
          default: 0
          title: Sales
          type: number
        timestamp:
          description: The truncated timestamp label for this point
          title: Timestamp
          type: string
      required:
        - bucket_id
        - timestamp
      title: BucketHourlyMetricSchema
      type: object
    BucketMetricBaseSchema:
      description: A single bucket's aggregated metrics within an experiment.
      properties:
        bucket_id:
          description: Bucket identifier within the experiment
          title: Bucket Id
          type: integer
        click:
          default: 0
          title: Click
          type: integer
        conversion:
          default: 0
          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
        cps:
          default: 0
          description: Cost per sale
          title: Cps
          type: number
        ctr:
          default: 0
          description: Click-through rate
          title: Ctr
          type: number
        cvr:
          default: 0
          description: Conversion rate
          title: Cvr
          type: number
        impression:
          default: 0
          title: Impression
          type: integer
        pub_revenue:
          default: 0
          description: Publisher revenue attributed to this bucket
          title: Pub Revenue
          type: number
        sales:
          default: 0
          title: Sales
          type: number
      required:
        - bucket_id
      title: BucketMetricBaseSchema
      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
    BucketLineItemMetricSchema:
      description: A single line item's share of the bucket it is served in.
      properties:
        bucket_id:
          description: Bucket identifier within the experiment
          title: Bucket Id
          type: integer
        click:
          default: 0
          title: Click
          type: integer
        conversion:
          default: 0
          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
        cps:
          default: 0
          description: Cost per sale
          title: Cps
          type: number
        ctr:
          default: 0
          description: Click-through rate
          title: Ctr
          type: number
        cvr:
          default: 0
          description: Conversion rate
          title: Cvr
          type: number
        impression:
          default: 0
          title: Impression
          type: integer
        impression_share:
          default: 0
          description: Impression share within the bucket, in percent
          title: Impression Share
          type: number
        lid:
          description: The line item ID
          format: uuid
          title: Lid
          type: string
        name:
          default: ''
          description: Line item name
          title: Name
          type: string
        pub_revenue:
          default: 0
          description: Publisher revenue attributed to this line item
          title: Pub Revenue
          type: number
        reach:
          default: 0
          title: Reach
          type: integer
        sales:
          default: 0
          title: Sales
          type: number
      required:
        - bucket_id
        - lid
      title: BucketLineItemMetricSchema
      type: object
  securitySchemes:
    HTTPBearer:
      description: >-
        Bearer authentication. Pass the access token in the `Authorization:
        Bearer <token>` header.
      scheme: bearer
      type: http

````