# Response attributes

## Response parameters

#### Namespace `data`

| Parameter    | Type   | Values                          |
|--------------|--------|---------------------------------|
| `id`         | String | ID of the status page resource. |
| `type`       | String | `status_page_resource`          |
| `attributes` | Object | Attributes object. See below.   |

#### Attributes

| Parameter                        | Type                    | Values                                                                                                                                                                                                                                                                                                        |
|----------------------------------|-------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `status_page_section_id`         | Integer                 | ID of the section this status page resource resides in.                                                                                                                                                                                                                                                       |
| `resource_id`                    | Integer                 | ID of the resource on which is the status page resource pointing. E.g.: the ID of the monitor.                                                                                                                                                                                                                |
| `resource_type`                  | String                  | Type of the resource on which is the status page resource pointing (e.g.: Monitor) Available values: `ManuallyTrackedItem`, `Monitor`, `MonitorGroup`, `Heartbeat`, `HeartbeatGroup`, `WebhookIntegration`, `EmailIntegration`, `IncomingWebhook`, `ResourceGroup`, `LogsChart`, `CatalogReference`.                                 |
| `public_name`                    | String                  | The resource name displayed publicly on your status page.                                                                                                                                                                                                                                                     |
| `explanation`                    | String                  | A detailed text displayed as a help icon.                                                                                                                                                                                                                                                                     |
| `history` (deprecated)           | Boolean                 | **DEPRECATED** Do you want to show the incident history for this item? Default: `true`. **Please use the `widget_type` for this setting.**                                                                                                                                                                    |
| `widget_type`                    | String                  | What widget to display for this resource. Available values:<br>`plain` - Only display status.<br>`history` - Display historical status.<br>`intraday_history` - Display detailed historical status.<br>`response_times` - Add a response times chart. Only for `Monitor` or `LogsChart`.<br>`chart_only` - Shows just the chart. Only for `LogsChart`. |
| `position`                       | Integer                 | The position of this resource on your status page, indexed from zero.  If you don't specify a `position`, we add the resource to the end of the status page.  When you specify a `position` of an existing resource, we add the resource to this position and shift resources below to accommodate.           |
| `mark_as_down_for`               | String                  | How the resource status is affected when an incident occurs. Possible values: `any_incident`, `no_incident`, `incident_matching_metadata`.                                                                                                                                                                    |
| `mark_as_down_metadata_rule`     | Object                  | A rule to match incident metadata. Only present when `mark_as_down_for` is `incident_matching_metadata`. The rule is a JSON object with `key` and `values` fields. See the [metadata API response params](https://betterstack.com/docs/uptime/api/metadata-api-response-params/) for details about metadata value attributes.              |
| `mark_as_degraded_for`           | String                  | How the resource status is affected when an incident occurs. Possible values: `any_incident`, `no_incident`, `incident_matching_metadata`.                                                                                                                                                                    |
| `mark_as_degraded_metadata_rule` | Object                  | A rule to match incident metadata. Only present when `mark_as_degraded_for` is `incident_matching_metadata`. The rule is a JSON object with `key` and `values` fields. See the [metadata API response params](https://betterstack.com/docs/uptime/api/metadata-api-response-params/) for details about metadata value attributes.          |
| `availability`                   | Double (Decimal number) | Takes on a the percentage value of a resource's availability.                                                                                                                                                                                                                  |
| `status`                         | String                  | The current status of the resource. Can be one of `not_monitored` (when the underlying monitor is paused), `operational`, `maintenance`, `degraded`, or `downtime`.                                                                                                                                           |
| `status_history.[]`              | StatusHistory           | Array of history objects. See the [StatusHistory](#statushistory) section below for attribute details.                                                                                                                                                                                                        |

#### StatusHistory

| Parameter              | Type    | Values                                  |
|------------------------|---------|-----------------------------------------|
| `day`                  | String  | Single day. In `YYYY-MM-DD` format.     |
| `status`               | String  | Status during this day.                 |
| `downtime_duration`    | Integer | The duration of downtime in seconds.    |
| `maintenance_duration` | Integer | The duration of maintenance in seconds. |
