Skip to main content
POST
List past incidents

Restrictions

Usage

  • Requires the Professional edition or higher; otherwise the call fails with NoLicense.
  • Candidates are closed incidents in the same channel that started within the 30 days before the reference incident started and whose semantic similarity exceeds the channel’s similarity threshold.
  • Results list incidents with longer root_cause plus resolution text first, then higher score, then more recent start_time.
  • limit defaults to 5 when omitted or 0.
  • An empty items array means no similar incident was found, or the reference incident has not been indexed for similarity search yet.
  • The reference incident must belong to a channel; otherwise the call fails with InvalidParameter.

Authorizations

app_key
string
query
required

APP Key created in the Flashduty console under My → APP Key. Send it as the app_key query parameter or in the Fd-App-Key request header. Its effective access is the intersection of the key's permission scope and the creator's current role permissions. Keep it secret.

Body

application/json

Parameters for the similar-past-incidents query.

incident_id
string
required

Reference incident ID (MongoDB ObjectID).

Pattern: ^[0-9a-fA-F]{24}$
limit
integer<int64> | null
default:5

Maximum number of similar incidents to return.

Required range: 0 <= x <= 100

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

List of similar historical incidents, ranked by relevance.