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

# List dashboards

> List the built-in dashboards and your organization's custom dashboards, with their widgets. Built-in dashboards contain pre-built TRQL queries for common metrics like run success rates, costs, and LLM usage.



## OpenAPI

````yaml v3-openapi GET /api/v1/query/dashboards
openapi: 3.1.0
info:
  title: Trigger.dev v3 REST API
  description: >-
    The REST API lets you trigger and manage runs on Trigger.dev. You can
    trigger a run, get the status of a run, and get the results of a run. 
  version: 2024-04
  license:
    name: Apache 2.0
    url: https://www.apache.org/licenses/LICENSE-2.0.html
servers:
  - url: https://api.trigger.dev
    description: Trigger.dev API
security: []
paths:
  /api/v1/query/dashboards:
    get:
      tags:
        - query
      summary: List dashboards
      description: >-
        List the built-in dashboards and your organization's custom dashboards,
        with their widgets. Built-in dashboards contain pre-built TRQL queries
        for common metrics like run success rates, costs, and LLM usage.
      operationId: list_dashboards_v1
      responses:
        '200':
          description: Dashboards listed successfully
          content:
            application/json:
              schema:
                type: object
                properties:
                  dashboards:
                    type: array
                    items:
                      type: object
                      properties:
                        key:
                          type: string
                          description: >-
                            Dashboard identifier. Built-in dashboards use a key
                            like "overview" or "llm"; custom dashboards use
                            their id.
                        title:
                          type: string
                          description: Dashboard display title
                        type:
                          type: string
                          enum:
                            - builtIn
                            - custom
                          description: >-
                            Built-in dashboards are read-only. Custom dashboards
                            can be changed with the endpoints below.
                        description:
                          type: string
                          description: The dashboard description (custom dashboards only)
                        widgets:
                          type: array
                          items:
                            type: object
                            properties:
                              id:
                                type: string
                                description: Widget identifier
                              title:
                                type: string
                                description: Widget display title
                              query:
                                type: string
                                description: The TRQL query this widget executes
                              type:
                                type: string
                                enum:
                                  - bignumber
                                  - chart
                                  - table
                                description: Widget display type
        '401':
          description: Unauthorized - API key is missing or invalid
      security:
        - secretKey: []
      x-codeSamples:
        - lang: curl
          label: cURL
          source: |-
            curl "https://api.trigger.dev/api/v1/query/dashboards" \
              -H "Authorization: Bearer tr_dev_sk_1234"
components:
  securitySchemes:
    secretKey:
      type: http
      scheme: bearer
      description: >
        Use a named environment API key. It starts with `tr_dev_sk_`,
        `tr_prod_sk_`, `tr_stg_sk_`, etc.


        Create a named API key in the API Keys section of your Trigger.dev
        project dashboard. Choose the narrowest access preset that supports your
        integration.


        Our TypeScript SDK will default to using the value of the
        `TRIGGER_SECRET_KEY` environment variable if it is set. If you are using
        the SDK in a different environment, you can set the key using the
        `configure` function.


        ```typescript

        import { configure } from "@trigger.dev/sdk";


        configure({ accessToken: "tr_dev_sk_1234" });

        ```

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.