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

Alert Top

POST
/insight/alert/topk-by-label

Request

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

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/alert/topk-by-label' \
--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",
    "orderby": "total_alert_cnt",
    "asc": true,
    "k": 1,
    "label": "check"
}'

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 {3}] 
required
Example
{
    "error": {
        "code": "string",
        "message": "string"
    },
    "data": [
        {
            "total_alert_cnt": 11,
            "total_alert_event_cnt": 11,
            "label": "Rule name"
        },
        {
            "total_alert_cnt": 1,
            "total_alert_event_cnt": 1,
            "label": "cpu.ide<28"
        }
    ]
}
Modified at 2025-01-22 10:27:42
Previous
Incident Export
Next
Cahnnel Metrics
Built with