Skip to main content

Status Pages

Status Pages enable you to display the health and status of your websites to both customers and stakeholders. With the Uptimia API, you have the capability to view, create, edit, and delete status pages. Additionally, it allows for updating the status of incidents and maintenance activities, which are referred to as "Threads" in this tutorial.

This guide will highlight the key aspects of Status Pages.

Public Status Page​

As implied by its name, a Public Status Page is accessible to anyone with the link to the page. You can create a new status page using this API call. This page can be accessed either on the Uptimia website or on your own custom domain, should you opt for that choice.

Status Page Structure​

The layout of a status page is crucial as it determines which monitors are included, as well as their grouping and arrangement.

Below is an example of a status page structure object:

[{
    name: 'First section',
    description: 'First section description',
    monitors: [
        {
            id: 1,
            type: 'uptime'
        },
        {
            id: 2,
            type: 'uptime'
        },
        {
            id: 1,
            type: 'speed'
        },

    ]
},
{
    name: 'Second section',
    description: 'Second section description',
    monitors: [
        {
            id: 1,
            type: 'transaction'
        }

    ]
}]

The structure is composed of 2 key components:

  • section: This is the primary element of the structure. A section is capable of containing multiple monitors, and these will be grouped together within it.
  • monitors: This refers to a collection of monitors that are part of the section. If the section includes multiple monitors, they will be grouped together. However, if only a single monitor is added, it will be displayed as an independent entity on the status page.

It's important to note that the arrangement of sections and monitors on the status page will mirror the order they appear in your structure object.

Monitors​

The monitor object is comprised of two elements: "id" and "type." For a status page, the following types of monitors are available: uptime, speed, transaction, ssl, virus.

Threads​

Threads function as updates for incidents and maintenance events on a status page. Detailed API documentation for managing threads can be found here. Threads are categorized into three types:

  • general: This type of thread is not specifically linked to any incident or maintenance event. It serves as a general update or information.
  • incident: These threads are directly associated with a particular incident, providing updates or information related to it.
  • maintenance: Similar to incident threads, these are specifically tied to maintenance events, offering relevant updates.

Display of Threads on Status Page:

  • Unresolved Threads: If a thread is marked as unresolved (is_resolved is set to false), it will be prominently displayed at the top of the main page of the status page.
  • Resolved Threads: Once resolved, these threads are moved to a dedicated section labeled "Past Status Updates" for reference and historical context.