This article will describe and define the fields and forms used in your Status Page. These components appear in all versions of a Status Page, whether it's an Internal Status Page, a Public Status Page, or a Public SLA page. Together, these options provide control over the data that appears on a Status Page as well as its visual representation to visitors. You can specify the components your Page will display, the look and feel of your Page, and how your visitors will interact with the page via the Status Page configuration.
To skip to a specific section of the "Uptime.com Status Page Solution: Basic Setup" video, click the links with the !
- Status Page Settings
- Privacy
- Design
- Components
- System Metrics
- Subscribing to Your Status Page
- External Access
- A Note on Markdown
Status Page Settings
These settings are common to all Status Page Visibility types.
General Fields
Adjust basic settings including name and description, timezone, display settings for Current Status and History & Incidents tabs, and Notification Settings.
Page Name: The name of your Page.
Page Description: This text is displayed at the top of the Page for your visitors. This field supports markdown.
Timezone: The timezone used to display reports and incidents on the Status Page. The maintenance and incident data you see while managing the Status Page is not affected by the timezone. However, the selected timezone will be used when viewing the Status Page live, such as when your users view the link to a public Status Page through the public URL.Note also that this is not the same Timezone setting from the Account Details. The Time Format option allows you to choose between 12-hour or 24-hour based time display.
Current Status
Display “Current Status” tab on your status page, when there is data: this checkbox controls the overall display of the “Current Status” tab on the status page. If this box is unchecked, the “Current Status” tab will not display at all, and the following status options will have no effect.
Display active incidents and scheduled maintenance: Displays active incidents at the top of the Current Status tab of your Page, and scheduled maintenance windows at the bottom of your Page.
Automatically hide when no events are present: Will automatically hide Active Incidents/Active Maintenance/Scheduled Maintenance tabs when no events exist.
Display components' "Response Time" graph in the "Current Status" table: Displays both response time and current status tables in the Current Status tab of your Status Page.
History & Incidents
Display "History & Incidents” tab on your status page: this checkbox controls the overall display of the “History & Incidents” tab on the status page. If this box is unchecked, the “History & Incidents” tab will not display at all, and the following status options will have no effect.
When viewing a Status Page, the History tab breaks down and offers insights into the performance of the Status Page and associated components with sub-tabs as follows:
History Overview: Displays a summary of the Status Page's history. Includes list of Past Events as well as the Component History. The Component History describes for each component the percentage of uptime, number of outages, amount of downtime, and average response time.
Past Incidents: Displays any incidents that have been created for the selected period. Note that only resolved incidents will be displayed here. Currently ongoing incidents will not be displayed.
Past Maintenance: Displays any past maintenance windows that have been created for the selected period.
Component History: Displays the table of components’ historical metrics for the selected period. When incidents are manually created, the status assigned to a component is visible in the Component History table.
In the above image, the outages listed represent manually created incidents. It is important to note that incidents and component status can act separate from one another. For example, if a component status is set to change to Major Outage, and an incident is NOT manually created, the component status will return to Operational and no outage will be listed in the History tab for your status page.
At least one incident must be created for a change in component status to be recorded in the History tab.
History & Incidents Fields
Automatically hide when no events are present: Will automatically hide Active Incidents/Active Maintenance/Scheduled Maintenance tabs when no events exist.
Default date range (days): The default number of days a visitor should see. The visitor will be able to adjust the date range if the History & Incidents tab is enabled.
Uptime calculated by: Select the value that calculates global uptime; the duration of your manually-created incidents or the calculated uptime percent of your check-based components.
Incident Durations: based on the total duration of created incidents versus the total duration of the selected report range. The Uptime % for the specific components is the calculated ratio of the total uptime divided by the total duration of the current time period.
Check-based Component Uptime: based on the sum of the downtime of the Status Page’s checks (attached to the Status Page components) versus the total duration of the current time period.
Note that when using Check-based Component Uptime, Global Uptime is based on the sum of the downtime across all checks rather than an average of the downtime across all checks. This is to avoid situations in which the total downtime could be less than the downtime of an individual check, which could be misleading.
If any of the checks in question were not active for some time during the report’s time span (for example, due to being paused or within a maintenance window), the inactive time will not be counted in the check’s “total running time” and thus will not be counted in the total uptime.
Please note: The calculations above are the same for the SLA report.
Maximum Selectable Time Range (days): Places a limit on the maximum number of days that can be selected in the date range field for viewing and reporting purposes.
Enable PDF report download: Enable a PDF download of the History and Incidents report for the date range specified. This option is ON by default for Public SLA and Internal Status Pages, and OFF by default for Public Status Pages.
History Graph: Enable an interactive visualization of your components’ availability history.
Summary Metrics: Allow Page visitors to see Global Uptime, Outages, and Total Downtime
Component History: Display a table of components’ historical metrics for the selected period.
Past Incidents: Display past incidents for the selected period.
Notification Settings
Send from Email: The email address used for Status Page notifications. It is possible to send from your own domain. See this article for assistance creating or editing your SPF Record.
Reply To Email: Allow subscribers to reply to this email address (e.g. support@your-domain.com).
Contact Email Address: Add an email address that your customers can use to report issues to you directly.
REST API Endpoints
To review the REST API endpoints click here: https://uptime.com/api/v1/docs/#!/statuspages
Privacy
Visibility Level: set the types of users who can see the Status Page.
- Uptime Users: only users with an Uptime.com account in the subscription can view the Status Page, by logging into their account and viewing the status page in the Uptime interface
- External Users: users outside of the Uptime.com account can view the page, but they must be invited using the External Users tab that appears when this visibility level is selected.
- Public: the Status Page can be viewed by anyone with the Public URL.
Allow users to subscribe to this page: controls the ability for visitors to the Status Page to subscribe to updates. When this box is unchecked, the Subscribe button will no longer appear on the Status Page. Use the checkboxes to set the allowed notification methods for notification updates. For more information about subscription methods, see the Subscribing to Your Status Page section.
Allow existing or manually added subscribers to be notified: when selected, subscribers that are manually added through an import or through the API will receive notifications.
Public URL: set the URL that will direct to your Status Page for anyone who has the link.
CNAME: set the custom subdomain for your Status Page. See additional information here.
Password
Username and Password: set optional HTTP-based authorization with this username and password combination.
Allow Search Engine Indexing Turn this option off to add a HTML header requesting search engines to not index your Page.
Allow drill down into individual checks: Allow visitors to view performance graphs and reports of check-based components.
Customize the maximum time period (in days) that a user can drill-in: set a maximum number of days in the past that is available to view reports.
Analytics & Tracking
Google Analytics Property ID: Your Google analytics property/measurement ID, such as UA-12345678-1 or G-1234567890.
Design
You can use these settings to adjust the look and feel of your Status Page.
Custom Logo: Upload a logo that will appear in the header of your Page. It is possible to make your logo clickable, with a link leading to a designated URL. See Company Website URL for additional details. Please note, this is not counted as a part of the “customisation option” of the status page & is available depending on the plan you are on.
Custom Favicon: A favicon that will act as the icon of your Page in the browser tab. Favicons must not exceed 192x192 px.Please note, this is not counted as a part of the “customisation option” of the status page & is available depending on the plan you are on.
Company Website URL: Clicking the logo of your status page will forward users to this URL.
The hex value for desired colors can be entered directly in the Header Background Color and Header Text Color fields. You can also click the color thumbnail to open a color picker:
Custom CSS: OPTIONAL: Inline CSS used to style customized HTML in the Header and Footer sections and/or to style the Page itself.
Custom Header HTML: OPTIONAL: Inline HTML to render in the header section in place of the standard logo & title.
Custom Footer HTML: OPTIONAL: Inline HTML to render in the footer section in place of the standard logo and title.
Please note: adding custom HTML and CSS to Status Pages is dependent upon the subscription plan you are on.
Custom Email Logo: Upload an image to use as the logo in emails sent to subscribers of your Page.
Components
Components represent the functional parts of your infrastructure, such as websites, API endpoints, or databases. They are not required to be linked to a check created within Uptime.com, nor are they required to complete the creation of your Page setup.
Some examples of components include:
- Your home page or application
- Support staff members onsite
- A web server
- API endpoints
- A third party online resource
Not all of the above examples are IT resources, but components generally represent the essentials behind a business or service. This includes internal components, which may not be monitored by Uptime.com.
A component or component group can be in one of the following statuses at a given time:
- Operational - Component is operating as intended, which is the default state
- Major Outage - The component is not available
- Partial Outage - The outage is partial and may affect users sporadically
- Degraded Performance - Performance is degraded, but no outages are detected
- Maintenance - In maintenance state
Please Note: The limit of components allowed is 1000 per Status Page.
Components Versus Component Groups
If a Component is a single resource necessary to your operations, Component Groups are related resources grouped together to make it easy for your visitors to inspect. Support staff from the above example could be a part of your Component Group, “Tech Support”. A group may also be a single site and all of its internal components, or set of servers per type i.e database(s), load balancer(s), or firewall(s).
Groups are most useful in providing the end user some clarity on which components are down, and setting expectations about their experience.
Component Status
There are several conditions under which a component’s status can change. Administrator users can manually change a component’s status, and the Page can automatically trigger a component status change based on check state, maintenance state, or incident state as well.
Please note that components set to automatically change status will not create an incident.
A component or group will inherit the status that is most severe. Here are two examples:
If you have 5 components within a component group, while one is experiencing a Major Outage and the other four are experiencing only Degraded Performance, your Page will show this component group as experiencing a Major Outage.
If a component is set to automatically trigger a component status change based on check state, and an administrator user manually adjusts that status during the incident, the component will not return to its automated pre-set state when the incident is resolved. Additionally, the auto behaviour of the component will remain inactive until the administrator manually restores the component’s status to Operational.
Uptime Bar
The Uptime Bar provides a visual timeline view of your components' status, making it easy to track their performance over time. This visualization uses a color-coded system:
- Green → Uptime
- Red → Downtime
- Red Dot → Indicates when a DOWN status occurred during that time interval
The number of bars displayed automatically adjusts based on the selected date range:
- Hourly: 1 bar for each hour
- 7 days: 7 bars
- 14 days: 14 bars
- 30 days: 30 bars
The bar display adjusts dynamically if you select a custom date range (e.g., 6 or 24 hours; 5 or 10 days) to show the appropriate number of bars/time intervals. The date range selected in the History tab will also be applied to the Current Status tab.
Hovering over a bar will display a pop-up representing the status in the timeframe represented by the bar, including any affected components that experienced downtime:
Component Fields
Component Name: Name of component/system, e.g. Website, Database, API.
Component Group: Select an existing component group for this component. If you have not yet created a component, you will need to click + Add Group from the component tab.
Here is more information on how groups differ from single components.
Component Description: OPTIONAL: Provide a description of this component for Page visitors
Associated Check: OPTIONAL: Link this component to a check to display response time. Checks can also affect component status.
If check fails, set component status to: OPTIONAL: Automatically change component status based on check state.
When check recovers, always set the component status to: Similar to “If Check Fails…” above, this is OPTIONAL. The component status will be set to the selected option once the check recovers.
Component Group Fields
Group Name: Group related components under this heading
Group Description (OPTIONAL): Add a description visible to Page visitors beneath the name of the component group.
Manually Select Components: search for components in the account; matching component names will appear in the Components Available box. Click a component name to select it to be included in the group.
Components Available: displays a list of all components in the account by default, or by matching terms if a search is entered. Click a component name to select it to be included in the group.
Components Selected: displays components selected to be included in the group. Click a component to deselect it.
System Metrics
A System Metric, such as response time graphs, adds visibility into critical system performance on your Status Page. System metrics are required to be linked to checks associated with your Uptime.com account that report on response time. Once-per-day checks, such as Blacklist/Malware, can not be tied to a metric.
Please Note: SSL checks will not show a graph on the response time since it is a once-per-day check. Instead it will show the time until expiration.
Some examples of metrics include:
- Response time graphs
- Performance statistics
Metric Fields
Associated Check: Link this System Metric to a check to display response time graph.
Metric Display Name: Visitors will see this name when viewing metrics for the associated check
Subscribing To Your Status Page
Once you have made the Status Page publicly available, from the live preview, you and anyone who views this page will be able to see a Subscribe to Updates button in the upper right corner of the Status Page.
Anyone who has access to the Status Page URL can subscribe to receive notifications for incidents or maintenance posted. The subscription options are:
- Slack
- SMS
- RSS
- Webhook
Note: The RSS link is a safe link, which is temporary.
Furthermore, your subscribers will be able to subscribe to specific components of their choice to receive updates to them. For more details, see the corresponding documentation here.
The screenshots below illustrate each of the subscription methods.
Email Flow
Slack Flow
SMS Flow
RSS Flow
Webhook
Using Custom Webhooks
Our Custom Webhooks enable you to send alerts to any third-party system that expects to receive an application/json encoded payload in the body of a request.
Here is a sample Uptime.com subscription POST request:
{
"name": "Test incident",
"description": "This is an incident update",
"starts_at": "2024-02-02T20:40:54.398000Z",
"ends_at": null,
"duration": 125.416398,
"incident_type_display": "Incident",
"updates": [
{
"created_at": "2024-02-02T20:40:54.398000Z",
"updated_at": "2024-02-02T20:40:54.398000Z",
"description": "This is an incident update",
"incident_state": "identified",
"incident_state_display": "Identified"
}
],
"affected_components": [],
"created_at": "2024-02-02T20:40:54.642672Z",
"incident_state": "identified",
"incident_type": "INCIDENT",
"url": "https://url-to-get-incident-details-via-api",
"manage_url": "https://url-to-manage-sp",
"unsubscribe_url": "https://url-to-unsubscribe"
}
External Access
Accounts with SSO enabled will have access to additional security measures for accessing their Status Page. To activate these two External User settings, set Visibility Level to Private.
For further details, please see Securing Your Uptime.com Status Page.
Please note: this feature may not be available in all account tiers. If you don't find the following settings in your status page, contact support@uptime.com for assistance.
Single Sign-On (SSO)
Secure your Status page with your SAML SSO and an external Identity Provider (IdP). This will be specific to the status page, and will require a separate IdP-side application.
External Users
Invite an external user by email to create status page-specific credentials with the Uptime.com login portal.
A Note on Markdown
Some fields support Markdown for complex formatting. Below are some examples:
Emphasis, aka italics, with *asterisks* or _underscores_.
Strong emphasis, aka bold, with **asterisks** or __underscores__.
Combined emphasis with **asterisks and _underscores_**.
Strikethrough uses two tildes. ~~Scratch this.~~
1. First ordered list item
2. Another item
⋅⋅* Unordered sub-list.
* Unordered list can use asterisks
- Or minuses
+ Or plusesWant to see our checks in action? Check out our YouTube Library for more!
Comments
0 comments