Status page incidents

List status page incidents

Returns the page's incidents, newest first, with their updates, affected components and impact periods.

get/status-pages/{statusPage}/incidents

Request

  • Base URL
    https://api.spectate.net/v1
  • Auth
    HTTP bearer

Path parameters

statusPagestring uuid required

Status page ID.

Query parameters

pageinteger

Page number, from 1.

per_pageinteger

Incidents per page, 1 to 100.

filter[status]'investigating' | 'identified' | 'monitoring' | 'resolved'

Where an incident stands.

investigating <br/> Declared; the cause isn't known yet.
identified <br/> Acknowledged: the cause is known and someone works on it.
monitoring <br/> A fix is out; watching whether it holds.
resolved <br/> Over.

Only incidents with this status.

filter[title]string

Case-insensitive text in the title.

Response

Paginated set of StatusPageIncident

current_pageinteger required
first_page_urlstring nullable required
frominteger nullable required
last_page_urlstring nullable required
last_pageinteger required
next_page_urlstring nullable required
pathstring nullable required

Base path for paginator generated URLs.

per_pageinteger required

Number of items shown per page.

prev_page_urlstring nullable required
tointeger nullable required

Number of the last item in the slice.

totalinteger required

Total number of items being paginated.

Example response

{
  "data": [
    {
      "title": "Elevated API error rates",
      "updates": [
        {
          "body": "We found the cause and are rolling out a fix."
        }
      ],
      "affected_components": [
        {
          "component": {
            "name": "API"
          }
        }
      ],
      "impacts": [
        {
          "component": {
            "name": "API"
          }
        }
      ],
      "writeup": {
        "content": "On 26 October, card payments failed for 18 minutes after a configuration change."
      }
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.