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

# List Dashboards

> Returns the custom dashboards available to the authenticated workspace. Archived dashboards are excluded.


<Note>
  Only workspace-level (public) dashboards are returned. Private dashboards and team-level dashboards are not available through this API.
</Note>


## OpenAPI

````yaml /api/analytics/analytics.yaml get /v5/analytics/dashboards
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:
    get:
      tags:
        - Dashboards
      summary: List Dashboards
      description: >
        Returns the custom dashboards available to the authenticated workspace.
        Archived dashboards are excluded.
      operationId: listDashboards
      parameters:
        - $ref: '#/components/parameters/MoeAppKey'
        - $ref: '#/components/parameters/MoeTeamId'
      responses:
        '200':
          description: >
            This response is returned when the request is processed
            successfully.


            Each item contains the dashboard ID and name. Use the dashboard ID
            with [Get Dashboard Charts](/api/dashboards/get-dashboard-charts) to
            retrieve the charts on a dashboard.
          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:
                    type: array
                    description: The list of dashboards accessible to the workspace.
                    items:
                      $ref: '#/components/schemas/DashboardSummary'
              example:
                response_id: b3f1c0d2-2a4e-4f9b-9c1a-6d2e8f0a1b23
                type: dashboard
                data:
                  - _id: 63ede292b4c6a68b18c2c93f
                    name: Acquisition Overview
                  - _id: 63ef1f824da10b4fd96c6e3b
                    name: Retention Deep Dive
        '401':
          $ref: '#/components/responses/Unauthorized'
        '500':
          $ref: '#/components/responses/InternalError'
components:
  parameters:
    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
    DashboardSummary:
      type: object
      description: A dashboard accessible to the workspace.
      properties:
        _id:
          type: string
          description: The unique identifier of the dashboard.
          example: 63ede292b4c6a68b18c2c93f
        name:
          type: string
          description: The name of the dashboard.
          example: Acquisition Overview
  responses:
    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'
    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).

````