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

# 查询仪表盘列表

> 查询本账户的仪表盘列表，默认按最近修改倒序。

## 限制说明

| 项目 | 说明 |
| - | - |
| 速率限制 | 每个账户 **1,000 次/分钟**；**50 次/秒** |
| 权限要求 | 无 —— 持有有效的 `app_key` 即可调用 |

## 使用说明

* 不返回定义；查看单个仪表盘请调用 `POST /rum/dashboard/get`。
* `query` 同时匹配标题和描述，空格分隔的每个词都须命中。已删除的仪表盘请用 `POST /rum/dashboard/trash/list` 查询。


## OpenAPI

````yaml /api-reference/rum.openapi.zh.json post /rum/dashboard/list
openapi: 3.1.0
info:
  description: >-
    Flashduty 事件管理平台的公开 HTTP API —— 覆盖故障、通知模板、协作空间、值班排班、监控、RUM、以及平台管理。每次调用都需在
    query 中携带 `app_key`，该 key 在 Flashduty 控制台 我的 → APP Key 中创建（也可放在请求头
    `Fd-App-Key` 中）。所有响应使用统一结构：成功时为 `{ request_id, data }`，失败时为 `{ request_id,
    error }`。
  title: Flashduty 开放 API
  version: 1.0.0
servers:
  - description: Flashduty Open API
    url: https://api.flashcat.cloud
security:
  - AppKeyAuth: []
tags:
  - description: 管理前端性能监控（RUM）应用。
    name: RUM/应用管理
  - description: 对 RUM 事件数据执行分析查询。
    name: RUM/RUM 数据查询
  - description: 查询和管理 RUM 异常追踪 Issue 及预设严重性规则。
    name: RUM/RUM 问题跟踪
  - description: 查询 RUM 自定义字段及其值分布，用于构建分析过滤条件。
    name: RUM/RUM 自定义字段
  - description: 管理和查询用于 Browser、Android、iOS 错误符号化的 RUM Sourcemap 文件。
    name: RUM/RUM Sourcemap
  - description: 查询 RUM 会话的回放元数据与录制分段。
    name: RUM/RUM 会话回放
  - description: 配置和查看决定 RUM 应用采集哪些错误的规则，并可查看其编辑历史。
    name: RUM/错误采集规则
  - description: 管理按应用配置的预设严重性规则，用于为匹配的前端错误指定严重级别，并管理其评估顺序与变更历史。
    name: RUM/Issue 预设严重性规则
  - description: 查询账户的 RUM 资源记录及当前用量。
    name: RUM/资源
  - description: 创建和管理 RUM 自定义仪表盘及其版本历史与回收站。
    name: RUM/仪表盘
paths:
  /rum/dashboard/list:
    post:
      tags:
        - RUM/仪表盘
      summary: 查询仪表盘列表
      description: 查询本账户的仪表盘列表，默认按最近修改倒序。
      operationId: rum-dashboard-read-list
      requestBody:
        content:
          application/json:
            example:
              limit: 20
              p: 1
              query: performance
              sort:
                - direction: desc
                  field: updated_at
            schema:
              $ref: '#/components/schemas/RumDashboardListRequest'
        required: true
      responses:
        '200':
          content:
            application/json:
              example:
                data:
                  items:
                    - dashboard_id: 0192f3a4-5b6c-7d8e-9f01-234567890abc
                      description: 商城的加载耗时与错误率。
                      revision: 3
                      title: Web 性能概览
                      updated_at: 1792404240000
                      updated_by:
                        id: 2477033058177
                        name: Mei Lin
                  total: 7
                request_id: 01HK8XQE3Z7JM2NTFQ5YJ8P9R4
              schema:
                allOf:
                  - $ref: '#/components/schemas/SuccessEnvelope'
                  - properties:
                      data:
                        $ref: '#/components/schemas/RumDashboardListResponse'
                    type: object
          description: 成功
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '429':
          $ref: '#/components/responses/TooManyRequests'
        '500':
          $ref: '#/components/responses/ServerError'
