Explore documentation
  1. Welcome to Incidents 👋
  2. Frequently Asked Questions
  3. On-call scheduling and alerting
    1. Get started
    2. Slack and other integrations ↗
    3. Tag on-call in Slack
    4. Mobile apps ↗
    5. Connecting external calendars
    6. Advanced guide
  4. Incident management
    1. Get started
    2. AI SRE investigations
    3. Post mortems
    4. Metadata & Catalog
    5. Screening alerts
    6. Reporting ↗
  5. Monitoring
    1. Get started
    2. Working with monitors
    3. Customizing monitors
    4. Monitor types
  6. Status pages
    1. Get started
    2. Advanced guide
  7. Incidents API
    1. Getting an API token
    2. Pagination
    3. Monitors
    4. Heartbeats
    5. On-call & incidents
    6. Status pages
      1. Status pages API
      2. Status page groups
      3. Status page sections
      4. Status page resources
      5. Status page subscribers
      6. Status page reports
        1. List status page reports GET
        2. Get status page report GET
        3. Create status page report POST
        4. Update status page report PATCH
        5. Remove status page report DELETE
      7. Status page report updates
    7. Metadata
    8. Integrations
    9. Team members
    10. Organization roles
    11. Usage
    12. Reporting

List status page reports

Returns a list of existing reports on your status page.

GET https://incidents.betterstack.com/api/v2/status-pages/{status_page_id}/status-reports

URL parameters

status_page_id
required string

The ID of your status page

Query parameters

page
integer

The page number to return, starting with 1.

per_page
integer

Number of results per page. Defaults to 50, maximum 250.

Headers

Authorization
required string

Bearer $TOKEN

200

Returns a list of reports on your status page.

Response body

{
  "data": [
    {
      "id": "12345",
      "type": "status_report",
      "attributes": {
        "title": "Status report title",
        "report_type": "manual",
        "starts_at": "2021-12-08T15:05:24.000Z",
        "ends_at": null,
        "status_page_id": 123456,
        "affected_resources": [
          {
            "status_page_resource_id": "12345",
            "status": "downtime"
          }
        ],
        "aggregate_state": "downtime"
      },
      "relationships": {
        "status_updates": {
          "data": [
            {
              "id": "12345",
              "type": "status_update"
            }
          ]
        }
      }
    },
    {
      "id": "12346",
      "type": "status_report",
      "attributes": {
        "title": "Another status report title",
        "report_type": "maintenance",
        "starts_at": "2021-12-14T20:15:00.000Z",
        "ends_at": "2021-12-14T21:00:00.000Z",
        "status_page_id": 123456,
        "affected_resources": [
          {
            "status_page_resource_id": "12346",
            "status": "maintenance"
          }
        ],
        "aggregate_state": "maintenance"
      },
      "relationships": {
        "status_updates": {
          "data": [
            {
              "id": "12346",
              "type": "status_update"
            }
          ]
        }
      }
    }
  ],
  "pagination": {
    "first": "https://incidents.betterstack.com/api/v2/status-pages/123456/status-reports?page=1",
    "last": "https://incidents.betterstack.com/api/v2/status-pages/123456/status-reports?page=2",
    "prev": null,
    "next": "https://incidents.betterstack.com/api/v2/status-pages/123456/status-reports?page=2"
  }
}

Response attributes

id
string

The ID of the status page report.

type
string

Always status_report.

attributes.title
string

The title of the report.

attributes.report_type
string

The type of the report: manual, maintenance, or automatic for a report Better Stack opened on its own when a resource went down.

attributes.starts_at
string

When the report comes into effect, in ISO 8601 format. A manual report starts at its first status update's published_at.

attributes.ends_at
string or null

When a maintenance ends, in ISO 8601 format. null when the report has no end time.

attributes.status_page_id
integer

The ID of the status page the report belongs to.

attributes.affected_resources
array

The current status of each affected resource.

attributes.affected_resources[].status_page_resource_id
string

The ID of the affected status page resource.

attributes.affected_resources[].status
string

The resource's current status: downtime, degraded, resolved, or maintenance.

attributes.aggregate_state
string

The overall state of the report: downtime, degraded, resolved, or maintenance.

relationships.status_updates.data
array

The report's status updates, each an object with its id and the type status_update. List a report's status updates to read them.

pagination.first
string

The URL of the first page. Read more about pagination.

pagination.last
string

The URL of the last page.

pagination.prev
string or null

The URL of the previous page, or null on the first page.

pagination.next
string or null

The URL of the next page, or null on the last page.

Example cURL

Example
curl --request GET \
  --url https://incidents.betterstack.com/api/v2/status-pages/123456/status-reports \
  --header "Authorization: Bearer $TOKEN"


Previous article

Remove status page subscriber

Next article

Get status page report