Flashcat API (English)
API referenceDocs中文
API referenceDocs中文
  1. Insights
  • Open API
    • Quick Start
    • About Pagination
    • Member Management
      • Invite members
      • Delete member
      • Reset information
      • Member list
    • Team Management
      • Team list
      • Basic information
      • Delete team
      • Team upsert
    • Schedule Management
      • Preview schedule
      • Update schedule
      • Enable schedule
      • Disable schedule
      • Create schedule
      • Delete schedule
      • View schedule details
      • Get schedule information by ID list
      • View schedule list
      • Personal schedule calendar
      • Role information
    • Information Retrieval
      • Channel
      • Member
      • Team
    • Preference Settings
      • View preference settings
      • Modify preference settings
    • Channel
      • Escalation Rules
        • Enable rule
        • Disable rule
        • Delete rule
        • Rule list
        • Rule details
        • Create rule
        • Update rule
      • Subscription Rules
        • Enable rule
        • Disable rule
        • Delete rule
        • Rule list
        • Create rule
        • Update rule
      • Drop Rules
        • Enable rule
        • Disable rule
        • Delete rule
        • Rule list
        • Create rule
        • Update rule
      • Silence Rules
        • Enable rule
        • Disable rule
        • Delete rule
        • Rule list
        • Rule details
        • Inner conditions
      • Inhibit Rules
        • Disable rule
        • Delete rule
        • Rule list
        • See creation interface for filters explanation
        • Channel ID
        • Rule name
      • Match conditions
      • Delete rule
      • See creation interface for filters explanation
      • Enable rule
      • Update rule
      • Rule ID
      • Rule name
      • Sort
      • Delete rule
      • See creation interface for filters explanation
      • Name by integration
      • Robot list
    • Template Management
      • Name
      • Enable rule
      • Delete rule
      • See creation interface for filters explanation
      • Channel ID
      • Rule name
      • Required when updating
      • Update rule
    • Incident Management
      • Group View
        • Channel
        • Rule name
        • Inner conditions
        • Channel
      • Match conditions
      • Enable rule
      • Disable rule
      • Delete rule
      • Rule list
      • See creation interface for filters explanation
      • Create rule
      • Rule description
      • Update rule
      • Channel
      • Match conditions
      • Match conditions
      • Update rule
      • Channel
      • Rule ID
      • Inner conditions
      • Enable rule
      • Rule list
      • Rule details
      • Rule name
      • Rule description
      • Match conditions
      • Rule description
      • See creation interface for filters explanation
      • Disable rule
      • Rule description
    • Alert Management
      • Group View
        • Required when updating
        • Rule name
        • Inner conditions
        • Disable rule
      • Alert Info
      • Close Alert
      • Alert List By Card
      • Alert List
      • Alert List By ID
      • Event List
      • Feed
      • Merge Incident
    • Change Management
      • Inner conditions
    • Insights (old)
      • Channel
      • Match conditions
      • Rule ID
      • Enable rule
      • Name
      • Disable rule
      • Rule name
      • Name
      • See creation interface for filters explanation
    • Custom Fields
      • Enable rule
      • Disable rule
      • See creation interface for filters explanation
      • Channel ID
      • Channel
    • Service Calendar
      • Match conditions
      • Delete rule
      • Update rule
      • Required when updating
      • Rule details
      • Required when updating
      • Inner conditions
      • Channel
    • Label Enhancement
      • Mapping
        • Rule name
        • Rule list
        • Rule description
        • Match conditions
        • Rule ID
        • Rule description
        • Inner conditions
        • Enable rule
        • Disable rule
        • Rule description
      • Enable rule
      • Delete rule
    • Alert Processing
      • Create rule
      • Rule name
    • Integration Routing
      • Required when updating
      • Rule description
      • Match conditions
    • License Management
      • Create rule
    • Insights
      • Team Metrics
        POST
      • Responder Metrics Export
        POST
      • Incident List
        POST
      • Responder Metrics
        POST
      • Account Metrics
        POST
      • Channel Metrics Export
        POST
      • Team Metrics Export
        POST
      • Incident Export
        POST
      • Alert Top
        POST
      • Cahnnel Metrics
        POST
  • Event API
    • Quick Start
    • Alert Event
    • Change Event
  • Webhook
    • Quick Start
    • Custom Actions
    • Alert Webhook
    • Incident Webhook
  1. Insights

