数据查询

POST

https://api.flashcat.cloud/rum/data/query

最后修改时间：2025-07-14 07:41:41

请求示例

Shell

JavaScript

Java

Swift

curl --location --request POST 'https://api.flashcat.cloud/rum/data/query?app_key' \
--header 'Content-Type: application/json' \
--data-raw '{
    "start_time": 1742440860,
    "end_time": 1743088862,
    "queries": [
        {
            "id": "errorCountGraph",
            "sql": "select count(*) as `cnt` from `errors` where `issue_id` = \'\''M9qGLr7g9RAGbiHqPEDMCY\'\'' and `application_id` = \'\''eWbr4xk3ZRnLabRa6unqwD\'\'' limit 200",
            "format": "time_series",
            "interval": 86400,
            "max_points": 1226
        }
    ]
}'

响应示例

{
    "error": {
        "code": "InvalidParameter",
        "message": "string"
    },
    "data": {}
}

请求参数

Authorization

在 query 添加参数

app_key

示例：

app_key: ********************

Header 参数

Content-Type

string

可选

示例值:

application/json

Body 参数application/json

queries

array[object (SqlQueryInput) {7}]

并行请求列表

必需

string

必需

请求 ID 编号。eg：A，返回结果将通过此ID索引

sql

string

必需

标准SQL，但存在以下限制：

仅支持查询语句，且只能单表查询

不支持对表或字段进行qualifier

函数字段必须设置别名

当format=table时且limit未指定，limit默认值为1226

当同时指定了offset和limit，二者之和应该小于等于10000

目前查询表名仅支持sessions/views/actions/errors/long_tasks/resources/vitals/issues/sourcemaps

dql

string

可选

可选查询条件，用于简化筛选，这部分内容将append到sql的where条件中。举例如下：
sql: "select view_name from views order by event time"
dql: "login"
实际查询："select view_name from views where match_any(message, 'login') order by event time;"

format

enum<string>

返回数据类型

必需

枚举值:

time_seriestable

interval

integer

可选

当format=time_series时有效，建议的最小间隔毫秒，实际间隔（存在于响应中）可能不会与此值相同，具体计算逻辑：

计算总时间范围（et - st）

验证时间范围和最大点数是否有效（都必须 > 0）

计算最小需要的时间间隔：（et - st）/ max_points

将计算出的最小间隔与建议间隔进行比较，取较大值

将间隔调整为预定义的"合理"时间间隔之一：

毫秒级：1, 2, 5, 10, 20, 50, 100, 200, 500毫秒

秒级：1, 2, 5, 10, 15, 30, 60秒

分钟到小时：2, 5, 10, 15, 30分钟，1小时

小时级：2, 3, 6, 12小时

天到周：1, 2, 3, 7天

月级：30, 60, 90, 180天

如果需要的间隔超过预定义的最大值，则按30天（一个月）的倍数递增

max_points

integer

可选

当format=time_series时有效，此参数控制返回数据的粒度。较小的 max_points 值会导致较大的时间间隔，从而减少返回的数据点数量，适合长时间范围的概览。较大的 max_points 值会产生较小的时间间隔，提供更细粒度的数据视图。

>= 0<= 1266

search_after_ctx

string

可选

下一页查询游标。

仅当sql满足下述条件才会生成游标

sql必须指定limit参数

sql不可指定offset参数

sql必须指定排序字段

sql不可做聚合查询，即不包含COUNT/SUM/Group by等逻辑

否则您需要自行通过limit offset等参数实现传统分页查询。

注意：
为了确保分页查询的稳定，您必须确保排序字段的唯一性（一般通过加入决胜字段来实现），否则您的查询可能丢失数据

示例：分页查询session列表
sql：select * from sessions order by event_time desc, session_id asc;
如果仅使用event_time倒排，无法保证唯一性，但加入决胜字段session_id即可保证唯一性。

start_time

integer

必需

开始时间戳，单位毫秒

end_time

integer

必需

结束时间戳，单位毫秒

示例

返回响应

🟢200成功

application/json

Body

error

object (DutyError)

可选

错误信息，仅当错误时返回

code

enum<string>

错误码

必需

枚举值:

InvalidParameterInvalidContentTypeUnauthorizedAccessDeniedMethodNotAllowedRequestTooFrequentlyRequestVerifyRequiredDangerousOperationRequestLockedRouteNotFoundBalanceNotEnoughUndonedOrderExistResourceNotFoundInternalErrorReferenceExist

message

string

错误描述

必需

data

object

可选

数据响应，仅当正常时返回，每个请求id作为索引，对应内容为此请求的响应，一个请求失败不影响其他请求的执行。

^.*$

object (SqlQueryResult)

(pattern property)

请求 ID 编号

可选

修改于 2025-07-14 07:41:41

DQL 语法

分面列表