Explore documentation
  1. Welcome to Uptime 👋
  2. Frequently Asked Questions
  3. Monitoring
    1. Get started
    2. Working with monitors
    3. Customizing monitors
    4. Monitor types
  4. On-call scheduling and alerting
    1. Get started
    2. Sending alerts to Slack ↗
    3. Connecting external calendars
    4. Advanced guide
  5. Incidents
    1. Get started
    2. Advanced guide
  6. Status pages
    1. Get started
    2. Advanced guide
  7. Integrations
    1. Integrating with Better Stack
  8. Team and account management
    1. Team management
    2. Account settings
    3. Audit logs
    4. Migrating to pay as you go
  9. Uptime API
    1. Get an API token
    2. Monitors
    3. Heartbeats
    4. On-call & incidents
    5. Status pages
      1. Status pages API
      2. Status page sections
      3. Status page resources
      4. 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
        6. Response attributes
      5. Status page report updates
    6. Metadata
    7. Integrations

Response attributes

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, automatic 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 AffectedResource[] Array of affected resources. See the AffectedResource section below for attribute details.
attributes.aggregate_state String Overall state of the resources on the status page report. The possible values are: Operational, Maintenance, Downtime, or Degraded.
relationships Object Relationships object. See below.
relationships.status_updates.data Array of Objects Array of related status updates. Contains only its id, type is always 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.notify_subscribers Boolean Whether or not to send a notification email to subscribers of the status page.
attributes.status_report_id Integer ID of the related status report.
attributes.affected_resources AffectedResource[] Array of affected resources. See the AffectedResource section below for attribute details.

AffectedResource

Parameter Type Values
status_page_resource_id String ID of the affected status page resource.
status String The status of the affected status page resource. Possible values for manual type: resolved, degraded or downtime. For maintenance type the status has to be maintenance.

Previous article

Remove status page report

Next article

List status updates per report