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

> Returns general A2 statistics and line item performance data.

- Admins and operators receive platform-wide statistics.
- Advertisers receive statistics for their own assets only.
- Total number of operator and advertiser accounts is only visible to admins and operators.
- The percentage change is calculated based on the difference compared to the same period in the previous time range.



## OpenAPI

````yaml /openapi/adm.openapi.en-dev.json get /api/manager/dashboard
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/dashboard:
    get:
      tags:
        - Dashboard
      summary: Get dashboard data
      description: >-
        Returns general A2 statistics and line item performance data.


        - Admins and operators receive platform-wide statistics.

        - Advertisers receive statistics for their own assets only.

        - Total number of operator and advertiser accounts is only visible to
        admins and operators.

        - The percentage change is calculated based on the difference compared
        to the same period in the previous time range.
      operationId: handle_get_dashboard_api_manager_dashboard_get
      parameters:
        - in: query
          name: from_date
          required: true
          schema:
            format: date-time
            title: From Date
            type: string
        - in: query
          name: to_date
          required: false
          schema:
            anyOf:
              - format: date-time
                type: string
              - type: 'null'
            title: To Date
        - in: query
          name: media
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            title: Media
        - in: query
          name: timezone
          required: false
          schema:
            default: Asia/Seoul
            title: Timezone
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DashboardSchema'
          description: Successful Response
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
          description: Validation Error
      security:
        - HTTPBearer: []
components:
  schemas:
    DashboardSchema:
      properties:
        change_allocations:
          default: 0
          description: Percentage change in allocations compared to previous period.
          title: Change Allocations
          type: number
        change_clicks:
          default: 0
          description: Percentage change in clicks compared to previous period.
          title: Change Clicks
          type: number
        change_conversions:
          default: 0
          description: Percentage change in conversions compared to previous period.
          title: Change Conversions
          type: number
        change_creatives:
          default: 0
          description: Percentage change in creatives compared to previous period.
          title: Change Creatives
          type: number
        change_impressions:
          default: 0
          description: Percentage change in impressions compared to previous period.
          title: Change Impressions
          type: number
        change_line_items:
          default: 0
          description: Percentage change in line items compared to previous period.
          title: Change Line Items
          type: number
        change_placements:
          default: 0
          description: Percentage change in placements compared to previous period.
          title: Change Placements
          type: number
        email:
          description: Email of the query user.
          title: Email
          type: string
        from_date:
          format: date-time
          title: From Date
          type: string
        name:
          anyOf:
            - type: string
            - type: 'null'
          description: Name of the query user.
          title: Name
        role:
          $ref: '#/components/schemas/UserRole'
        to_date:
          format: date-time
          title: To Date
          type: string
        total_advertisers:
          default: 0
          description: Total number of advertisers.
          minimum: 0
          title: Total Advertisers
          type: integer
        total_allocations:
          default: 0
          description: Total number of allocations.
          minimum: 0
          title: Total Allocations
          type: integer
        total_clicks:
          default: 0
          description: Total number of clicks.
          minimum: 0
          title: Total Clicks
          type: integer
        total_conversions:
          default: 0
          description: Total number of conversions.
          minimum: 0
          title: Total Conversions
          type: integer
        total_creatives:
          default: 0
          description: Total number of creatives.
          minimum: 0
          title: Total Creatives
          type: integer
        total_impressions:
          default: 0
          description: Total number of impressions.
          minimum: 0
          title: Total Impressions
          type: integer
        total_line_items:
          default: 0
          description: Total number of line items.
          minimum: 0
          title: Total Line Items
          type: integer
        total_operators:
          default: 0
          description: Total number of operators.
          minimum: 0
          title: Total Operators
          type: integer
        total_placements:
          default: 0
          description: Total number of placements.
          minimum: 0
          title: Total Placements
          type: integer
      required:
        - email
        - role
        - from_date
        - to_date
      title: DashboardSchema
      type: object
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          title: Detail
          type: array
      title: HTTPValidationError
      type: object
    UserRole:
      enum:
        - advertiser
        - operator
        - admin
      title: UserRole
      type: string
    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:
    HTTPBearer:
      description: >-
        Bearer authentication. Pass the access token in the `Authorization:
        Bearer <token>` header.
      scheme: bearer
      type: http

````