Status page issue reports

Download schema

Problems visitors reported from a status page, when the page has issue reports on. Reports above the page's threshold can show a notice on the page and fire an alert.

List issue reports

GET

https://api.spectate.net/v1

/status-pages/{statusPage}/issue-reports

Returns the problems visitors reported, newest first. The visitor's email address is only returned to tokens with status-pages:write. Whether the page is above its threshold is on the status page (issue_reports_triggered_at).

List issue reports › path Parameters

statusPage

string · uuid · required

Status page ID.

List issue reports › query Parameters

page

integer

Page number, from 1.

Default: 1

per_page

integer

Reports per page, 1 to 100.

Default: 25

List issue reports › Responses

Paginated set of StatusPageIssueReport

current_page

integer · min: 1 · required

StatusPageIssueReport[] · required

first_page_url

string | null · required

from

integer | null · min: 1 · required

last_page_url

string | null · required

last_page

integer · min: 1 · required

object[] · required

Generated paginator links.

next_page_url

string | null · required

path

string | null · required

Base path for paginator generated URLs.

per_page

integer · min: 0 · required

Number of items shown per page.

prev_page_url

string | null · required

to

integer | null · min: 1 · required

Number of the last item in the slice.

total

integer · min: 0 · required

Total number of items being paginated.

GET/status-pages/{statusPage}/issue-reports

curl https://api.spectate.net/v1/status-pages/:statusPage/issue-reports \
  --header 'Authorization: Bearer <token>'

Example Responses

{
  "current_page": 1,
  "data": [
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "message": "Checkout keeps timing out.",
      "email": "jane@example.com",
      "has_email": true,
      "components": [
        {
          "id": "00000000-0000-0000-0000-000000000000",
          "name": "API"
        }
      ],
      "created_at": "2024-08-25T15:00:00Z"
    }
  ],
  "first_page_url": "first_page_url",
  "from": 1,
  "last_page_url": "last_page_url",
  "last_page": 1,
  "links": [
    {
      "url": "url",
      "label": "label",
      "active": true
    }
  ],
  "next_page_url": "next_page_url",
  "path": "path",
  "per_page": 0,
  "prev_page_url": "prev_page_url",
  "to": 1,
  "total": 0
}

json

application/json

Delete an issue report

DELETE

https://api.spectate.net/v1

/status-pages/{statusPage}/issue-reports/{report}

For example to remove a visitor's email address.

Delete an issue report › path Parameters

statusPage

string · uuid · required

Status page ID.

report

string · uuid · required

Issue report ID.

Delete an issue report › Responses

No content

No data returned

Status page subscribers Team