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

# Get a dashboard

> Returns a dashboard with its variables and every widget's type, settings, and position.



## OpenAPI

````yaml /api-reference/openapi.json get /dashboards/{dashboardId}
openapi: 3.1.0
info:
  description: >-
    Manage a Superlog workspace's automations, runs, tag mode, model access, and
    secrets, read its telemetry, build dashboards and alerts over it, run
    synthetic checks, and export them to Terraform. Every request acts as the
    member who created the API key.
  title: Superlog management API
  version: 1.0.0
servers:
  - url: https://superlog.sh/api/v1
security:
  - bearerAuth: []
tags:
  - description: Connected integrations and the IDs automations and tag mode use.
    name: Integrations
  - description: The workspace and its members.
    name: Workspace
  - description: Keys that authenticate the management API and MCP server.
    name: API keys
  - description: Create and change automations.
    name: Automations
  - description: Start, follow, and cancel automation runs.
    name: Runs
  - description: What Superlog can use and change when someone mentions it in Slack.
    name: Tag mode
  - description: Model API keys, subscriptions, and available models.
    name: Models
  - description: Credentials agents can use without seeing them.
    name: Secrets
  - description: Read the workspace's logs, traces, and metrics.
    name: Telemetry
  - description: >-
      Exceptions in the workspace's telemetry, grouped into issues by
      fingerprint.
    name: Errors
  - description: Create and change dashboards over the workspace's telemetry.
    name: Dashboards
  - description: Threshold alerts on the workspace's telemetry that post to Slack.
    name: Alerts
  - description: HTTP checks that request a URL on a schedule and post failures to Slack.
    name: Synthetics
  - description: Configuration for the superloglabs/superlog Terraform provider.
    name: Terraform
paths:
  /dashboards/{dashboardId}:
    get:
      tags:
        - Dashboards
      summary: Get a dashboard
      description: >-
        Returns a dashboard with its variables and every widget's type,
        settings, and position.
      operationId: get_dashboard
      parameters:
        - description: Dashboard ID.
          in: path
          name: dashboardId
          required: true
          schema:
            type: string
            format: uuid
            description: Dashboard ID.
      responses:
        '200':
          content:
            application/json:
              schema:
                type: object
                properties:
                  dashboard:
                    type: object
                    properties:
                      id:
                        type: string
                        format: uuid
                        description: Dashboard ID.
                      name:
                        type: string
                      updatedAt:
                        type: string
                        format: date-time
                      url:
                        type: string
                        format: uri
                        description: The dashboard in Superlog.
                      variables:
                        type: array
                        items:
                          type: object
                          propertyNames:
                            type: string
                          additionalProperties: {}
                      widgets:
                        type: array
                        items:
                          type: object
                          properties:
                            config:
                              type: object
                              propertyNames:
                                type: string
                              additionalProperties: {}
                              description: The widget's settings.
                            id:
                              type: string
                              format: uuid
                              description: Widget ID.
                            layout:
                              type: object
                              properties:
                                h:
                                  type: number
                                w:
                                  type: number
                                x:
                                  type: number
                                'y':
                                  type: number
                              required:
                                - h
                                - w
                                - x
                                - 'y'
                              additionalProperties: false
                            position:
                              type: integer
                            title:
                              type: string
                            type:
                              type: string
                              enum:
                                - timeseries_count
                                - timeseries_metric
                                - log_table
                                - trace_table
                                - markdown
                          required:
                            - config
                            - id
                            - layout
                            - position
                            - title
                            - type
                          additionalProperties: false
                    required:
                      - id
                      - name
                      - updatedAt
                      - url
                      - variables
                      - widgets
                    additionalProperties: false
                required:
                  - dashboard
                additionalProperties: false
          description: OK
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
          description: The request is invalid. `issues` lists each invalid field.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
          description: The API key is missing, revoked, or its creator left the workspace.
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
          description: >-
            The resource does not exist in this workspace, or the feature it
            belongs to is not enabled.
      security:
        - bearerAuth: []
components:
  schemas:
    Error:
      type: object
      properties:
        code:
          description: A stable machine-readable error code, when there is one.
          type: string
        error:
          type: string
          description: What went wrong.
        issues:
          description: Validation problems, one per invalid field.
          type: array
          items:
            type: object
            properties:
              message:
                type: string
              path:
                type: array
                items:
                  anyOf:
                    - type: string
                    - type: number
            required:
              - message
              - path
            additionalProperties: false
      required:
        - error
      additionalProperties: false
  securitySchemes:
    bearerAuth:
      description: A workspace API key, created in Superlog under Settings → API keys.
      scheme: bearer
      type: http

````

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