Skip to main content
POST
/
insight
/
channel
Get channel insight
curl --request POST \
  --url 'https://api.flashcat.cloud/insight/channel?app_key=' \
  --header 'Content-Type: application/json' \
  --data '
{
  "start_time": 1712000000,
  "end_time": 1712604800,
  "channel_ids": [
    4321322010131
  ],
  "aggregate_unit": "day"
}
'
{
  "request_id": "01HK8XQE3Z7JM2NTFQ5YJ8P9R4",
  "data": {
    "items": [
      {
        "ts": 1740844800,
        "channel_id": 4321322010131,
        "channel_name": "Production Alerts",
        "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
      }
    ]
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.flashcat.cloud/llms.txt

Use this file to discover all available pages before exploring further.

​
Restrictions

AspectValue
Rate limits1,000 requests/minute; 50 requests/second per account
PermissionsAnalytics Read (on-call)

Authorizations

​
app_key
string
query
required

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

application/json

Insight dimension-aggregation request. Extends InsightFilter with aggregation controls.

​
start_time
integer<int64>
required

Start time, Unix seconds. Must be greater than 0.

​
end_time
integer<int64>
required

End time, Unix seconds. Must be greater than start_time.

​
team_ids
integer<int64>[]

Filter by team IDs. At most 100 entries.

​
channel_ids
integer<int64>[]

Filter by channel IDs. At most 100 entries.

​
responder_ids
integer<int64>[]

Filter by responder person IDs. At most 100 entries.

​
severities
enum<string>[]

Filter by severity. At most 3 entries.

Available options:
Critical,
Warning,
Info,
Ok
​
incident_ids
string[]

Filter by incident IDs (MongoDB ObjectIDs). At most 100 entries.

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

Full-text query applied to incident title and description.

​
labels
object

Label filters (exact match).

​
fields
object

Custom-field filters (exact match).

​
orderby
enum<string>

Field to sort the underlying incident set by.

Available options:
created_at
​
asc
boolean

Sort ascending when true, descending otherwise.

​
is_my_team
boolean

Restrict results to teams the caller belongs to. When true and the caller has no teams, the result set is empty.

​
time_zone
string

IANA time zone name used to interpret the time range (e.g. Asia/Shanghai). Defaults to the account time zone.

​
seconds_to_close_from
integer<int64>

Lower bound (inclusive) on time-to-close, in seconds.

​
seconds_to_close_to
integer<int64>

Upper bound (exclusive) on time-to-close, in seconds. Must be greater than seconds_to_close_from when both are set.

​
seconds_to_ack_from
integer<int64>

Lower bound (inclusive) on time-to-acknowledge, in seconds.

​
seconds_to_ack_to
integer<int64>

Upper bound (exclusive) on time-to-acknowledge, in seconds. Must be greater than seconds_to_ack_from when both are set.

​
export_fields
string[]

Subset of CSV column keys to include in the export. At most 50 entries. Only used by the export endpoints.

​
description_html_to_text
boolean

Strip HTML markup from the description column when exporting.

​
split_hours
boolean

When true, metrics are split into work/sleep/off hour buckets.

​
aggregate_unit
enum<string>

Aggregate metrics into time buckets. When set, the time range must cover at least 24 hours; day additionally caps the range at 31 days.

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.

​
request_id
string
required

Unique ID for this request. Mirrored in the Flashcat-Request-Id response header. Include it when reporting issues.

Example:

"01HK8XQE3Z7JM2NTFQ5YJ8P9R4"

​
data
object
required

Endpoint-specific payload. See each operation's 200 response schema.