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

Get status page report

Returns a single status page report.

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

URL parameters

status_page_id
required string

The ID of your status page

status_report_id
required string

The ID of the status report

Headers

Authorization
required string

Bearer $TOKEN

200

Returns the requested status page report, with its status updates.

Response body

{
  "data": {
    "id": "12345",
    "type": "status_report",
    "attributes": {
      "title": "Status report title",
      "report_type": "manual",
      "starts_at": "2021-12-17T11:00:00.000Z",
      "ends_at": "2021-12-17T12:00:00.000Z",
      "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"
          }
        ]
      }
    }
  },
  "included": [
    {
      "id": "12345",
      "type": "status_update",
      "attributes": {
        "message": "Status update message",
        "published_at": "2021-12-17T11:00:00.000Z",
        "published_at_timezone": "UTC",
        "notify_subscribers": false,
        "status_report_id": 12345,
        "affected_resources": [
          {
            "status_page_resource_id": "12345",
            "status": "downtime"
          }
        ]
      }
    }
  ]
}

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.

included
array

The report's status updates. Returned when you get, create, or update a single report.

included[].id
string

The ID of the status update.

included[].type
string

Always status_update.

included[].attributes.message
string

The message of the status update.

included[].attributes.published_at
string

When the status update was published, in ISO 8601 format.

included[].attributes.published_at_timezone
string or null

The time zone published_at was entered in on the dashboard. null for an update posted through the API.

included[].attributes.notify_subscribers
boolean

Whether subscribers of the status page get an e-mail about this update.

included[].attributes.status_report_id
integer

The ID of the status page report this update belongs to.

included[].attributes.affected_resources
array

The status each resource had in this update. Empty for a maintenance report's updates.

included[].attributes.affected_resources[].status_page_resource_id
string

The ID of the affected status page resource.

included[].attributes.affected_resources[].status
string

The status of the resource in this update: downtime, degraded, or resolved.

Example cURL

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


Previous article

List status page reports

Next article

Create status page report