SPspectate
Incidents

List incidents

Returns the team's incidents, most recently started first unless you sort.

get/incidents

Request

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

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[severity]'critical' | 'high' | 'medium' | 'low'

How urgent an alert or incident is. Escalation paths can branch on it.

critical <br/> Customers are affected right now.
high <br/> Serious, needs attention soon.
medium <br/> Should be looked at.
low <br/> Informational.

Only incidents of this severity.

filter[title]string

Case-insensitive text in the title.

sortstring

Sort by started_at, created_at, severity, status or title. Prefix - for descending. Default -started_at.

Response

Paginated set of Incident

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": [
    {
      "number": 42,
      "reference": "INC-42",
      "title": "Checkout fails for some customers",
      "roles": [
        {
          "member": {
            "name": "Jane Doe",
            "email": "jane@example.com"
          }
        }
      ]
    }
  ]
}

Changes

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