Get responder insight
curl --request POST \
--url 'https://api.flashcat.cloud/insight/responder?app_key=' \
--header 'Content-Type: application/json' \
--data '
{
"start_time": 1712000000,
"end_time": 1712604800,
"responder_ids": [
3790925372131
],
"aggregate_unit": "day"
}
'import requests
url = "https://api.flashcat.cloud/insight/responder?app_key="
payload = {
"start_time": 1712000000,
"end_time": 1712604800,
"responder_ids": [3790925372131],
"aggregate_unit": "day"
}
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,
responder_ids: [3790925372131],
aggregate_unit: 'day'
})
};
fetch('https://api.flashcat.cloud/insight/responder?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/responder?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,
'responder_ids' => [
3790925372131
],
'aggregate_unit' => 'day'
]),
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/responder?app_key="
payload := strings.NewReader("{\n \"start_time\": 1712000000,\n \"end_time\": 1712604800,\n \"responder_ids\": [\n 3790925372131\n ],\n \"aggregate_unit\": \"day\"\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/responder?app_key=")
.header("Content-Type", "application/json")
.body("{\n \"start_time\": 1712000000,\n \"end_time\": 1712604800,\n \"responder_ids\": [\n 3790925372131\n ],\n \"aggregate_unit\": \"day\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.flashcat.cloud/insight/responder?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 \"responder_ids\": [\n 3790925372131\n ],\n \"aggregate_unit\": \"day\"\n}"
response = http.request(request)
puts response.read_body{
"request_id": "01HK8XQE3Z7JM2NTFQ5YJ8P9R4",
"data": {
"items": [
{
"ts": 1740844800,
"responder_id": 3790925372131,
"responder_name": "alice",
"total_incident_cnt": 1,
"total_incidents_acknowledged": 1,
"total_incidents_reassigned": 0,
"total_incidents_escalated": 0,
"total_incidents_timeout_escalated": 0,
"total_incidents_manually_escalated": 0,
"total_interruptions": 1,
"total_notifications": 2,
"total_engaged_seconds": 10,
"total_seconds_to_ack": 2265624,
"mean_seconds_to_ack": 2265624,
"acknowledgement_pct": 100
}
]
}
}{
"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": "AccessDenied",
"message": "Access Denied."
}
}{
"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."
}
}Analytics
Get responder insight
Return per-responder incident handling metrics, one row per responder per time bucket.
POST
/
insight
/
responder
Get responder insight
curl --request POST \
--url 'https://api.flashcat.cloud/insight/responder?app_key=' \
--header 'Content-Type: application/json' \
--data '
{
"start_time": 1712000000,
"end_time": 1712604800,
"responder_ids": [
3790925372131
],
"aggregate_unit": "day"
}
'import requests
url = "https://api.flashcat.cloud/insight/responder?app_key="
payload = {
"start_time": 1712000000,
"end_time": 1712604800,
"responder_ids": [3790925372131],
"aggregate_unit": "day"
}
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,
responder_ids: [3790925372131],
aggregate_unit: 'day'
})
};
fetch('https://api.flashcat.cloud/insight/responder?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/responder?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,
'responder_ids' => [
3790925372131
],
'aggregate_unit' => 'day'
]),
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/responder?app_key="
payload := strings.NewReader("{\n \"start_time\": 1712000000,\n \"end_time\": 1712604800,\n \"responder_ids\": [\n 3790925372131\n ],\n \"aggregate_unit\": \"day\"\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/responder?app_key=")
.header("Content-Type", "application/json")
.body("{\n \"start_time\": 1712000000,\n \"end_time\": 1712604800,\n \"responder_ids\": [\n 3790925372131\n ],\n \"aggregate_unit\": \"day\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.flashcat.cloud/insight/responder?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 \"responder_ids\": [\n 3790925372131\n ],\n \"aggregate_unit\": \"day\"\n}"
response = http.request(request)
puts response.read_body{
"request_id": "01HK8XQE3Z7JM2NTFQ5YJ8P9R4",
"data": {
"items": [
{
"ts": 1740844800,
"responder_id": 3790925372131,
"responder_name": "alice",
"total_incident_cnt": 1,
"total_incidents_acknowledged": 1,
"total_incidents_reassigned": 0,
"total_incidents_escalated": 0,
"total_incidents_timeout_escalated": 0,
"total_incidents_manually_escalated": 0,
"total_interruptions": 1,
"total_notifications": 2,
"total_engaged_seconds": 10,
"total_seconds_to_ack": 2265624,
"mean_seconds_to_ack": 2265624,
"acknowledgement_pct": 100
}
]
}
}{
"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": "AccessDenied",
"message": "Access Denied."
}
}{
"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) |
Usage
- One row per responder per time bucket;
responder_idslimits which responders are returned.seconds_to_close_from/seconds_to_close_toandincident_idsare ignored. - Incidents are counted by creation time. Rows are sorted by
tsfrom newest to oldest, and a bucket (or dimension value) with no incidents produces no row — missing rows mean zero.split_hours: truereturns up to three rows per bucket, one perhoursvalue. - Members who are neither the account owner nor an admin only get data from channels they can access; other channels are silently excluded.
- With
is_my_team: true,team_idsis narrowed to the caller’s teams. If none of the sentteam_idsis one of the caller’s teams, or the caller belongs to no team, the result is empty. team_idsdoes not filter incidents here: every member of those teams is added toresponder_ids, so the rows cover the union of both.
Authorizations
Body
application/json
Insight dimension-aggregation request. Extends InsightFilter with aggregation controls.
Split the range into time buckets; omit for a single bucket covering the whole range. Requires a range of at least 24 hours, and day allows at most 31 days.
day: calendar days intime_zone(the first bucket runs fromstart_timeto the next midnight).week: consecutive 7-day buckets starting atstart_time(not aligned to Monday).month: calendar months intime_zone(the first bucket runs fromstart_timeto the 1st of the next month).
Available options:
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?