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

# List dashboards

`GET /v2/dashboards`

Get a paginated list of dashboards that your account has access to.

## Query parameters

- `page[size]` integer
- `page[number]` integer
- `filter` DashboardFilterParameters
  - `id` UuidFieldFilter — Filter using **one** of the following operators: `eq`, `oeq`, `neq`
    - `eq` string — The field exactly matches the provided value.
    - `oeq` string — The field matches any of the provided values.
    - `neq` string — The field does not match the provided value.
  - `name` StringFieldFilter — Filter using **one** of the following operators: `eq`, `oeq`, `neq`, `contains`, `ocontains`
    - `eq` string — The field exactly matches the provided value.
    - `contains` string — The field contains the provided value.
    - `ocontains` string — The field contains any of the provided values.
    - `oeq` string — The field matches any of the provided values.
    - `neq` string — The field does not match the provided value.
  - `labels` LabelsFieldFilter — Filter using **one** of the following operators: `eq`, `oeq`, `neq`, `contains`, `ocontains`
    - `eq` string — The field exactly matches the provided value.
    - `contains` string — The field contains the provided value.
    - `ocontains` string — The field contains any of the provided values.
    - `oeq` string — The field matches any of the provided values.
    - `neq` string — The field does not match the provided value.
  - `created_at` union — Filters on the given datetime (RFC-3339) field value.
    - object
      - `eq` string, date-time, required — Value strictly equals given RFC-3339 formatted timestamp in UTC
    - object
      - `lt` string, date-time, required — Value is less than the given RFC-3339 formatted timestamp in UTC
    - object
      - `lte` string, date-time, required — Value is less than or equal to the given RFC-3339 formatted timestamp in UTC
    - object
      - `gt` string, date-time, required — Value is greater than the given RFC-3339 formatted timestamp in UTC
    - object
      - `gte` string, date-time, required — Value is greater than or equal to the given RFC-3339 formatted timestamp in UTC
  - `updated_at` union — Filters on the given datetime (RFC-3339) field value.
    - object
      - `eq` string, date-time, required — Value strictly equals given RFC-3339 formatted timestamp in UTC
    - object
      - `lt` string, date-time, required — Value is less than the given RFC-3339 formatted timestamp in UTC
    - object
      - `lte` string, date-time, required — Value is less than or equal to the given RFC-3339 formatted timestamp in UTC
    - object
      - `gt` string, date-time, required — Value is greater than the given RFC-3339 formatted timestamp in UTC
    - object
      - `gte` string, date-time, required — Value is greater than or equal to the given RFC-3339 formatted timestamp in UTC
- `sort` string — Sorts a collection of dashboards. Supported sort attributes are: - name - created_at - updated_at The `asc` suffix is optional as the default sort order is ascending. The `desc` suffix is used to specify a descending order. Multiple sort attributes may be provided via a comma separated list.

## Response `200`

List of dashboards

- object
  - `meta` PaginatedMeta — returns the pagination information
    - `page` PageMeta, required — Contains pagination query parameters and the total number of objects returned.
      - `number` number, required
      - `size` number, required
      - `total` number, required
  - `data` DashboardResponse[]
    - `name` string, required — The dashboard name, which is displayed at the top of the dashboard and in lists. It does not need to be unique.
    - `definition` Dashboard, required — A JSON object describing a dashboard. A dashboard is an array of tiles. All tiles are of type 'chart', which query data and render a visualization, either a chart or table. Dashboards have 6 columns and as many rows as necessary to display their tiles.
      - `tiles` Tile[], required — The array of tiles. We currently support up to 102 tiles, which is 17 rows of 6x1 tiles.
        - `layout` object, required — Information about how the tile is placed on the dashboard. Examples: - a tile occupying the first half of the top row: `{ "position": { "col": 0, "row": 0 }, size: { "cols": 3, "rows": 1 } }` - a tile occupying the second half of the top row: `{ "position": { "col": 3, "row": 0 }, size: { "cols": 3, "rows": 1 } }`
          - `position` object, required — Position of the tile in the dashboard's grid. Numbering starts at 0, so a tile in the upper left of the dashboard will be at column 0, row 0.
            - `col` integer, required
            - `row` integer, required
          - `size` object, required — Number of columns and rows the tile occupies. A dashboard always has 6 columns, but has as many rows as needed to accommodate the given tiles.
            - `cols` integer, required
            - `rows` integer, required
        - `type` 'chart', required — The type of tile. Chart tiles must have type 'chart'.
        - `definition` union, required — The tile's definition, which consists of a query to fetch data and a visualization to render the data. Charts and tables expect certain query types to render properly. The documentation for the individual visualization types has more information.
          - ChartTileDefinition
            - `query` union, required
              - …
            - `chart` union, required — The type of chart to render.
              - …
          - TableChartTileDefinition
            - `query` PlatformTabularQuery, required — A query targeting tabular platform usage analytics data.
              - …
            - `chart` TableChart, required — A table that displays tabular platform usage data.
              - …
      - `preset_filters` AllFilterItems[] — An optional array of filters that are applied globally to all relevant tiles in the dashboard. Whether or not a preset filter applies to a tile depends on the filter's dimension. Some dimensions, like `control_plane`, are common to all datasources; other dimensions may only apply to one datasource.
        - `field` 'a2a_context_id' | 'a2a_error' | 'a2a_method' | 'a2a_task_id' | 'ai_plugin' | 'ai_provider' | 'ai_request_model' | 'ai_response_model' | 'api' | 'api_package' | 'api_product' | 'api_product_version' | 'application' | 'cache_status' | 'consumer' | 'control_plane' | 'control_plane_group' | 'country_code' | 'data_plane_node' | 'data_plane_node_version' | 'env' | 'gateway_service' | 'hostname' | 'llm_cache_status' | 'llm_embeddings_model' | 'llm_embeddings_provider' | 'mcp_error' | 'mcp_method' | 'mcp_session_id' | 'mcp_tool_name' | 'portal' | 'principal' | 'realm' | 'region' | 'response_source' | 'route' | 'status_code' | 'status_code_grouped' | 'team' | 'upstream_status_code' | 'upstream_status_code_grouped', required
        - `operator` 'in' | 'not_in' | 'empty' | 'not_empty', required
        - `value` unknown
    - `labels` Labels — Labels store metadata of an entity that can be used for filtering an entity list or for searching across entity types. Keys must be of length 1-63 characters, and cannot start with "kong", "konnect", "mesh", "kic", or "_".
    - `id` string, uuid — Contains a unique identifier used for this resource.
    - `created_by` string, uuid — Contains a unique identifier used for this resource.
    - `created_at` string, date-time — An ISO-8601 timestamp representation of entity creation date.
    - `updated_at` string, date-time — An ISO-8601 timestamp representation of entity update date.

## Other responses

- `401` — Unauthorized
- `403` — Forbidden

---

[API](https://skmtc.net/kong/apis/konnect-api-go-sdk.md) · [All operations](https://skmtc.net/kong/apis/konnect-api-go-sdk/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/kong/konnect-api-go-sdk/revisions/f920f418f552/schema)