> ## Documentation Index
> Fetch the complete documentation index at: https://private-7c7dfe99-mintlify-fbfa8bee.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Obter dashboard

> Retorna um dashboard específico por ID



## OpenAPI

````yaml /pt-BR/_specs/hyperdx-openapi.json get /api/v2/dashboards/{id}
openapi: 3.0.0
info:
  description: API para gerenciar alertas e dashboards do HyperDX
  title: HyperDX External API
  version: 2.0.0
servers:
  - description: Servidor de API de produção
    url: https://api.hyperdx.io
  - description: Servidor atual
    url: /
security:
  - BearerAuth: []
tags:
  - description: Endpoints para gerenciar dashboards e suas visualizações
    name: Dashboards
  - description: Endpoints para gerenciar alertas de monitoramento
    name: Alerts
paths:
  /api/v2/dashboards/{id}:
    get:
      tags:
        - Dashboards
      summary: Obter dashboard
      description: Retorna um dashboard específico por ID
      operationId: getDashboard
      parameters:
        - description: ID do dashboard
          example: 65f5e4a3b9e77c001a567890
          in: path
          name: id
          required: true
          schema:
            type: string
      responses:
        '200':
          content:
            application/json:
              examples:
                dashboard:
                  summary: Resposta de um único dashboard
                  value:
                    data:
                      id: 65f5e4a3b9e77c001a567890
                      name: Infrastructure Monitoring
                      tags:
                        - infrastructure
                        - monitoring
                      tiles:
                        - asRatio: false
                          h: 3
                          id: 65f5e4a3b9e77c001a901234
                          name: Server CPU
                          series:
                            - aggFn: avg
                              dataSource: metrics
                              field: cpu.usage
                              groupBy: []
                              type: time
                              where: host:server-01
                          w: 6
                          x: 0
                          'y': 0
                        - asRatio: false
                          h: 3
                          id: 65f5e4a3b9e77c001a901235
                          name: Memory Usage
                          series:
                            - aggFn: avg
                              dataSource: metrics
                              field: memory.usage
                              groupBy: []
                              type: time
                              where: host:server-01
                          w: 6
                          x: 6
                          'y': 0
              schema:
                $ref: '#/components/schemas/DashboardResponse'
          description: Dashboard recuperado com sucesso
        '401':
          content:
            application/json:
              example:
                message: Unauthorized access. API key is missing or invalid.
              schema:
                $ref: '#/components/schemas/Error'
          description: Não autorizado
        '404':
          content:
            application/json:
              example:
                message: Dashboard not found
              schema:
                $ref: '#/components/schemas/Error'
          description: Dashboard não encontrado
components:
  schemas:
    DashboardResponse:
      properties:
        data:
          $ref: '#/components/schemas/Dashboard'
      type: object
    Error:
      properties:
        message:
          type: string
      type: object
    Dashboard:
      properties:
        id:
          example: 65f5e4a3b9e77c001a567890
          type: string
        name:
          example: Service Overview
          type: string
        tags:
          example:
            - production
            - monitoring
          items:
            type: string
          type: array
        tiles:
          items:
            $ref: '#/components/schemas/Tile'
          type: array
      type: object
    Tile:
      properties:
        asRatio:
          example: false
          type: boolean
        h:
          example: 3
          type: integer
        id:
          example: 65f5e4a3b9e77c001a901234
          type: string
        name:
          example: Error Rate
          type: string
        series:
          items:
            $ref: '#/components/schemas/ChartSeries'
          type: array
        w:
          example: 6
          type: integer
        x:
          example: 0
          type: integer
        'y':
          example: 0
          type: integer
      type: object
    ChartSeries:
      properties:
        aggFn:
          description: Função de agregação a ser usada nos dados
          enum:
            - avg
            - count
            - count_distinct
            - last_value
            - max
            - min
            - quantile
            - sum
          example: count
          type: string
        dataSource:
          enum:
            - events
            - metrics
          example: events
          type: string
        field:
          description: Campo a ser agregado
          example: duration
          type: string
        groupBy:
          description: Campos pelos quais os resultados serão agrupados
          example:
            - service
            - host
          items:
            type: string
          type: array
        metricDataType:
          description: Tipo de dado da métrica
          enum:
            - sum
            - gauge
            - histogram
          example: gauge
          type: string
        metricName:
          description: Nome da métrica (para fontes de dados de métricas)
          example: http_requests_total
          type: string
        sourceId:
          description: ID da fonte de dados desta série
          example: 65f5e4a3b9e77c001a123456
          type: string
        type:
          enum:
            - time
            - table
            - number
            - histogram
            - search
            - markdown
          example: time
          type: string
        where:
          description: Condição de filtro na sintaxe de consulta do Lucene
          example: level:error
          type: string
        whereLanguage:
          description: Linguagem de consulta usada na cláusula WHERE
          enum:
            - lucene
            - sql
          example: lucene
          type: string
      required:
        - sourceId
        - aggFn
        - where
        - groupBy
      type: object
  securitySchemes:
    BearerAuth:
      bearerFormat: API Key
      scheme: bearer
      type: http

````