How to Show a Top Level Status of your Services using our API Endpoint



Embed your status page status anywhere using our API endpoint.


Get the list of components and their statuses, uptime and average response time with human descriptions and indicators, and includes a top-level status to programmatically embed it anywhere. Data shows metrics for the past 24 hours.


Use the status page URL to retrieve its data. For example, using demo.hyperping.io, the endpoint is https://app.hyperping.io/api/v1/demo.hyperping.io/status.json


Each individual component has 3 possible statuses:

  • When the component is under maintenance, status is "Under Maintenance" and its indicator is "maintenance"
  • When the component is down, status is "Outage" and its indicator is "down"
  • When the component is up, status is "Operational" and its indicator is "up"

Top level status is given this way:

  • If at least one service is down, top-level status is "Partial Outage" and its indicator is "partialoutage"
  • If at least one service is under maintenance and that there is no outage, top-level status is "System Under Maintenance" and its indicator is "maintenance"
  • If all services are down, top-level status is "Service Outage" and its indicator is "down"
  • If all services are up and running, top-level status is "All Systems Operational" and its indicator is "up"

Response example:

{
  "name": "Hyperping",
  "url": "http://demo.hyperping.io",
  "status": "All Systems Operational",
  "indicator": "up",
  "services": [
    {
      "url": "https://hyperping.io",
      "name": "Hyperping Landing",
      "uptime": "100.00%",
      "status": "Operational",
      "indicator": "up"
    },
    {
      "url": "https://app.hyperping.io",
      "name": "Dashboard",
      "uptime": "100.00%",
      "status": "Operational",
      "indicator": "up"
    },
    {
      "url": "https://demo.hyperping.io",
      "name": "Status Pages",
      "uptime": "100.00%",
      "status": "Operational",
      "indicator": "up"
    }
  ]
}

Use cases

A common use case is to place an indicator in your footer that redirects to your status page:


Or somewhere inside your dashboard:


You can also show the average uptime of all services:


Please let me know if you integrate it in your app or website, I would love to feature it here!

Get Started Free
Create your account
Blue check.15 day trialBlue check.No credit card required