Explore documentation
  1. Welcome to Uptime 👋
  2. Frequently Asked Questions
  3. Monitoring
    1. Get started with monitoring
    2. Working with monitors
    3. Customizing monitors
    4. Monitor types
  4. On-call scheduling and alerting
    1. Get started with on-call
    2. Sending alerts to Slack ↗
    3. Connecting external calendars
    4. Advanced on-call setup
  5. Incidents
    1. Working with incidents
    2. Create incidents manually
    3. Post mortems
  6. Status pages
    1. Get started with status pages
    2. Working with status pages
  7. Integrations
    1. Integrating with Better Stack
  8. Team and account management
    1. Team management
    2. Account settings
  9. API
    1. Get started with API
  10. Monitors API
    1. Monitors
    2. Monitor groups
    3. Heartbeats
    4. Heartbeat groups
  11. On-call & Incidents API
    1. On-call calendar
    2. Escalation policies
    3. Incidents
  12. Integrations API
    1. Email integrations
    2. Incoming webhooks
  13. Status pages API
    1. Status pages
    2. Status page sections
    3. Status page resources
    4. Status page reports
      1. List existing reports on a status page GET
      2. Get a single status page report GET
      3. Create a new status page report (with an associated status update) POST
      4. Update an existing status page report PATCH
      5. Delete an existing status page report DELETE
      6. Status page reports API response params
    5. Status page report updates
  14. Other API
    1. Metadata

Status page reports API response params

Response parameters

Parameter Type Values
data Object Object containing the information about the page report (see definition in table below)
included Array of Objects Array of objects containing included entities. (see definition in table below)

Namespace data

Parameter Type Values
id String ID of the page report
type String status_report
attributes Object Attributes object (see below)
attributes.title String The title of your new status page report.
attributes.report_type String The type of the report to be created. Expects either manual or maintenance. Default: manual
attributes.starts_at String (ISO DateTime format) The time when the report comes into effect (formatted in ISO-8601). Default: current time
attributes.ends_at String (ISO DateTime format) The time when the report ends (formatted in ISO-8601). Only required when report_type is set to maintenance.
attributes.status_page_id Integer The if of the status page of the report
attributes.affected_resources Array of Objects Array of affected resources (see below)
attributes.affected_resources[index].status_page_resource_id String ID of the affected status page resource
attributes.affected_resources[index].status String Status of the affected resource
attributes.aggregate_state String Overall state of the resources on the status page report. The possible values are: Operational Downtime Degraded
relationships Object Relationships object (see below)
relationships.status_updates Object status_update
relationships.status_updates.data Array of Objects Array of related status updates
relationships.status_updates.data[index].id String ID of the related status update
relationships.status_updates.data[index].type String Type of the related status update

Namespace included[index]

Parameter Type Values
id String The if of the included entity
type String Type of the included entity
attributes Object Attributes object (see below)
attributes.message String The first status update message for this report.
attributes.published_at String (ISO DateTime format) When was the status update published
attributes.status_report_id Integer ID of the related status report
attributes.affected_resources Array of Objects Array of affected resources
attributes.affected_resources[index].status_page_resource_id String ID of the affected status page resource
attributes.affected_resources[index].status String

Previous article

Delete an existing status page report

Next article

List all existing status updates for a status page report