> ## 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.

# 预览行为事件规则

> 评估未保存的规则：命中量、访客数、命中的点击分组以及与其他事件的重叠。

## 限制说明

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

## 使用说明

* `start_time` 与 `end_time` 为 Unix 毫秒时间戳。两者都省略时取最近 7 天；超过 14 天会返回 `InvalidParameter`。
* 调用方需对 `application_id` 有读权限；无权访问的私有应用数据不参与统计。
* 调用不会落库：规则只编译成 SQL 为本次请求求值一次。
* `except_event_id` 会在 `overlaps` 中排除该事件，通常传正在编辑的事件。


## OpenAPI

````yaml /api-reference/rum.openapi.zh.json post /rum/behavior-event/preview
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/仪表盘
  - description: 定义和查看把原始 RUM 动作聚合为「行为事件」的规则。
    name: RUM 行为事件
  - description: 基于 RUM 会话与访客分析转化漏斗：结果、趋势、维度拆分、流失原因与页面流向。
    name: RUM 漏斗分析
  - description: 读取页面热力图：元素排行、点击坐标、滚动深度，以及用作背景的回放帧。
    name: RUM 热力图
paths:
  /rum/behavior-event/preview:
    post:
      tags:
        - RUM 行为事件
      summary: 预览行为事件规则
      description: 评估未保存的规则：命中量、访客数、命中的点击分组以及与其他事件的重叠。
      operationId: rum-behavior-event-read-preview
      requestBody:
        content:
          application/json:
            example:
              application_id: app_3fK9mQ2xLp7VbN4cR8dW1y
              end_time: 1780358400000
              except_event_id: vR4dMx8bW2pNq6eRc9T3vK
              rules:
                - element:
                    by: selector
                    op: eq
                    value: '#pay-now'
                  page:
                    op: prefix
                    value: /checkout
                  type: click
                - name: checkout_completed
                  type: custom
              start_time: 1780272000000
            schema:
              $ref: '#/components/schemas/RumBehaviorEventPreviewRequest'
        required: true
      responses:
        '200':
          content:
            application/json:
              example:
                data:
                  daily:
                    - count: 431
                      date: '2026-06-01'
                    - count: 468
                      date: '2026-06-02'
                  hits: 2410
                  matches:
                    - action_type: click
                      count: 1842
                      name: Pay now
                      page: /checkout
                      selector: '#pay-now'
                      selector_count: 3
                  overlaps:
                    - event_id: vR4dMx8bW2pNq6eRc9T3vK
                      name: Payment attempted
                      shared: 1650
                  page_clicks: 6841
                  rage_clicks: 37
                  visitors: 1982
                request_id: 01HK8XQE3Z7JM2NTFQ5YJ8P9R4
              schema:
                allOf:
                  - $ref: '#/components/schemas/SuccessEnvelope'
                  - properties:
                      data:
                        $ref: '#/components/schemas/RumBehaviorEventPreview'
                    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:
    RumBehaviorEventPreviewRequest:
      description: 用未保存的规则评估已存储的动作数据。
      properties:
        application_id:
          description: RUM 应用 ID。调用方需对该应用有读权限，写操作需要管理权限。
          type: string
        end_time:
          description: 时间窗终点，Unix 毫秒时间戳。省略时取当前时间。
          example: 1780358400000
          format: int64
          type: integer
        except_event_id:
          description: 在重叠列表中排除的事件 ID，通常是被编辑的那个事件。
          type: string
        rules:
          description: 事件规则，多个规则之间为「或」关系：任一规则命中即视为属于该事件。允许 1-20 条。
          items:
            $ref: '#/components/schemas/RumBehaviorRule'
          maxItems: 20
          minItems: 1
          type: array
        start_time:
          description: 时间窗起点，Unix 毫秒时间戳。两个边界都省略时取最近 7 天；超过 14 天的范围会被拒绝。
          example: 1780272000000
          format: int64
          type: integer
      required:
        - application_id
        - rules
      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
    RumBehaviorEventPreview:
      description: 未保存的规则将会命中什么，不会落库。
      properties:
        daily:
          description: 时间窗内按天的命中数。
          items:
            $ref: '#/components/schemas/RumBehaviorDayCount'
          type: array
        hits:
          description: 时间窗内命中的动作数量。
          format: int64
          type: integer
        matches:
          description: 命中的点击分组（按命中量）。
          items:
            $ref: '#/components/schemas/RumBehaviorMatchedClick'
          type: array
        overlaps:
          description: 与这些规则存在重叠的已启用事件。
          items:
            $ref: '#/components/schemas/RumBehaviorOverlap'
          type: array
        page_clicks:
          description: 规则所命中页面上的全部点击次数（不论是否命中规则）。
          format: int64
          type: integer
        rage_clicks:
          description: 命中动作中带「暴怒点击」标记的数量。
          format: int64
          type: integer
        visitors:
          description: 命中动作对应的去重访客数。
          format: int64
          type: integer
      required:
        - hits
        - visitors
        - rage_clicks
        - page_clicks
        - daily
        - matches
        - overlaps
      type: object
    RumBehaviorRule:
      description: 把原始动作归入行为事件的一条条件。
      properties:
        element:
          $ref: '#/components/schemas/RumBehaviorElementMatch'
          description: 被点击的元素。`click` 规则必填。
        name:
          description: '`custom` 规则的动作名，需完全一致。'
          maxLength: 512
          type: string
        page:
          $ref: '#/components/schemas/RumBehaviorMatch'
          description: 点击发生的页面，按页面路径组匹配。`click` 规则必填。
        type:
          description: >-
            规则类型：`click` 匹配自动采集的点击或点按，需同时给出 `page` 与 `element`；`custom` 匹配代码里通过
            `addAction` 上报的动作名，需给出 `name`。
          enum:
            - click
            - custom
          type: string
      required:
        - type
      type: object
    RumBehaviorDayCount:
      description: 按天统计的命中数中的一天。
      properties:
        count:
          description: 当天的计数。
          format: int64
          type: integer
        date:
          description: 日期，格式 `YYYY-MM-DD`，按账户显示时区。
          type: string
      required:
        - date
        - count
      type: object
    RumBehaviorMatchedClick:
      description: 被预览规则命中的一组原始点击。
      properties:
        action_type:
          description: 命中的动作种类：`click` 为 Web 点击，`tap` 为移动端点按。
          enum:
            - click
            - tap
          type: string
        count:
          description: 时间窗内该组的点击次数。
          format: int64
          type: integer
        name:
          description: 该组上报的元素名；SDK 未提供名称时为空。
          type: string
        page:
          description: 这些点击的页面路径组。
          type: string
        selector:
          description: 组内出现最多的选择器。
          type: string
        selector_count:
          description: 合并到该组的不同选择器数量。
          format: int64
          type: integer
      required:
        - page
        - action_type
        - name
        - selector_count
        - selector
        - count
      type: object
    RumBehaviorOverlap:
      description: 命中部分相同动作的另一个行为事件。
      properties:
        event_id:
          description: 行为事件 ID（创建时分配的 short UUID）。
          type: string
        name:
          description: 另一个事件的名称。
          type: string
        shared:
          description: 两个事件都命中的动作数量。
          format: int64
          type: integer
      required:
        - event_id
        - name
        - shared
      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
    RumBehaviorElementMatch:
      description: 针对被点击元素的一次比较。
      properties:
        by:
          description: 比较的元素属性：`name` 为 SDK 上报的元素名，`selector` 为 CSS 选择器。
          enum:
            - name
            - selector
          type: string
        op:
          description: >-
            `value` 与元素属性的比较方式：`eq` 完全相等、`contains` 包含子串、`prefix` 前缀匹配、`regex`
            正则匹配。
          enum:
            - eq
            - contains
            - prefix
            - regex
          type: string
        value:
          description: 要匹配的元素名或选择器，长度限制与页面匹配值一致。
          maxLength: 512
          type: string
      required:
        - by
        - op
        - value
      type: object
    RumBehaviorMatch:
      description: 针对页面路径组的一次比较。
      properties:
        op:
          description: >-
            `value` 与页面路径组的比较方式：`eq` 完全相等、`contains` 包含子串、`prefix`
            前缀匹配、`wildcard` 锚定的 `*` 通配、`regex` 正则匹配。
          enum:
            - eq
            - contains
            - prefix
            - wildcard
            - regex
          type: string
        value:
          description: 比较值。最多 512 字节且不能含控制字符；`regex` 取值限制 200 字节且必须能编译。
          maxLength: 512
          type: string
      required:
        - op
        - value
      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.