Incident List

POST
/insight/incident/list

Request

Body Params application/json
start_time
integer 
Update rule
required
Channel
end_time
integer 
Rule ID
required
Required when updating
team_ids
array[integer]
Rule name
optional
Rule description
channel_ids
array[integer]
Inner conditions
optional
Match conditions
severities
array[string]
Name
optional
Enable rule
Allowed values:
InfoWarningCritical
time_zone
string 
Disable rule
optional
Delete rule
Default:
Asia/Shanghai
asc
boolean 
Rule list
optional
orderby
enum<string> 
See creation interface for filters explanation
optional
Create rule
Allowed value:
created_at
search_after_ctx
string 
Channel
optional
Rule name
p
integer 
Rule description
optional
Inner conditions
Default:
1
limit
integer 
Match conditions
optional
Name
>= 0<= 100
Default:
20
Example
{
    "start_time": 0,
    "end_time": 0,
    "team_ids": [
        0
    ],
    "channel_ids": [
        0
    ],
    "severities": [
        "Info"
    ],
    "time_zone": "Asia/Shanghai",
    "asc": true,
    "orderby": "created_at",
    "search_after_ctx": "string",
    "p": 1,
    "limit": 20
}

Request samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST 'http://prod-cn.your-api-server.com/insight/incident/list' \
--header 'Content-Type: application/json' \
--data-raw '{
    "start_time": 0,
    "end_time": 0,
    "team_ids": [
        0
    ],
    "channel_ids": [
        0
    ],
    "severities": [
        "Info"
    ],
    "time_zone": "Asia/Shanghai",
    "asc": true,
    "orderby": "created_at",
    "search_after_ctx": "string",
    "p": 1,
    "limit": 20
}'

Responses

🟢200成功
application/json
Body
error
object (DutyError) 
optional
code
enum<string> 
Rule description
required
Allowed values:
InvalidParameterInvalidContentTypeUnauthorizedAccessDeniedMethodNotAllowedRequestTooFrequentlyRequestVerifyRequiredDangerousOperationRequestLockedRouteNotFoundBalanceNotEnoughUndonedOrderExistResourceNotFoundInternalErrorReferenceExist
message
string 
Inner conditions
required
data
object 
optional
items
array [object {24}] 
Channel
required
search_after_ctx
string 
optional
Rule ID
total
integer 
optional
Required when updating
has_next_page
boolean 
optional
Rule name
Example
{
    "error": {
        "code": "InvalidParameter",
        "message": "string"
    },
    "data": {
        "items": [
            {
                "incident_id": "string",
                "title": "string",
                "team_id": 0,
                "team_name": "string",
                "channel_id": 0,
                "channel_name": "string",
                "progress": "Triggered",
                "severity": "Info",
                "created_at": 0,
                "closed_by": "timeout",
                "seconds_to_ack": 0,
                "seconds_to_close": 0,
                "engaged_seconds": 0,
                "hours": "work",
                "notifications": 0,
                "interruptions": 0,
                "assignments": 0,
                "reassignments": 0,
                "acknowledgements": 0,
                "escalations": 0,
                "manual_escalations": 0,
                "timeout_escalations": 0,
                "responders": [
                    {}
                ],
                "assigned_to": {
                    "person_ids": [
                        0
                    ],
                    "escalate_rule_id": "string",
                    "escalate_rule_name": "string",
                    "layer_idx": 0,
                    "layer_person_reset": {
                        "0": {
                            "team_ids": [
                                0
                            ],
                            "person_ids": [
                                0
                            ],
                            "schedule_to_role_ids": {
                                "{schedule_id}": [
                                    0
                                ]
                            }
                        }
                    },
                    "type": "assign"
                }
            }
        ],
        "search_after_ctx": "string",
        "total": 0,
        "has_next_page": true
    }
}
Modified at 2025-01-22 10:25:48
Previous
Responder Metrics Export
Next
Responder Metrics
Built with