Skip to main content
POST
查看协作空间洞察

限制说明

授权

app_key
string
query
必填

在 Flashduty 控制台 账户 → APP Key 中签发的 app_key。调用任何公开 API 时都必须携带。它等同于所属账户的身份凭证,请妥善保管。

请求体

application/json

洞察维度聚合请求。在 InsightFilter 基础上增加聚合控制字段。

start_time
integer<int64>
必填

起始时间,Unix 秒。必须大于 0。

end_time
integer<int64>
必填

结束时间,Unix 秒,必须大于 start_time

team_ids
integer<int64>[]

按团队 ID 过滤,至多 100 项。

Maximum array length: 100
channel_ids
integer<int64>[]

按协作空间 ID 过滤,至多 100 项。

Maximum array length: 100
responder_ids
integer<int64>[]

按处理人员 ID 过滤,至多 100 项。

Maximum array length: 100
severities
enum<string>[]

按严重程度过滤,至多 3 项。

Maximum array length: 3
可用选项:
Critical,
Warning,
Info,
Ok
incident_ids
string[]

按故障 ID(MongoDB ObjectID)过滤,至多 100 项。

Maximum array length: 100
Pattern: ^[0-9a-fA-F]{24}$
query
string

对故障标题做子串匹配(SQL LIKE %query%)。

labels
object

标签过滤(精确匹配)。

fields
object

自定义字段过滤(精确匹配)。

orderby
enum<string>

故障列表的排序字段,目前仅支持 created_at(故障创建时间)。仅 /insight/incident/list 使用。

可用选项:
created_at
asc
boolean

true 时升序,否则降序。仅 /insight/incident/list 使用。

is_my_team
boolean

是否仅返回调用者所属团队的数据。若调用者无任何团队,返回空集合。

time_zone
string

用于划分 日/周/月 聚合桶的 IANA 时区名(如 Asia/Shanghai)。可选,默认 UTC;仅 /insight/incident/export 例外:缺省时依次回退到账户时区、Asia/Shanghai

seconds_to_close_from
integer<int64>

解决时长下界(秒,包含)。

必填范围: x >= 0
seconds_to_close_to
integer<int64>

解决时长上界(秒,不包含)。两端同时设置时,必须大于 seconds_to_close_from

必填范围: x >= 0
seconds_to_ack_from
integer<int64>

认领时长下界(秒,包含)。

必填范围: x >= 0
seconds_to_ack_to
integer<int64>

认领时长上界(秒,不包含)。两端同时设置时,必须大于 seconds_to_ack_from

必填范围: x >= 0
export_fields
string[]

导出 CSV 的列 key 列表,按给定顺序输出;未知或重复的 key 会被拒绝。各导出接口支持的 key 集合不同,见对应接口的描述。仅导出接口使用;最多 50 个。

Maximum array length: 50
description_html_to_text
boolean

导出时是否将描述列中的 HTML 标签转换为纯文本。

include_ever_muted
boolean

是否包含曾被收敛的故障;默认不包含。

split_hours
boolean

true 时将指标拆分为 work/sleep/off 时段。

aggregate_unit
enum<string>

将指标按时间粒度聚合。设置后时间范围须不少于 24 小时;day 粒度时范围不得超过 31 天。day 按自然日、week 按自然周、month 按自然月切分聚合桶,边界按 time_zone 对齐。

可用选项:
day,
week,
month

响应

成功

成功响应结构。2xx 响应中 request_id 标识本次调用(同时出现在 Flashcat-Request-Id 响应头中),data 为接口业务 payload。失败响应使用不同结构,参见 ErrorResponse

request_id
string
必填

本次请求的唯一 ID,也会在 Flashcat-Request-Id 响应头中返回。反馈问题时请一并附上。

示例:

"01HK8XQE3Z7JM2NTFQ5YJ8P9R4"

data
object
必填

每个接口自己的业务 payload,详见各接口的 200 响应 schema。