> ## 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 campaign performance data.

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



## OpenAPI

````yaml /openapi/adm.openapi.en-0.2.2.json get /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: 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:
  /dashboard:
    get:
      tags:
        - Analytic
      summary: Get dashboard data
      description: >-
        Returns general A2 statistics and campaign performance data.


        - Admins and retailers receive platform-wide statistics.

        - Advertisers receive statistics for their own assets only.

        - Total number of retailer and advertiser accounts is only visible to
        admins and retailers.

        - The percentage change is calculated based on the difference compared
        to the same period in the previous timerange.
      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: Schema for dashboard entity.
      properties:
        change_allocations:
          default: 0
          description: >-
            Percentage change in number of allocations compared to previous
            period.
          title: Change Allocations
          type: number
        change_campaigns:
          default: 0
          description: >-
            Percentage change in number of campaigns compared to previous
            period.
          title: Change Campaigns
          type: number
        change_clicks:
          default: 0
          description: Percentage change in number of clicks compared to previous period.
          title: Change Clicks
          type: number
        change_conversions:
          default: 0
          description: >-
            Percentage change in number of conversions compared to previous
            period.
          title: Change Conversions
          type: number
        change_creatives:
          default: 0
          description: >-
            Percentage change in number of creatives compared to previous
            period.
          title: Change Creatives
          type: number
        change_impressions:
          default: 0
          description: >-
            Percentage change in number of impressions compared to previous
            period.
          title: Change Impressions
          type: number
        change_placements:
          default: 0
          description: >-
            Percentage change in number of placements compared to previous
            period.
          title: Change Placements
          type: number
        email:
          description: The 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: The name of the query user.
          title: Name
        role:
          $ref: '#/components/schemas/UserRole'
        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_campaigns:
          default: 0
          description: Total number of campaigns.
          minimum: 0
          title: Total Campaigns
          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_placements:
          default: 0
          description: Total number of placements.
          minimum: 0
          title: Total Placements
          type: integer
        total_retailers:
          default: 0
          description: Total number of retailers.
          minimum: 0
          title: Total Retailers
          type: integer
      required:
        - email
        - role
        - from_date
      title: DashboardSchema
      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
    UserRole:
      description: User role enum.
      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

````