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