---
title: "List Dashboards"
method: GET
path: "/api/v2/dashboards"
tags: ["Dashboards"]
---

# List Dashboards

`GET /api/v2/dashboards`

Retrieves a list of all dashboards for the authenticated team

## Response `200`

Successfully retrieved dashboards

- DashboardsListResponse
  - `data` DashboardResponse[]
    - `id` string — Dashboard ID
    - `name` string — Dashboard name
    - `tiles` Tile[] — List of tiles/charts in the dashboard
      - `name` string, required — Display name for the tile
      - `x` integer, required — Horizontal position in the grid (0-based)
      - `y` integer, required — Vertical position in the grid (0-based)
      - `w` integer, required — Width in grid units
      - `h` integer, required — Height in grid units
      - `asRatio` boolean — Display two series as a ratio (series[0] / series[1])
      - `series` DashboardChartSeries[], required — Data series to display in this tile (all must be the same type)
        - union
          - TimeChartSeries
            - `type` 'time', required
            - `sourceId` string, required — ID of the data source to query
            - `aggFn` 'avg' | 'count' | 'count_distinct' | 'last_value' | 'max' | 'min' | 'quantile' | 'sum' | 'any' | 'none', required — Aggregation function to apply to the field or metric value.
            - `level` number — Percentile level for quantile aggregations (e.g., 0.95 for p95)
            - `field` string — Field/property name to aggregate (required for most aggregation functions except count)
            - `alias` string — Display name for the series in the chart
            - `where` string, required — Filter query for the data (syntax depends on whereLanguage)
            - `whereLanguage` 'sql' | 'lucene' — Query language for the where clause.
            - `groupBy` string[], required — Fields to group results by (creates separate series for each group)
            - `numberFormat` NumberFormat
              - …
            - `metricDataType` 'sum' | 'gauge' | 'histogram' | 'summary' | 'exponential histogram' — Metric data type for metrics data sources.
            - `metricName` string — Metric name for metrics data sources
            - `displayType` 'stacked_bar' | 'line' — Visual representation type for the time series.
          - TableChartSeries
            - `type` 'table', required
            - `sourceId` string, required — ID of the data source to query
            - `aggFn` 'avg' | 'count' | 'count_distinct' | 'last_value' | 'max' | 'min' | 'quantile' | 'sum' | 'any' | 'none', required — Aggregation function to apply to the field or metric value.
            - `level` number — Percentile level for quantile aggregations (e.g., 0.95 for p95)
            - `field` string
            - `alias` string
            - `where` string, required
            - `whereLanguage` 'sql' | 'lucene' — Query language for the where clause.
            - `groupBy` string[], required
            - `sortOrder` 'desc' | 'asc' — Sort order for table rows.
            - `numberFormat` NumberFormat
              - …
            - `metricDataType` 'sum' | 'gauge' | 'histogram' | 'summary' | 'exponential histogram' — Metric data type for metrics data sources.
            - `metricName` string — Metric name for metrics data sources
          - NumberChartSeries
            - `type` 'number', required
            - `sourceId` string, required — ID of the data source to query
            - `aggFn` 'avg' | 'count' | 'count_distinct' | 'last_value' | 'max' | 'min' | 'quantile' | 'sum' | 'any' | 'none', required — Aggregation function to apply to the field or metric value.
            - `level` number — Percentile level for quantile aggregations (e.g., 0.95 for p95)
            - `field` string
            - `alias` string
            - `where` string, required
            - `whereLanguage` 'sql' | 'lucene' — Query language for the where clause.
            - `numberFormat` NumberFormat
              - …
            - `metricDataType` 'sum' | 'gauge' | 'histogram' | 'summary' | 'exponential histogram' — Metric data type for metrics data sources.
            - `metricName` string
          - SearchChartSeries
            - `type` 'search', required
            - `sourceId` string, required — ID of the data source to query
            - `fields` string[], required — List of field names to display in the search results table
            - `where` string, required — Filter query for the data (syntax depends on whereLanguage)
            - `whereLanguage` 'sql' | 'lucene' — Query language for the where clause.
          - MarkdownChartSeries
            - `type` 'markdown', required
            - `content` string, required
      - `id` string, required
    - `tags` string[] — Tags for organizing and filtering dashboards

## Other responses

- `401` — Unauthorized

## Changes

- **2026-02-02** `e856dc2f1417` — 1 breaking, 4 warning, 1 info
  - the `data/items/` response's property type/format changed from `object`/`` to ``/`` for status `200`
  - removed the optional property `data/items/id` from the response with the `200` status
  - removed the optional property `data/items/name` from the response with the `200` status
  - removed the optional property `data/items/tags` from the response with the `200` status
  - …2 more
- **2026-01-30** `ed852374c451` — 1 breaking, 5 info
  - the `data/items/` response's property type/format changed from ``/`` to `object`/`` for status `200`
  - added the optional property `data/items/id` to the response with the `200` status
  - added the optional property `data/items/name` to the response with the `200` status
  - added the optional property `data/items/tags` to the response with the `200` status
  - …2 more

[Change history](https://skmtc.dev/hyperdxio/apis/hyperdx-external-api/changes/api/v2/dashboards/get.md)

---

[API](https://skmtc.dev/hyperdxio/apis/hyperdx-external-api.md) · [All operations](https://skmtc.dev/hyperdxio/apis/hyperdx-external-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/hyperdxio/hyperdx-external-api/revisions/50f295ac37bd/schema)