Make sure you've read the getting started guide first. Once that's done, you should have our package & authentication ready to go.
Retrieve all status pages #
The simplest example is one where we list all your status pages that have been configured.
$statusPages = $ohDear->statusPages();
This will return an array of
The individual attributes will be explained in the next section.
Retrieve the status of a single status page #
The simplest example is one where we get the details of a single status page that has been configured. Below, we'll retrieve the status page with the ID of 1.
$statusPage = $ohDear->statusPage(1);
This will return an instance of
You can get a few properties of a Status Page.
$statusPage->id; $statusPage->title; $statusPage->attributes->sites; /* Array of sites */ $statusPage->attributes->updates; /* Array of update message */ $statusPage->summarized_status; ...
For more extensive understanding of the return values, please have a look at our status page API documentation.