Skip to content
Site Qwality Site Qwality Site Qwality Docs

List incidents.

GET
/v1/incidents
 
curl --request GET \
  --url 'https://api.siteqwality.com/v1/incidents?status=active' \
  --header 'Authorization: Bearer <token>'

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Query Parameters

Section titled “Query Parameters ”
cursor
string

next_cursor from the previous page.

limit
integer format: int64

1 to 200, default 50.

status

Which incidents GET /incident/ returns.

Keyed on the responder lifecycle (responder_status), which is what the dashboard’s Active and Resolved tabs mean: an incident is active until a responder resolves it, whatever its public status-page status says.

string
Allowed values: active resolved all

active (triggered or acknowledged), resolved or all (the default).

Responses

Section titled “ Responses ”

200

Section titled “200 ”

The account’s incidents, newest first, with their updates. Read one for its monitors and participants

Media type application/json

{"data": [...], "next_cursor": ...}; the /v1 shaping keeps it as is.

object
data
required
Array<object>
object
id
required
string format: uuid
status_page_id

Deprecated: the first page it was created on. status_page_ids lists every page.

string | null format: uuid
status_page_ids
required

Every status page the incident is published on.

Array<string>
title
required
string
public_title

The title status pages show; null shows title.

string | null
severity
required
string
Allowed values: minor major critical
status
required
string
Allowed values: investigating identified monitoring resolved
responder_status
required
string
Allowed values: triggered acknowledged resolved
service_id
string | null format: uuid
created_at
required
string format: date-time
resolved_at
string | null format: date-time
acknowledged_at
string | null format: date-time
first_paged_at

First recorded successful page; absent when no page_sent event exists. Detail endpoints only.

string | null format: date-time
mitigated_at

First transition to public monitoring status. Detail endpoints only.

string | null format: date-time
unassigned_after_exhaustion

True while nobody acknowledged it and its escalation policy ran out, so nobody owns it. Detail endpoints only.

boolean
acknowledged_by
string | null format: uuid
resolved_by

Who resolved it; null for automatic and API-key resolves.

string | null format: uuid
auto_created
required

True when the incident was opened automatically by a monitor state change; false for incidents created manually.

boolean
updates
required
Array<object>
object
id
required
string format: uuid
status
required

The public status when it was posted.

string
Allowed values: investigating identified monitoring resolved
message
required
string
created_at
required
string format: date-time
visibility
required

public updates show on status pages; internal ones only here.

string
Allowed values: public internal
author_user_id

Who posted it; null for the system, API keys and older updates.

string | null format: uuid
affected_http_job_ids
required

Deprecated: the http entries of monitors, for one release.

Array<string>
merged_into_id

The incident this one was merged into; it is then resolved.

string | null format: uuid
resolution_reason

merged for a merged incident, else null.

string | null
monitors
required

Every monitor of the incident. Empty on list endpoints.

Array<object>
object
monitor_id
required
string format: uuid
monitor_type
required
string
Allowed values: http cron browser tls dns dns_record page_speed alert_rule
name

Null when the monitor was deleted.

string | null
impact
One of:

What status pages show for it; null derives it from the incident’s severity.

string
Allowed values: degraded partial_outage major_outage
source
required

auto when a failure joined it, manual when someone added it.

string
Allowed values: auto manual
joined_at
required
string format: date-time
recovered_at
string | null format: date-time
participants
required

Who works it, the lead first. Empty on list endpoints.

Array<object>
object
user_id
required
string format: uuid
role
required
string
Allowed values: lead responder comms
added_by

Who added them; the acknowledger for an automatic lead.

string | null format: uuid
added_at
required
string format: date-time
paged_at

When they were paged on being added; null when they were not.

string | null format: date-time
merged_from
required

The incidents merged into this one, each with its own updates. Empty on list endpoints.

Array<object>

An incident merged into this one; its updates stay on it.

object
id
required
string format: uuid
title
required
string
created_at
required
string format: date-time
updates
required
Array<object>
object
id
required
string format: uuid
status
required

The public status when it was posted.

string
Allowed values: investigating identified monitoring resolved
message
required
string
created_at
required
string format: date-time
visibility
required

public updates show on status pages; internal ones only here.

string
Allowed values: public internal
author_user_id

Who posted it; null for the system, API keys and older updates.

string | null format: uuid
next_cursor

Send back as cursor for the next page; null on the last one.

string | null
Example 
{
  "data": [
    {
      "severity": "minor",
      "status": "investigating",
      "responder_status": "triggered",
      "updates": [
        {
          "status": "investigating",
          "visibility": "public"
        }
      ],
      "monitors": [
        {
          "monitor_type": "http",
          "impact": "degraded",
          "source": "auto"
        }
      ],
      "participants": [
        {
          "role": "lead"
        }
      ],
      "merged_from": [
        {
          "updates": [
            {
              "status": "investigating",
              "visibility": "public"
            }
          ]
        }
      ]
    }
  ]
}

400

Section titled “400 ”

Invalid limit, cursor or status

Media type application/problem+json

An RFC 9457 problem, the body of every /v1 error.

object
type
required

https://docs.siteqwality.com/errors/ and the failure’s code, such as not_found.

string
title
required
string
status
required
integer format: int32
detail
string | null
instance

urn:uuid: and the request id.

string | null
errors

The invalid fields, when the request body was refused.

array | null

One validation failure; pointer is an RFC 6901 pointer into the request body.

object
pointer
required
string
detail
required
string
Example generated
{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example",
  "errors": [
    {
      "pointer": "example",
      "detail": "example"
    }
  ]
}

401

Section titled “401 ”

Missing or invalid credentials

Media type application/problem+json

An RFC 9457 problem, the body of every /v1 error.

object
type
required

https://docs.siteqwality.com/errors/ and the failure’s code, such as not_found.

string
title
required
string
status
required
integer format: int32
detail
string | null
instance

urn:uuid: and the request id.

string | null
errors

The invalid fields, when the request body was refused.

array | null

One validation failure; pointer is an RFC 6901 pointer into the request body.

object
pointer
required
string
detail
required
string
Example generated
{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example",
  "errors": [
    {
      "pointer": "example",
      "detail": "example"
    }
  ]
}

403

Section titled “403 ”

The key or member may not do this, or lacks the scope it needs

Media type application/problem+json

An RFC 9457 problem, the body of every /v1 error.

object
type
required

https://docs.siteqwality.com/errors/ and the failure’s code, such as not_found.

string
title
required
string
status
required
integer format: int32
detail
string | null
instance

urn:uuid: and the request id.

string | null
errors

The invalid fields, when the request body was refused.

array | null

One validation failure; pointer is an RFC 6901 pointer into the request body.

object
pointer
required
string
detail
required
string
Example generated
{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example",
  "errors": [
    {
      "pointer": "example",
      "detail": "example"
    }
  ]
}

429

Section titled “429 ”

Too many requests; wait for the time in Retry-After

Media type application/problem+json

An RFC 9457 problem, the body of every /v1 error.

object
type
required

https://docs.siteqwality.com/errors/ and the failure’s code, such as not_found.

string
title
required
string
status
required
integer format: int32
detail
string | null
instance

urn:uuid: and the request id.

string | null
errors

The invalid fields, when the request body was refused.

array | null

One validation failure; pointer is an RFC 6901 pointer into the request body.

object
pointer
required
string
detail
required
string
Example generated
{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example",
  "errors": [
    {
      "pointer": "example",
      "detail": "example"
    }
  ]
}

Privacy Cookie preferences