Skip to navigation

List incidents

Lists windows where an environment’s error rate rose well above its usual level, newest first, with how many are ongoing. Incidents count every request in the environment, not just the ones matching a filter.

Authentication

AuthorizationBearer

Use your Respan API key for Respan API authentication. Enter only the Respan API key value; clients send Authorization: Bearer <RESPAN_API_KEY>. For /api/responses, provider credentials such as Perplexity, OpenAI, or Azure OpenAI go in Settings -> Providers or respan_params.credential_override in the request body, not in this authentication field.

Query parameters

pageintegerOptional>=1Defaults to 1
Page number.
page_sizeintegerOptional1-200Defaults to 50
Incidents per page. Values above 200 are capped at 200.

Request

This endpoint expects an object.
start_timedatetimeOptional
Start of the range, ISO 8601. Defaults to 7 days ago. Incidents that overlap the range are returned.
end_timedatetimeOptional
End of the range, ISO 8601. Defaults to now.
stateenumOptional
Only incidents in this state.
Allowed values:
severityenumOptional
Only incidents of this severity.
Allowed values:
environmentstringOptional>=1 character
Only incidents in this environment.
fault_domainenumOptional
Only incidents for this fault domain.
Allowed values:

Response

A page of incidents.
resultslist of objects
Incidents, newest first.
countinteger
Incidents on this page.
nextstring or nullformat: "uri"

URL of the next page, or null.

previousstring or nullformat: "uri"

URL of the previous page, or null.

total_countinteger
Incidents matching the filters across all pages.
ongoing_countinteger
How many of those are ongoing.
current_filtersmap from strings to anyOptional
The filters that were applied.

Errors

400
Bad Request Error
403
Forbidden Error
429
Too Many Requests Error