# Response attributes

## Response parameters

Namespace `data`

| Parameter                               | Type                  | Values                                                                                                                                                                                                                                                                  |
|-----------------------------------------|-----------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `id`                                    | String                | The ID of the status page.                                                                                                                                                                                                                                              |
| `type`                                  | String                | `status_page`                                                                                                                                                                                                                                                           |
| `attributes`                            | Object                | Attributes object. See below.                                                                                                                                                                                                                                           |
| `attributes.company_name`               | String                | Name of your company. This will be displayed on the page.                                                                                                                                                                                                               |
| `attributes.company_url`                | String                | URL of your company's website.                                                                                                                                                                                                                                          |
| `attributes.contact_url`                | String                | URL that should be used for contacting you in case of an emergency. Can be `null`.                                                                                                                                                                                      |
| `attributes.logo_url`                   | String                | A direct link to your company's logo. The image should be under 20MB in size.                                                                                                                                                                                           |
| `attributes.dark_logo_url`                   | String                | A direct link to a dark version of your company's logo. The image should be under 20MB in size.                                                                                                                                                                                           |
| `attributes.whitelabeled`                   | String                | Whether the 'Powered by Better Stack' footer should be removed. This is a billable feature, see [Pricing](https://betterstack.com/pricing#status-pages ";_blank") for details.                                                                                                                                                                                           |
| `attributes.timezone`                   | String                | Timezone to display your status page in. The accepted values can be found in the [Rails TimeZone documentation](https://api.rubyonrails.org/classes/ActiveSupport/TimeZone.html).                                                                                       |
| `attributes.subdomain`                  | String                | Subdomain to be used for your status page. This needs to be unique across our entire application, so choose carefully.                                                                                                                                                  |
| `attributes.custom_domain`              | String                | Optionally, you can set a host name you own. Example: `status.walmine.com`. Requires a CNAME record that points your domain to `status.betteruptime.com`. Example: `CNAME status.walmine.com statuspage.betteruptime.com`.                                              |
| `attributes.custom_css`                 | String                | Unleash your inner designer and tweak our status page design to fit your branding.                                                                                                                                                                                      |
| `attributes.custom_javascript`          | String                | Level up your status page by adding analytics, interactive features, or any other functionality you need.                                                                                                                                                               |
| `attributes.design`                     | String                | Choose between classic and modern status page design. Possible values: `v1`, `v2`.                                                                                                                                                                                      |
| `attributes.navigation_links`           | Array of objects      | Adjust the navigation links on your status page. Accepts array of objects containing keys `text` and `href`, where `text` is the navigation link label and `href` is the link.                                                                                          |
| `attributes.theme`                      | String                | Select a color theme of your status page. Possible values: `light`, `dark`, `system`.                                                                                                                                                                                   |
| `attributes.layout`                     | String                | Pick your status page header layout. Possible values: `vertical`, `horizontal`.                                                                                                                                                                                         |
| `attributes.google_analytics_id`        | String                | Specify your own Google Analytics ID if you want to receive hits on your status page.                                                                                                                                                                                   |
| `attributes.min_incident_length`        | Integer               | If you don't want to display short incidents on your status page, this attribute is for you. In seconds.                                                                                                                                                                |
| `attributes.announcement`               | String                | Add an announcement to your status page.                                                                                                                                                                                                                                |
| `attributes.announcement_embed_enabled` | Boolean               | Toggle this field if you want to show an announcement in your embed  You can embed the announcement using this snippet: `<script src="https://uptime.betterstack.com/widgets/announcement.js" data-id="<SET STATUS_PAGE_ID>" async="async" type="text/javascript"></script>`. |
| `attributes.announcement_embed_css`     | String                | Modify the design of the announcement embed.                                                                                                                                                                                                                            |
| `attributes.announcement_embed_link`    | String                | Point your embedded announcement to a specified URL.                                                                                                                                                                                                                    |
| `attributes.automatic_reports`          | Boolean               | Whether to automatically create status page updates for new incidents.                                                                                                                                                                                                  |
| `attributes.status_page_group_id`       | Integer               | The ID of the status page group to which this status page belongs. Can be `null`.                                                                                                                                                                                       |
| `attributes.subscribable`               | Boolean               | Whether to allow users to subscribe to your status page changes.                                                                                                                                                                                                        |
| `attributes.hide_from_search_engines`   | Boolean               | Hide your status page from search engines.                                                                                                                                                                                                                              |
| `attributes.password_enabled`           | Boolean               | Whether to enable password protection on your status page.                                                                                                                                                                                                              |
| `attributes.ip_allowlist`           | Array of strings               | Restrict access to your status page by IP address. Only visitors from specified IP addresses or CIDR ranges can view the status page. Can contain comments starting with `#`. This is a billable feature, see [Pricing](https://betterstack.com/pricing#status-pages ";_blank") for details.                                                                                                                                                                                                              |
| `attributes.history`                    | Integer               | Number of days to display on the status page. Between `7` and `365` days.                                                                                                                                                                                               |
| `attributes.aggregate_state`            | String                | Overall state of the resources on the status page. The possible values are:  `Operational`  `Downtime`  `Degraded`  `Maintenance`.                                                                                                                                      |
| `attributes.created_at`                 | String (ISO DateTime) | When was the status page created.                                                                                                                                                                                                                                       |
| `attributes.updated_at`                 | String (ISO DateTime) | When was the status page last updated.                                                                                                                                                                                                                                  |