SPspectate
Alerts

List alerts

Returns the team's alerts, most recently fired first unless you sort.

get/alerts

Request

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

Query parameters

pageinteger

Page number, from 1.

per_pageinteger

Alerts per page, 1 to 100.

filter[status]'firing' | 'resolved'

Whether an alert's problem is ongoing.

firing <br/> The problem is ongoing; it escalates until acknowledged.
resolved <br/> The problem is over.

Only firing or resolved alerts.

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 alerts of this severity.

filter[source_type]'uptime' | 'certificate' | 'performance' | 'dns' | 'host_metric' | 'domain' | 'external' | 'status_page' | 'manual'

What raised an alert.

uptime <br/> A monitor went down.
certificate <br/> A monitor's certificate is invalid or expires soon.
performance <br/> A monitor got slow.
dns <br/> The answer of a DNS monitor changed (when it alerts on changes), or a nameserver has a problem that leaves its monitor up.
host_metric <br/> A host's metric condition held, or it stopped sending data.
domain <br/> A domain expires soon, expired or its registration changed.
external <br/> An alert source (external tool) fired it.
status_page <br/> Visitor issue reports over the threshold or a traffic spike (metadata.type: issue_reports, traffic_spike).
manual <br/> Someone paged by hand, with nothing else to attach it to.

Only alerts raised by this kind of check or integration.

filter[resource_id]string uuid

Only alerts about this resource (a monitor, host, domain, status page or alert source ID).

filter[acknowledged]boolean

Only acknowledged (true) or unacknowledged (false) alerts.

sortstring

Sort by fired_at, resolved_at, severity or status. Prefix - for descending. Default -fired_at.

Response

Paginated set of Alert

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": "Website is down",
      "resource": {
        "name": "Website"
      },
      "acknowledged_by": "Jane Doe",
      "resolved_by": "Jane Doe",
      "links": [
        {
          "label": "View issue in Sentry"
        }
      ]
    }
  ]
}

Changes

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