Skip to main content
POST
Export responder insight

Restrictions

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.

Maximum array length: 100
channel_ids
integer<int64>[]

Filter by channel IDs. At most 100 entries.

Maximum array length: 100
responder_ids
integer<int64>[]

Filter by responder person IDs. At most 100 entries.

Maximum array length: 100
severities
enum<string>[]

Filter by severity. At most 3 entries.

Maximum array length: 3
Available options:
Critical,
Warning,
Info,
Ok
incident_ids
string[]

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

Maximum array length: 100
Pattern: ^[0-9a-fA-F]{24}$
query
string

Substring match on the incident title (SQL LIKE %query%).

labels
object

Label filters (exact match).

fields
object

Custom-field filters (exact match).

orderby
enum<string>

Sort field of the incident list; only created_at (incident creation time) is supported. Used by /insight/incident/list only.

Available options:
created_at
asc
boolean

Sort ascending when true, descending otherwise. Only used by /insight/incident/list.

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 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.

seconds_to_close_from
integer<int64>

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

Required range: x >= 0
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.

Required range: x >= 0
seconds_to_ack_from
integer<int64>

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

Required range: x >= 0
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.

Required range: x >= 0
export_fields
string[]

CSV 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.

Maximum array length: 50
description_html_to_text
boolean

Strip HTML markup from the description column when exporting.

include_ever_muted
boolean

Include incidents that have ever been muted. By default, they are excluded.

split_hours
boolean

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

aggregate_unit
enum<string>

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.

Available options:
day,
week,
month

Response

Success

CSV file stream (Content-Type: application/octet-stream, Content-Disposition: attachment; filename=responder_export_yyyyMMdd_HHmmss.csv). The first row holds localized column headers. Columns default to the full field set, or the keys given in export_fields.