curl --request POST \
--url 'https://api.flashcat.cloud/insight/account?app_key=' \
--header 'Content-Type: application/json' \
--data '
{
"start_time": 1712000000,
"end_time": 1712604800,
"aggregate_unit": "day",
"severities": [
"Critical",
"Warning"
]
}
'import requests
url = "https://api.flashcat.cloud/insight/account?app_key="
payload = {
"start_time": 1712000000,
"end_time": 1712604800,
"aggregate_unit": "day",
"severities": ["Critical", "Warning"]
}
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,
aggregate_unit: 'day',
severities: ['Critical', 'Warning']
})
};
fetch('https://api.flashcat.cloud/insight/account?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/account?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,
'aggregate_unit' => 'day',
'severities' => [
'Critical',
'Warning'
]
]),
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/account?app_key="
payload := strings.NewReader("{\n \"start_time\": 1712000000,\n \"end_time\": 1712604800,\n \"aggregate_unit\": \"day\",\n \"severities\": [\n \"Critical\",\n \"Warning\"\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/account?app_key=")
.header("Content-Type", "application/json")
.body("{\n \"start_time\": 1712000000,\n \"end_time\": 1712604800,\n \"aggregate_unit\": \"day\",\n \"severities\": [\n \"Critical\",\n \"Warning\"\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.flashcat.cloud/insight/account?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 \"aggregate_unit\": \"day\",\n \"severities\": [\n \"Critical\",\n \"Warning\"\n ]\n}"
response = http.request(request)
puts response.read_body{
"request_id": "01HK8XQE3Z7JM2NTFQ5YJ8P9R4",
"data": {
"items": [
{
"ts": 1740844800,
"total_incident_cnt": 2,
"total_incidents_acknowledged": 2,
"total_incidents_closed": 2,
"total_incidents_auto_closed": 0,
"total_incidents_manually_closed": 2,
"total_incidents_timeout_closed": 0,
"total_incidents_escalated": 0,
"total_incidents_manually_escalated": 0,
"total_incidents_timeout_escalated": 0,
"total_incidents_reassigned": 2,
"total_interruptions": 3,
"total_notifications": 6,
"total_engaged_seconds": 3317709,
"total_seconds_to_ack": 3317709,
"total_seconds_to_close": 3749514,
"mean_seconds_to_ack": 1658854.5,
"mean_seconds_to_close": 1874757,
"noise_reduction_pct": 0,
"acknowledgement_pct": 100,
"total_alert_cnt": 0,
"total_alert_event_cnt": 0
}
]
}
}{
"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."
}
}Get account-level insight
Return aggregated incident insight metrics for the entire account.
curl --request POST \
--url 'https://api.flashcat.cloud/insight/account?app_key=' \
--header 'Content-Type: application/json' \
--data '
{
"start_time": 1712000000,
"end_time": 1712604800,
"aggregate_unit": "day",
"severities": [
"Critical",
"Warning"
]
}
'import requests
url = "https://api.flashcat.cloud/insight/account?app_key="
payload = {
"start_time": 1712000000,
"end_time": 1712604800,
"aggregate_unit": "day",
"severities": ["Critical", "Warning"]
}
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,
aggregate_unit: 'day',
severities: ['Critical', 'Warning']
})
};
fetch('https://api.flashcat.cloud/insight/account?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/account?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,
'aggregate_unit' => 'day',
'severities' => [
'Critical',
'Warning'
]
]),
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/account?app_key="
payload := strings.NewReader("{\n \"start_time\": 1712000000,\n \"end_time\": 1712604800,\n \"aggregate_unit\": \"day\",\n \"severities\": [\n \"Critical\",\n \"Warning\"\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/account?app_key=")
.header("Content-Type", "application/json")
.body("{\n \"start_time\": 1712000000,\n \"end_time\": 1712604800,\n \"aggregate_unit\": \"day\",\n \"severities\": [\n \"Critical\",\n \"Warning\"\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.flashcat.cloud/insight/account?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 \"aggregate_unit\": \"day\",\n \"severities\": [\n \"Critical\",\n \"Warning\"\n ]\n}"
response = http.request(request)
puts response.read_body{
"request_id": "01HK8XQE3Z7JM2NTFQ5YJ8P9R4",
"data": {
"items": [
{
"ts": 1740844800,
"total_incident_cnt": 2,
"total_incidents_acknowledged": 2,
"total_incidents_closed": 2,
"total_incidents_auto_closed": 0,
"total_incidents_manually_closed": 2,
"total_incidents_timeout_closed": 0,
"total_incidents_escalated": 0,
"total_incidents_manually_escalated": 0,
"total_incidents_timeout_escalated": 0,
"total_incidents_reassigned": 2,
"total_interruptions": 3,
"total_notifications": 6,
"total_engaged_seconds": 3317709,
"total_seconds_to_ack": 3317709,
"total_seconds_to_close": 3749514,
"mean_seconds_to_ack": 1658854.5,
"mean_seconds_to_close": 1874757,
"noise_reduction_pct": 0,
"acknowledgement_pct": 100,
"total_alert_cnt": 0,
"total_alert_event_cnt": 0
}
]
}
}{
"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."
}
}Restrictions
| Aspect | Value |
|---|---|
| Rate limits | 1,000 requests/minute; 50 requests/second per account |
| Permissions | Analytics Read (on-call) |
Authorizations
App key issued from the Flashduty console under Account → APP Keys. Required on every public API call. Keep it secret — it grants the same access as the owning account.
Body
Insight dimension-aggregation request. Extends InsightFilter with aggregation controls.
Start time, Unix seconds. Must be greater than 0.
End time, Unix seconds. Must be greater than start_time.
Filter by team IDs. At most 100 entries.
100Filter by channel IDs. At most 100 entries.
100Filter by responder person IDs. At most 100 entries.
100Filter by severity. At most 3 entries.
3Critical, Warning, Info, Ok Filter by incident IDs (MongoDB ObjectIDs). At most 100 entries.
100^[0-9a-fA-F]{24}$Substring match on the incident title (SQL LIKE %query%).
Label filters (exact match).
Show child attributes
Show child attributes
Custom-field filters (exact match).
Sort field of the incident list; only created_at (incident creation time) is supported. Used by /insight/incident/list only.
created_at Sort ascending when true, descending otherwise. Only used by /insight/incident/list.
Restrict results to teams the caller belongs to. When true and the caller has no teams, the result set is empty.
IANA time zone name used to cut day/week/month buckets (e.g. Asia/Shanghai). Optional; defaults to UTC, except that /insight/incident/export falls back to the account time zone and then Asia/Shanghai.
Lower bound (inclusive) on time-to-close, in seconds.
x >= 0Upper bound (exclusive) on time-to-close, in seconds. Must be greater than seconds_to_close_from when both are set.
x >= 0Lower bound (inclusive) on time-to-acknowledge, in seconds.
x >= 0Upper bound (exclusive) on time-to-acknowledge, in seconds. Must be greater than seconds_to_ack_from when both are set.
x >= 0CSV column keys to include in the export, in the given order; unknown or duplicate keys are rejected. The valid key set differs per export endpoint — see each export operation's description. Only used by the export endpoints; at most 50 entries.
50Strip HTML markup from the description column when exporting.
Include incidents that have ever been muted. By default, they are excluded.
When true, metrics are split into work/sleep/off hour buckets.
Aggregates metrics by time granularity. When set, the time range must be at least 24 hours; with day granularity the range must not exceed 31 days. day buckets by calendar day, week by calendar week, and month by calendar month, with boundaries aligned to time_zone.
day, week, month Response
Success
Success response envelope. On every 2xx response, request_id identifies the call (also mirrored in the Flashcat-Request-Id header) and data holds the endpoint-specific payload. Failure responses use a different shape — see ErrorResponse.
Was this page helpful?