Get a status page's layout.
const url = 'https://api.siteqwality.com/v1/status-pages/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/layout';const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request GET \ --url https://api.siteqwality.com/v1/status-pages/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/layout \ --header 'Authorization: Bearer <token>'Authorizations
Section titled “Authorizations ”Parameters
Section titled “ Parameters ”Path Parameters
Section titled “Path Parameters ”Responses
Section titled “ Responses ”Groups and components in page order, hidden ones included
object
Shown first, above the groups.
A component on the page, as the page shows it.
object
What the layout and the component routes call it: the HTTP job, browser check or cron job id, or the manual component’s own id.
The same value as id, kept for clients that predate manual components.
One line shown under the name, or null.
A hidden component stays on the page’s list but is left off the public page.
False shows the status only, with no uptime bars or percentage. Heartbeats and manual components never show uptime.
The override in force, or null. One past its expiry reads as null.
object
What the owner says a component is doing: a manual component’s status, or an override on any
component. Stored as text (status_page_components.manual_status, *.override_status).
When it lapses on its own, or null to keep it until cleared.
In the order the page shows them.
object
In the order the page shows them.
A component on the page, as the page shows it.
object
What the layout and the component routes call it: the HTTP job, browser check or cron job id, or the manual component’s own id.
The same value as id, kept for clients that predate manual components.
One line shown under the name, or null.
A hidden component stays on the page’s list but is left off the public page.
False shows the status only, with no uptime bars or percentage. Heartbeats and manual components never show uptime.
The override in force, or null. One past its expiry reads as null.
object
What the owner says a component is doing: a manual component’s status, or an override on any
component. Stored as text (status_page_components.manual_status, *.override_status).
When it lapses on its own, or null to keep it until cleared.
Example
{ "ungrouped": [ { "kind": "http_job", "status": "operational", "status_override": { "status": "operational" } } ], "groups": [ { "components": [ { "kind": "http_job", "status": "operational", "status_override": { "status": "operational" } } ] } ]}Missing or invalid credentials
An RFC 9457 problem, the body of every /v1 error.
object
https://docs.siteqwality.com/errors/ and the failure’s code, such as not_found.
urn:uuid: and the request id.
The invalid fields, when the request body was refused.
One validation failure; pointer is an RFC 6901 pointer into the request body.
object
Example generated
{ "type": "example", "title": "example", "status": 1, "detail": "example", "instance": "example", "errors": [ { "pointer": "example", "detail": "example" } ]}The key or member may not do this, or lacks the scope it needs
An RFC 9457 problem, the body of every /v1 error.
object
https://docs.siteqwality.com/errors/ and the failure’s code, such as not_found.
urn:uuid: and the request id.
The invalid fields, when the request body was refused.
One validation failure; pointer is an RFC 6901 pointer into the request body.
object
Example generated
{ "type": "example", "title": "example", "status": 1, "detail": "example", "instance": "example", "errors": [ { "pointer": "example", "detail": "example" } ]}No such status page in this account
An RFC 9457 problem, the body of every /v1 error.
object
https://docs.siteqwality.com/errors/ and the failure’s code, such as not_found.
urn:uuid: and the request id.
The invalid fields, when the request body was refused.
One validation failure; pointer is an RFC 6901 pointer into the request body.
object
Example generated
{ "type": "example", "title": "example", "status": 1, "detail": "example", "instance": "example", "errors": [ { "pointer": "example", "detail": "example" } ]}Too many requests; wait for the time in Retry-After
An RFC 9457 problem, the body of every /v1 error.
object
https://docs.siteqwality.com/errors/ and the failure’s code, such as not_found.
urn:uuid: and the request id.
The invalid fields, when the request body was refused.
One validation failure; pointer is an RFC 6901 pointer into the request body.
object
Example generated
{ "type": "example", "title": "example", "status": 1, "detail": "example", "instance": "example", "errors": [ { "pointer": "example", "detail": "example" } ]}