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

> A2 통계와 캠페인 성과 데이터를 반환합니다.

- 관리자와 리테일러는 플랫폼 전체 통계를 받습니다.
- 광고주는 자신의 자산에 대한 통계만 받습니다.
- 소매업체와 광고주 계정의 총 수는 관리자와 소매업체만 볼 수 있습니다.
- 이전 시간대의 동일 기간 대비 변화율은 차이를 비교하여 계산됩니다.



## OpenAPI

````yaml /openapi/adm.openapi.ko-0.2.2.json get /dashboard
openapi: 3.1.0
info:
  description: >-
    ## 소개

    Data Management API는 광고 및 추천 시스템이 활용하는 **다양한 데이터를** 종합적으로 관리해, Decision API가
    정확하고 효율적으로 작동할 수 있도록 돕습니다.


    캠페인이나 지면을 신규 등록하고 수정·삭제하는 것은 물론, **로그 및 통계 분석을** 통해 시스템 운영에 필요한 인사이트를 확보합니다.
    이렇게 확보된 데이터와 통계는 Decision API에서 최적화된 광고·콘텐츠를 결정하는 데 활용되며, 전체 광고·추천 시스템의 성능
    향상에 이바지합니다.
  title: Data Management APIs
  version: 0.1.3
servers: []
security: []
tags:
  - name: Audience Targeting
  - description: >
      오디언스 관리 API를 사용하여 오디언스 관련 데이터를 통합할 수 있습니다.


      참고:

      - [First-Party
      Data](https://docs.aiderx.io/guides/about-a2/en/first-party-data)
    name: Audience
  - description: >
      광고 타겟팅 및 성과 최적화를 위한 사용자 활동 로그 수집 API.


      활동 로그는 광고 상호작용 여부와 관계없이 모든 사용자의 상품 조회, 검색, 장바구니 추가, 구매 등 실제 사용자 행동을 기록합니다.


      참고:

      - [First-Party
      Data](https://docs.aiderx.io/guides/about-a2/en/first-party-data)
    name: Activity Log
  - description: >
      오디언스 속성 API로 오디언스 속성 데이터에 액세스할 수 있습니다.


      참고:

      - [Audience
      Targeting](https://docs.aiderx.io/guides/about-a2/en/audience-targeting)
    name: Audience Attribute
  - description: >
      오디언스 세그먼트 API로 오디언스 세그먼트 데이터에 액세스할 수 있습니다.


      참고:

      - [Audience
      Targeting](https://docs.aiderx.io/guides/about-a2/en/audience-targeting)
    name: Audience Segment
  - description: >
      광고 타겟팅 및 성과 최적화를 위한 사용자 활동 로그 수집 API.


      활동 로그는 광고 상호작용 여부와 관계없이 모든 사용자의 상품 조회, 검색, 장바구니 추가, 구매 등 실제 사용자 행동을 기록합니다.


      참고:

      - [First-Party
      Data](https://docs.aiderx.io/guides/about-a2/en/first-party-data)
    name: Activity Log
  - description: >
      오디언스 속성 API로 오디언스 속성 데이터에 액세스할 수 있습니다.


      참고:

      - [Audience
      Targeting](https://docs.aiderx.io/guides/about-a2/en/audience-targeting)
    name: Audience Attribute
  - description: >
      오디언스 세그먼트 API로 오디언스 세그먼트 데이터에 액세스할 수 있습니다.


      참고:

      - [Audience
      Targeting](https://docs.aiderx.io/guides/about-a2/en/audience-targeting)
    name: Audience Segment
  - description: 분석 API는 대시보드 및 A2 메트릭 데이터에 액세스할 수 있습니다.
    name: Analytic
  - description: >-
      결제 정보를 관리하는 결제 API입니다.

      A2는 리테일 플랫폼에서 사용하는 결제 시스템과 통합되도록 구성되어 있습니다.


      결제를 통합하려면 먼저 외부 채널을 등록해야 합니다.

      결제 시스템과 통합하는 방법에 대한 자세한 내용은 [외부 채널
      페이지](https://docs.aiderx.io/guides/about-a2/en/external-channel)를 참고하세요.
    name: Billing
  - description: |
      캠페인 데이터를 관리하는 캠페인 API입니다.

      관련 문서:
      - [Campaign](https://docs.aiderx.io/guides/about-a2/en/campaign)
    name: Campaign
  - description: |
      소재 및 관련 리소스를 관리하는 크리에이티브 API입니다.

      관련 문서:
      - [Creative](https://docs.aiderx.io/guides/about-a2/en/creative)
    name: Creative
  - description: |
      배정 및 관련 리소스를 관리하는 할당 API입니다.

      관련 문서:
      - [Allocation](https://docs.aiderx.io/guides/about-a2/en/allocation)
    name: Allocation
  - description: |
      미디어 라이브러리 및 관련 리소스를 관리하는 미디어 라이브러리 API입니다.

      관련 문서:
      - [Media Library](https://docs.aiderx.io/guides/about-a2/en/media-library)
    name: Media Library
  - description: |
      소재 및 관련 리소스를 관리하는 크리에이티브 API입니다.

      관련 문서:
      - [Creative](https://docs.aiderx.io/guides/about-a2/en/creative)
    name: Creative
  - description: |
      배정 및 관련 리소스를 관리하는 할당 API입니다.

      관련 문서:
      - [Allocation](https://docs.aiderx.io/guides/about-a2/en/allocation)
    name: Allocation
  - description: |
      미디어 라이브러리 및 관련 리소스를 관리하는 미디어 라이브러리 API입니다.

      관련 문서:
      - [Media Library](https://docs.aiderx.io/guides/about-a2/en/media-library)
    name: Media Library
  - description: >
      카탈로그 관리 API는 카탈로그 및 관련 리소스를 관리하는 기능을 제공합니다.


      관련 문서:

      - [First-Party
      Data](https://docs.aiderx.io/guides/about-a2/en/first-party-data)
    name: Catalog
  - description: |
      지면 관리 API는 지면 및 관련 리소스를 관리하는 기능을 제공합니다.

      관련 문서:
      - [Placement](https://docs.aiderx.io/guides/about-a2/en/placement)
    name: Placement
  - description: |
      지면 카탈로그는 지면 정보를 구조화된 “광고 제품”으로 변환하여 광고주에게 쉽게 제시할 수 있습니다.

      관련 문서:
      - 업데이트 예정
    name: Placement Catalog
  - description: |
      지면 카탈로그는 지면 정보를 구조화된 “광고 제품”으로 변환하여 광고주에게 쉽게 제시할 수 있습니다.

      관련 문서:
      - 업데이트 예정
    name: Placement Catalog
  - description: >
      시스템 레벨 설정 및 자산(로고 및 구성 값)에 액세스하고 관리할 수 있는 시스템 API입니다.


      관련 문서:

      - [Yield Optimization
      Settings](https://docs.aiderx.io/guides/about-a2/en/yield-optimization)
    name: System
  - description: >
      인증 및 사용자 관리 기능을 제공합니다.


      관련 문서:

      - [Account and
      Budget](https://docs.aiderx.io/guides/about-a2/en/account-and-budget)
    name: Auth and User
  - description: 라이선스 관리 기능을 제공합니다.
    name: License
  - description: 라이선스 관리 기능을 제공합니다.
    name: License
paths:
  /dashboard:
    get:
      tags:
        - Analytic
      summary: Get dashboard data
      description: |-
        A2 통계와 캠페인 성과 데이터를 반환합니다.

        - 관리자와 리테일러는 플랫폼 전체 통계를 받습니다.
        - 광고주는 자신의 자산에 대한 통계만 받습니다.
        - 소매업체와 광고주 계정의 총 수는 관리자와 소매업체만 볼 수 있습니다.
        - 이전 시간대의 동일 기간 대비 변화율은 차이를 비교하여 계산됩니다.
      operationId: handle_get_dashboard_dashboard_get
      parameters:
        - in: query
          name: from_date
          required: false
          schema:
            format: date-time
            title: From Date
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DashboardSchema'
          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:
    DashboardSchema:
      description: 대시보드 스키마
      properties:
        change_allocations:
          default: 0
          description: 할당 수의 증감 비율
          title: Change Allocations
          type: number
        change_campaigns:
          default: 0
          description: 캠페인 수의 증감 비율
          title: Change Campaigns
          type: number
        change_clicks:
          default: 0
          description: 클릭 수의 증감 비율
          title: Change Clicks
          type: number
        change_conversions:
          default: 0
          description: 전환 수의 증감 비율
          title: Change Conversions
          type: number
        change_creatives:
          default: 0
          description: 소재 수의 증감 비율
          title: Change Creatives
          type: number
        change_impressions:
          default: 0
          description: 노출 수의 증감 비율
          title: Change Impressions
          type: number
        change_placements:
          default: 0
          description: 지면 수의 증감 비율
          title: Change Placements
          type: number
        email:
          description: 조회 대상 사용자의 이메일
          title: Email
          type: string
        from_date:
          format: date-time
          title: From Date
          type: string
        name:
          anyOf:
            - type: string
            - type: 'null'
          description: 조회 대상 사용자의 이름
          title: Name
        role:
          $ref: '#/components/schemas/UserRole'
        total_advertisers:
          default: 0
          description: 전제 광고주 수
          minimum: 0
          title: Total Advertisers
          type: integer
        total_allocations:
          default: 0
          description: 전체 할당 수
          minimum: 0
          title: Total Allocations
          type: integer
        total_campaigns:
          default: 0
          description: 전체 캠페인 수
          minimum: 0
          title: Total Campaigns
          type: integer
        total_clicks:
          default: 0
          description: 전체 클릭 수
          minimum: 0
          title: Total Clicks
          type: integer
        total_conversions:
          default: 0
          description: 전체 전환 수
          minimum: 0
          title: Total Conversions
          type: integer
        total_creatives:
          default: 0
          description: 전체 소재 수
          minimum: 0
          title: Total Creatives
          type: integer
        total_impressions:
          default: 0
          description: 전체 노출 수
          minimum: 0
          title: Total Impressions
          type: integer
        total_placements:
          default: 0
          description: 전체 지면 수
          minimum: 0
          title: Total Placements
          type: integer
        total_retailers:
          default: 0
          description: 전체 리테일러 수
          minimum: 0
          title: Total Retailers
          type: integer
      required:
        - email
        - role
        - from_date
      title: DashboardSchema
      type: object
    HTTPExceptionResponse:
      description: HTTP 오류 응답
      properties:
        detail:
          description: 오류에 대한 상세 설명
          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
    UserRole:
      description: 유저 역할
      enum:
        - advertiser
        - retailer
        - 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:
    OAuth2PasswordBearer:
      flows:
        password:
          scopes: {}
          tokenUrl: auth/jwt/login
      type: oauth2

````