> ## Documentation Index
> Fetch the complete documentation index at: https://moengage.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Get Dashboard Charts

> Returns the details of a single dashboard, including its name, creator, and owner. It also returns the list of charts on the dashboard, in layout order. Each chart entry contains the chart's ID and name.


<Note>
  Chart data is not returned here. To fetch the data for a chart, use [Get Chart Data](/api/dashboards/get-chart-data) with the dashboard ID and chart ID.
</Note>


## OpenAPI

````yaml /api/analytics/analytics.yaml get /v5/analytics/dashboards/{dashboard_id}/charts
openapi: 3.0.3
info:
  title: MoEngage Analytics Dashboard and Chart API
  description: >
    Read-only REST APIs to access your MoEngage Custom Dashboards and the
    analytics data behind their charts. All endpoints are `GET` requests and do
    not modify any data.
  version: '5.0'
servers:
  - url: https://api-{dc}.moengage.com
    description: MoEngage API Server
    variables:
      dc:
        default: '01'
        description: >-
          The 'dc' in the API Endpoint URL refers to the MoEngage Data Center
          (DC). MoEngage hosts each customer in a different DC. You can find
          your DC number and replace the value of 'dc' in the URL by referring
          to the DC and API endpoint mapping
          [here](/api/introduction#data-centers). Your MoEngage Data Center (DC)
          can be 01, 02, 03, 04, 05, 06, or 101.
security:
  - basicAuth: []
tags:
  - name: Dashboards
    description: Read custom dashboards and their chart data.
paths:
  /v5/analytics/dashboards/{dashboard_id}/charts:
    get:
      tags:
        - Dashboards
      summary: Get Dashboard Charts
      description: >
        Returns the details of a single dashboard, including its name, creator,
        and owner. It also returns the list of charts on the dashboard, in
        layout order. Each chart entry contains the chart's ID and name.
      operationId: getDashboardCharts
      parameters:
        - $ref: '#/components/parameters/DashboardId'
        - $ref: '#/components/parameters/MoeAppKey'
        - $ref: '#/components/parameters/MoeTeamId'
      responses:
        '200':
          description: >-
            This response is returned when the request is processed
            successfully.
          content:
            application/json:
              schema:
                type: object
                properties:
                  response_id:
                    $ref: '#/components/schemas/ResponseId'
                  type:
                    type: string
                    description: The type of resource returned in the `data` field.
                    example: dashboard
                  data:
                    $ref: '#/components/schemas/DashboardData'
              example:
                response_id: b3f1c0d2-2a4e-4f9b-9c1a-6d2e8f0a1b23
                type: dashboard
                data:
                  name: Acquisition Overview
                  created_by: john.doe@example.com
                  owned_by: john.doe@example.com
                  chart_ids:
                    - _id: 67f9d9df279348ecdc84415f
                      name: New Users by Day
                    - _id: 68f08c79d33bd238d3ef00e0
                      name: Sign-ups by Channel
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '500':
          $ref: '#/components/responses/InternalError'
components:
  parameters:
    DashboardId:
      name: dashboard_id
      in: path
      required: true
      description: >-
        The unique identifier of the dashboard. You can retrieve dashboard IDs
        from the [List Dashboards](/api/dashboards/list-dashboards) response.
      schema:
        type: string
        example: 6a10ae88f3a1896d59d5bf8f
    MoeAppKey:
      name: MOE-APPKEY
      in: header
      required: true
      description: >-
        Your MoEngage workspace ID (also known as the App ID), which identifies
        the workspace the request applies to. You can find it in the MoEngage
        dashboard at **Settings** > **Account** > **APIs** > **Workspace ID
        (earlier app id)**.
      schema:
        type: string
        example: ABCD1234EFGH56789
    MoeTeamId:
      name: MOE-Team-ID
      in: header
      required: false
      description: >-
        The team ID, required only when MoEngage Teams is enabled for your
        workspace. Scopes the request to the specified team.
      schema:
        type: string
  schemas:
    ResponseId:
      type: string
      description: >-
        A unique identifier for this response. Include it when reporting issues
        to MoEngage Support to help trace the request.
      example: b3f1c0d2-2a4e-4f9b-9c1a-6d2e8f0a1b23
    DashboardData:
      type: object
      description: A dashboard's details and the charts laid out on it.
      properties:
        name:
          type: string
          description: The name of the dashboard.
          example: Acquisition Overview
        created_by:
          type: string
          format: email
          description: The email address of the user who created the dashboard.
          example: john.doe@example.com
        owned_by:
          type: string
          format: email
          description: The email address of the dashboard's current owner.
          example: john.doe@example.com
        chart_ids:
          type: array
          description: >-
            The charts laid out on the dashboard, in layout order. Each entry
            includes the chart's ID and name.
          items:
            $ref: '#/components/schemas/ChartSummary'
    ChartSummary:
      type: object
      description: A chart laid out on the dashboard.
      properties:
        _id:
          type: string
          description: The unique identifier of the chart.
          example: 67f9d9df279348ecdc84415f
        name:
          type: string
          description: The name of the chart.
          example: New Users by Day
  responses:
    BadRequest:
      description: >-
        This response is returned when the dashboard ID or chart ID is invalid,
        or the request is malformed.
      content:
        application/json:
          schema:
            type: object
            properties:
              error:
                type: object
                properties:
                  code:
                    type: string
                    description: A machine-readable error code.
                    example: VALIDATION_FAILED
                  message:
                    type: string
                    description: A human-readable description of the error.
                    example: Invalid dashboard_id.
                  target:
                    type: string
                    description: >-
                      The field or parameter the error refers to, when
                      applicable.
                    example: dashboard_id
                  doc_url:
                    type: string
                    description: A link to documentation about this error, when available.
              response_id:
                $ref: '#/components/schemas/ResponseId'
    Unauthorized:
      description: >-
        This response is returned when the authentication credentials are
        missing or invalid.
      content:
        application/json:
          schema:
            type: object
            properties:
              error:
                type: object
                properties:
                  code:
                    type: string
                    description: A machine-readable error code.
                    example: UNAUTHORIZED
                  message:
                    type: string
                    description: A human-readable description of the error.
                    example: Missing or invalid credentials.
                  target:
                    type: string
                    description: >-
                      The field or parameter the error refers to, when
                      applicable.
                  doc_url:
                    type: string
                    description: A link to documentation about this error, when available.
              response_id:
                $ref: '#/components/schemas/ResponseId'
    Forbidden:
      description: >-
        This response is returned when the caller does not have access to the
        requested dashboard or chart, or the selected team is not permitted.
      content:
        application/json:
          schema:
            type: object
            properties:
              error:
                type: object
                properties:
                  code:
                    type: string
                    description: A machine-readable error code.
                    example: FORBIDDEN
                  message:
                    type: string
                    description: A human-readable description of the error.
                    example: >-
                      This request cannot be performed in the selected team.
                      Please select the correct team.
                  target:
                    type: string
                    description: >-
                      The field or parameter the error refers to, when
                      applicable.
                    example: MOE-Team-ID
                  doc_url:
                    type: string
                    description: A link to documentation about this error, when available.
              response_id:
                $ref: '#/components/schemas/ResponseId'
    NotFound:
      description: >-
        This response is returned when the requested dashboard or chart does not
        exist.
      content:
        application/json:
          schema:
            type: object
            properties:
              error:
                type: object
                properties:
                  code:
                    type: string
                    description: A machine-readable error code.
                    example: NOT_FOUND
                  message:
                    type: string
                    description: A human-readable description of the error.
                    example: Dashboard not found.
                  target:
                    type: string
                    description: >-
                      The field or parameter the error refers to, when
                      applicable.
                  doc_url:
                    type: string
                    description: A link to documentation about this error, when available.
              response_id:
                $ref: '#/components/schemas/ResponseId'
    InternalError:
      description: This response is returned when the system runs into an unexpected error.
      content:
        application/json:
          schema:
            type: object
            properties:
              error:
                type: object
                properties:
                  code:
                    type: string
                    description: A machine-readable error code.
                    example: INTERNAL_ERROR
                  message:
                    type: string
                    description: A human-readable description of the error.
                    example: An unexpected error occurred while processing the request.
                  target:
                    type: string
                    description: >-
                      The field or parameter the error refers to, when
                      applicable.
                  doc_url:
                    type: string
                    description: A link to documentation about this error, when available.
              response_id:
                $ref: '#/components/schemas/ResponseId'
  securitySchemes:
    basicAuth:
      type: http
      scheme: basic
      description: >
        Authentication is done via Basic Auth. This requires a base64-encoded
        string of your credentials in the format `username:password`.


        - **Username**: Use your MoEngage workspace ID (also known as the App
        ID). You can find it in the MoEngage dashboard at **Settings** >
        **Account** > **APIs** > **Workspace ID (earlier app id)**.

        - **Password**: Use your Data API Key, which you can find in the
        MoEngage dashboard at **Settings** > **Account** > **APIs**.


        For more information, see
        [Authentication](/api/introduction#authentication).

````