Status page's JSON data via API
Access your status page data programmatically through a public JSON endpoint.
Every Hyperping status page exposes a /status.json endpoint that returns the current status and uptime of your services in a machine-readable format. This lets you integrate your status page data into dashboards, internal tools, or automated checks without scraping the HTML page.
The JSON endpoint is useful when:
- You want to display your current status on your own website or dashboard
- You need automated scripts to check your service health
- You are building internal tooling that reacts to status changes
- You want a lightweight way to monitor your overall status from a third-party system
Access the endpoint
Append /status.json to your status page URL. For example:
https://meta.hyperping.app/status.json
If your status page uses a custom domain like status.yourcompany.com, the endpoint would be status.yourcompany.com/status.json.
Response format
The endpoint returns a JSON object with two fields:
{
"indicator": "up",
"uptime": "99.967%"
}| Field | Type | Description |
|---|---|---|
indicator | string | Current top-level status of your status page |
uptime | string | Average uptime across services with "Show uptime" enabled, over the past 90 days |
Indicator values
The indicator field reflects the overall status of your status page. The value is determined by the highest-priority condition, checked in this order:
| Indicator | Priority | Condition |
|---|---|---|
maintenance | 1 (highest) | At least one service is under maintenance |
incident | 2 | At least one (but not all) services have a downtime or are part of an incident |
outage | 3 | All services have a downtime or are part of an incident |
up | 4 (lowest) | All services are operational |
Integration examples
Embed status in a dashboard - Fetch the JSON endpoint on a timer and display the indicator and uptime values in your internal dashboard or Grafana panel.
Automated health checks - Use a cron job or CI/CD pipeline step to poll the endpoint and fail a build or trigger an alert if the indicator is not up.
Slack bot or chatops - Build a simple bot that queries the endpoint and posts the current status to a Slack channel on demand.
Troubleshooting
The endpoint returns a 404.
Verify your status page URL is correct and that the page is published. The JSON endpoint is only available on active status pages.
Uptime shows as "N/A".
Make sure at least one service on your status page has the "Show uptime" option enabled. The uptime value is calculated only from services with this option turned on.
The indicator does not update immediately.
The JSON endpoint reflects real-time status. If the indicator seems stale, check that your monitors are correctly linked to the status page services and that incidents are being created automatically.