components:
  schemas:
    RumDashboardListRequest:
      description: 列表请求。`p` 从 1 开始，`limit` 默认 20，默认按最新在前排序。
      properties:
        query:
          description: 搜索文本，最多 128 个字符。按空格拆分，每个词都须出现在标题或描述中。
          type: string
        sort:
          description: 排序方式，最多两个且不重复的字段；默认按 `updated_at` 倒序。
          items:
            $ref: '#/components/schemas/RumDashboardListSort'
          maxItems: 2
          type: array
        p:
          default: 1
          description: 页码，从 1 开始，默认 1。
          minimum: 1
          type: integer
        limit:
          default: 20
          description: 每页条数，1–100，默认 20。
          maximum: 100
          minimum: 1
          type: integer
      type: object
    SuccessEnvelope:
      description: >-
        成功响应结构。2xx 响应中 `request_id` 标识本次调用（同时出现在 `Flashcat-Request-Id`
        响应头中），`data` 为接口业务 payload。失败响应使用不同结构，参见 `ErrorResponse`。
      properties:
        data:
          description: 接口返回的数据，格式见各接口的 200 响应。没有返回数据的接口会返回 `{}` 或完全不带 `data`。
        request_id:
          description: 本次请求的唯一 ID，也会在 Flashcat-Request-Id 响应头中返回。反馈问题时请一并附上。
          example: 01HK8XQE3Z7JM2NTFQ5YJ8P9R4
          type: string
      required:
        - request_id
      type: object
    RumDashboardListResponse:
      description: 一页仪表盘。
      properties:
        items:
          description: 本页的仪表盘。
          items:
            $ref: '#/components/schemas/RumDashboardListItem'
          type: array
        total:
          description: 匹配查询的仪表盘总数。
          format: int64
          type: integer
      required:
        - items
        - total
      type: object
    RumDashboardListSort:
      description: 仪表盘列表的排序方式。
      properties:
        field:
          description: '`title` 或 `updated_at`。'
          enum:
            - title
            - updated_at
          type: string
        direction:
          description: '`asc` 或 `desc`。'
          enum:
            - asc
            - desc
          type: string
      required:
        - field
        - direction
      type: object
    RumDashboardListItem:
      description: 仪表盘列表的一行，不含定义。
      properties:
        dashboard_id:
          description: 仪表盘 ID，规范 UUIDv7。
          pattern: >-
            ^[0-9a-f]{8}-[0-9a-f]{4}-7[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$
          type: string
        title:
          description: 仪表盘标题。
          type: string
        description:
          description: 仪表盘描述。
          type: string
        revision:
          description: 当前版本号。
          minimum: 1
          type: integer
        updated_by:
          $ref: '#/components/schemas/RumDashboardActor'
        updated_at:
          description: 最近修改时间，Unix 毫秒时间戳。
          format: int64
          type: integer
      required:
        - dashboard_id
        - title
        - revision
        - updated_by
        - updated_at
      type: object
    ErrorResponse:
      description: 错误响应结构。`error` 必填，`data` 不存在。
      properties:
        error:
          $ref: '#/components/schemas/DutyError'
        request_id:
          description: 本次请求的唯一追踪 ID（trace ID），反馈问题时请提供该值以便检索日志。
          example: 01HK8XQE3Z7JM2NTFQ5YJ8P9R4
          type: string
      required:
        - request_id
        - error
      type: object
    RumDashboardActor:
      description: 创建或最近修改仪表盘/版本的成员。
      properties:
        id:
          description: 成员 ID。
          format: int64
          type: integer
        name:
          description: 成员名称。
          type: string
      required:
        - id
        - name
      type: object
    DutyError:
      description: 响应结构中的错误 payload，仅在非 2xx 响应时出现。
      properties:
        code:
          $ref: '#/components/schemas/ErrorCode'
        message:
          type: string
          description: >-
            按响应语言（query 参数 `locale` / `lang` 或请求头
            `Accept-Language`）返回的错误描述，可能包含出错的字段名，请不要解析它。
          example: The specified parameter template_id is not valid.
      required:
        - code
        - message
      type: object
    ErrorCode:
      description: >-
        错误码。所有失败响应都会把 `error.code` 设为下列稳定字符串之一，请以它而不是 HTTP 状态码做判断。


        | 错误码 | HTTP | 含义 |

        |---|---|---|

        | `OK` | 200 | 保留值，失败的请求不会返回。 |

        | `InvalidParameter` | 400 | 参数缺失、类型错误或未通过校验，`message` 通常会指出字段名。 |

        | `BadRequest` | 400 | 请求违反业务规则或与对象当前状态冲突，`message` 会说明原因。 |

        | `InvalidContentType` | 400 | 请求体没有以 `application/json` 发送。 |

        | `ResourceNotFound` | 400 | 引用的对象在本账户中不存在或已删除。注意 HTTP 状态码是 400 而不是 404。
        |

        | `NoLicense` | 400 | 账户套餐不包含该功能、套餐配额已用完、套餐已过期或额度不足。 |

        | `ReferenceExist` | 400 | 对象仍被其他对象引用，无法删除。 |

        | `Unauthorized` | 401 | APP Key 缺失、无效或已删除。 |

        | `BalanceNotEnough` | 402 | 仅用于控制台计费流程，Open API 接口不会返回。 |

        | `AccessDenied` | 403 | APP Key 的权限范围或创建者角色不允许该操作或该对象。 |

        | `RouteNotFound` | 404 | 没有与该 HTTP 方法和路径匹配的接口。 |

        | `MethodNotAllowed` | 405 | 路径存在，但不支持该 HTTP 方法。 |

        | `UndonedOrderExist` | 409 | 仅用于控制台计费流程，Open API 接口不会返回。 |

        | `EntityTooLarge` | 413 | 请求体超出大小限制。 |

        | `RequestLocked` | 423 | 仅用于控制台登录保护，Open API 接口不会返回。 |

        | `RequestVerifyRequired` | 428 | 仅用于控制台验证码流程，Open API 接口不会返回。 |

        | `DangerousOperation` | 428 | 仅用于控制台高风险操作的 MFA 校验，Open API 接口不会返回。 |

        | `RequestTooFrequently` | 429 | 触发频率限制；请等待响应头
        `Flashcat-Request-Rate-Limit-Delay` 给出的秒数后再重试。 |

        | `InternalError` | 500 | 服务端意外错误；请退避后重试，反馈问题时附上 `request_id`。 |

        | `ServiceUnavailable` | 503 | 后端依赖过载或不可用，请退避后重试。 |
      enum:
        - OK
        - InvalidParameter
        - BadRequest
        - InvalidContentType
        - ResourceNotFound
        - NoLicense
        - ReferenceExist
        - Unauthorized
        - BalanceNotEnough
        - AccessDenied
        - RouteNotFound
        - MethodNotAllowed
        - UndonedOrderExist
        - EntityTooLarge
        - RequestLocked
        - RequestVerifyRequired
        - DangerousOperation
        - RequestTooFrequently
        - InternalError
        - ServiceUnavailable
      example: InvalidParameter
      type: string
      x-enumDescriptions:
        OK: 保留值，失败的请求不会返回。
        InvalidParameter: 参数缺失、类型错误或未通过校验，`message` 通常会指出字段名。
        BadRequest: 请求违反业务规则或与对象当前状态冲突，`message` 会说明原因。
        InvalidContentType: 请求体没有以 `application/json` 发送。
        ResourceNotFound: 引用的对象在本账户中不存在或已删除。注意 HTTP 状态码是 400 而不是 404。
        NoLicense: 账户套餐不包含该功能、套餐配额已用完、套餐已过期或额度不足。
        ReferenceExist: 对象仍被其他对象引用，无法删除。
        Unauthorized: APP Key 缺失、无效或已删除。
        BalanceNotEnough: 仅用于控制台计费流程，Open API 接口不会返回。
        AccessDenied: APP Key 的权限范围或创建者角色不允许该操作或该对象。
        RouteNotFound: 没有与该 HTTP 方法和路径匹配的接口。
        MethodNotAllowed: 路径存在，但不支持该 HTTP 方法。
        UndonedOrderExist: 仅用于控制台计费流程，Open API 接口不会返回。
        EntityTooLarge: 请求体超出大小限制。
        RequestLocked: 仅用于控制台登录保护，Open API 接口不会返回。
        RequestVerifyRequired: 仅用于控制台验证码流程，Open API 接口不会返回。
        DangerousOperation: 仅用于控制台高风险操作的 MFA 校验，Open API 接口不会返回。
        RequestTooFrequently: 触发频率限制；请等待响应头 `Flashcat-Request-Rate-Limit-Delay` 给出的秒数后再重试。
        InternalError: 服务端意外错误；请退避后重试，反馈问题时附上 `request_id`。
        ServiceUnavailable: 后端依赖过载或不可用，请退避后重试。
  responses:
    BadRequest:
      content:
        application/json:
          examples:
            missingParameter:
              value:
                error:
                  code: InvalidParameter
                  message: The specified parameter is not valid.
                request_id: 01HK8XQE3Z7JM2NTFQ5YJ8P9R4
          schema:
            $ref: '#/components/schemas/ErrorResponse'
      description: 请求非法 — 通常是参数缺失或格式不正确。
    Unauthorized:
      content:
        application/json:
          examples:
            missingAppKey:
              value:
                error:
                  code: Unauthorized
                  message: You are unauthorized.
                request_id: 01HK8XQE3Z7JM2NTFQ5YJ8P9R4
          schema:
            $ref: '#/components/schemas/ErrorResponse'
      description: app_key 缺失或无效。
    Forbidden:
      content:
        application/json:
          examples:
            noEditPermission:
              value:
                error:
                  code: AccessDenied
                  message: Access Denied.
                request_id: 01HK8XQE3Z7JM2NTFQ5YJ8P9R4
          schema:
            $ref: '#/components/schemas/ErrorResponse'
      description: app_key 有效，但其权限范围或创建者角色不允许该操作或该对象。
    TooManyRequests:
      content:
        application/json:
          examples:
            rateLimited:
              value:
                error:
                  code: RequestTooFrequently
                  message: Request too frequently.
                request_id: 01HK8XQE3Z7JM2NTFQ5YJ8P9R4
          schema:
            $ref: '#/components/schemas/ErrorResponse'
      description: >-
        触发频率限制（账户级限制或该接口的平台级上限）。请等待响应头 `Flashcat-Request-Rate-Limit-Delay`
        给出的秒数后重试。
      headers:
        Flashcat-Request-Rate-Limit-Delay:
          description: 距当前限流窗口重置的秒数。请求被网关全局保护限流拒绝时不返回该响应头。
          schema:
            type: integer
            minimum: 0
    ServerError:
      content:
        application/json:
          examples:
            internal:
              value:
                error:
                  code: InternalError
                  message: >-
                    We encountered an internal error, and it has been reported.
                    Please try again later.
                request_id: 01HK8XQE3Z7JM2NTFQ5YJ8P9R4
          schema:
            $ref: '#/components/schemas/ErrorResponse'
      description: 服务端未预期错误。反馈问题时请携带 request_id。
  securitySchemes:
    AppKeyAuth:
      description: >-
        在 Flashduty 控制台 我的 → APP Key 中创建的 APP Key。可通过 query 参数 `app_key` 或请求头
        `Fd-App-Key` 传入。实际可访问范围是该 APP Key 的权限范围与创建者当前角色权限的交集，请妥善保管。
      in: query
      name: app_key
      type: apiKey

````

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