查询洞察故障列表

返回用于分析看板的故障分页列表，包含每条故障的处理效能指标。

POST /insight/incident/list

查询洞察故障列表

cURL

curl --request POST \
  --url 'https://api.flashcat.cloud/insight/incident/list?app_key=' \
  --header 'Content-Type: application/json' \
  --data '
{
  "start_time": 1712000000,
  "end_time": 1712604800,
  "p": 1,
  "limit": 20,
  "severities": [
    "Critical"
  ]
}
'

import requests

url = "https://api.flashcat.cloud/insight/incident/list?app_key="

payload = {
    "start_time": 1712000000,
    "end_time": 1712604800,
    "p": 1,
    "limit": 20,
    "severities": ["Critical"]
}
headers = {"Content-Type": "application/json"}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({
    start_time: 1712000000,
    end_time: 1712604800,
    p: 1,
    limit: 20,
    severities: ['Critical']
  })
};

fetch('https://api.flashcat.cloud/insight/incident/list?app_key=', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.flashcat.cloud/insight/incident/list?app_key=",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'start_time' => 1712000000,
    'end_time' => 1712604800,
    'p' => 1,
    'limit' => 20,
    'severities' => [
        'Critical'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.flashcat.cloud/insight/incident/list?app_key="

	payload := strings.NewReader("{\n  \"start_time\": 1712000000,\n  \"end_time\": 1712604800,\n  \"p\": 1,\n  \"limit\": 20,\n  \"severities\": [\n    \"Critical\"\n  ]\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.flashcat.cloud/insight/incident/list?app_key=")
  .header("Content-Type", "application/json")
  .body("{\n  \"start_time\": 1712000000,\n  \"end_time\": 1712604800,\n  \"p\": 1,\n  \"limit\": 20,\n  \"severities\": [\n    \"Critical\"\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.flashcat.cloud/insight/incident/list?app_key=")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n  \"start_time\": 1712000000,\n  \"end_time\": 1712604800,\n  \"p\": 1,\n  \"limit\": 20,\n  \"severities\": [\n    \"Critical\"\n  ]\n}"

response = http.request(request)
puts response.read_body

200

{
  "request_id": "01HK8XQE3Z7JM2NTFQ5YJ8P9R4",
  "data": {
    "total": 2,
    "has_next_page": false,
    "items": [
      {
        "incident_id": "67ca560c381a4fedb664f5f8",
        "title": "CPU spike on prod-web-01",
        "description": "CPU usage exceeded 90% threshold",
        "team_id": 4295771902131,
        "team_name": "SRE Team",
        "channel_id": 4321322010131,
        "channel_name": "Production Alerts",
        "progress": "Closed",
        "severity": "Info",
        "created_at": 1741313548,
        "closed_by": "manually",
        "seconds_to_ack": 1052085,
        "seconds_to_close": 1483880,
        "engaged_seconds": 1052085,
        "hours": "work",
        "responders": [
          {
            "person_id": 3790925372131,
            "assigned_at": 1741313548,
            "acknowledged_at": 1742365633,
            "person_name": "alice",
            "email": "[e-mail]"
          }
        ],
        "assigned_to": {
          "person_ids": [
            3790925372131
          ],
          "escalate_rule_id": "000000000000000000000000",
          "layer_idx": 0,
          "type": "reassign"
        },
        "labels": {},
        "fields": {},
        "notifications": 4,
        "interruptions": 2,
        "assignments": 2,
        "reassignments": 1,
        "acknowledgements": 1,
        "escalations": 0,
        "timeout_escalations": 0,
        "manual_escalations": 0,
        "creator_id": 3790925372131,
        "creator_name": "alice"
      }
    ]
  }
}

{
  "request_id": "01HK8XQE3Z7JM2NTFQ5YJ8P9R4",
  "error": {
    "code": "InvalidParameter",
    "message": "The specified parameter is not valid."
  }
}

{
  "request_id": "01HK8XQE3Z7JM2NTFQ5YJ8P9R4",
  "error": {
    "code": "Unauthorized",
    "message": "You are unauthorized."
  }
}

{
  "request_id": "01HK8XQE3Z7JM2NTFQ5YJ8P9R4",
  "error": {
    "code": "RequestTooFrequently",
    "message": "Request too frequently."
  }
}

{
  "request_id": "01HK8XQE3Z7JM2NTFQ5YJ8P9R4",
  "error": {
    "code": "InternalError",
    "message": "We encountered an internal error, and it has been reported. Please try again later."
  }
}

​

限制说明

项目	说明
速率限制	每个账户 1,000 次/分钟；50 次/秒
权限要求	分析看板查看（on-call）

授权

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 项。

channel_ids · integer<int64>[]

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

responder_ids · integer<int64>[]

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

severities · enum<string>[]

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

可用选项: Critical, Warning, Info, Ok

incident_ids · string[]

按故障 ID（MongoDB ObjectID）过滤，至多 100 项。

Pattern: ^[0-9a-fA-F]{24}$

query · string

作用于故障标题与描述的全文关键字。

labels · object

标签过滤（精确匹配）。

Show child attributes

fields · object

自定义字段过滤（精确匹配）。

orderby · enum<string>

底层故障集合的排序字段。

可用选项: created_at

asc · boolean

为 true 时升序，否则降序。

is_my_team · boolean

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

time_zone · string

IANA 时区名（如 Asia/Shanghai），用于解释时间范围。默认使用账户时区。

seconds_to_close_from · integer<int64>

解决时长下界（秒，包含）。

seconds_to_close_to · integer<int64>

解决时长上界（秒，不包含）。两端同时设置时，必须大于 seconds_to_close_from。

seconds_to_ack_from · integer<int64>

认领时长下界（秒，包含）。

seconds_to_ack_to · integer<int64>

认领时长上界（秒，不包含）。两端同时设置时，必须大于 seconds_to_ack_from。

export_fields · enum<string>[]

导出 CSV 时要包含的列键子集，至多 50 项。仅导出接口会读取。

可用选项: incident_id, title, severity, progress, channel_id, channel_name, team_id, team_name, created_at, seconds_to_ack, seconds_to_close, closed_by, engaged_seconds, hours, notifications, interruptions, acknowledgements, assignments, reassignments, escalations, manual_escalations, timeout_escalations, assigned_to, responders, description, labels, fields, creator_id, creator_name

description_html_to_text · boolean

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

p · integer · 默认值: 1

页码，从 1 开始，默认 1。

必填范围: x >= 1

limit · integer · 默认值: 20

每页条数，范围 1-100，默认 20。

必填范围: 1 <= x <= 100

search_after_ctx · string

上一页返回的游标 token，下一页请求时回传。

响应

200

application/json

成功

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

request_id · string · 必填

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

示例:

"01HK8XQE3Z7JM2NTFQ5YJ8P9R4"

data · object · 必填

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

Show child attributes