Understanding Your Status Page Overview

Learn how to access and understand your public status page to monitor service health and communicate with customers

Monitor Your Service Health with Status Pages

Learn how to access and understand your public status page to monitor the health and availability of your services in real-time.

What is a Status Page?

Your status page is a public-facing dashboard that displays the current health and availability of all your services. It allows your customers, team members, and stakeholders to quickly check if everything is running smoothly.

Accessing Your Status Page

Your Status Page URL

Your status page is accessible at:

https://yourdomain.com/api/v1/status-pages/public/[YOUR-PAGE-ID]/status/overview

Finding Your Page ID

• Dashboard Location: Go to Settings → Status Pages → Your page will display the unique page ID
• Format: Your page ID looks like aaa94712-bb41-4536-a674-1df42bc06068
• Bookmark It: Once you have your URL, bookmark it for quick access

Understanding the Overview Response

Response Structure

When you access your status page overview, you'll receive a JSON response with the following information:

{
  "status": "success",
  "data": {
    "services": [
      {
        "name": "API Service",
        "status": "operational",
        "description": "Main application API"
      },
      {
        "name": "Database",
        "status": "operational", 
        "description": "Primary database connection"
      }
    ]
  }
}

Status Values Explained

How to Use Your Status Page

For Your Team

1. Quick Health Check: Visit your status page URL to see all services at a glance
2. Proactive Monitoring: Check status before customer complaints come in
3. Communication Tool: Share the status page URL with your team for transparency

For Your Customers

• Share the URL: Provide customers with your status page link
• Embed on Website: Add a status widget to your homepage
• Include in Support: Reference status page in customer communications

Setting Up Your Status Page

Initial Configuration

1. Navigate to Status Pages: Dashboard → Features → Status Pages
2. Create New Status Page: Click "Create Status Page"
3. Add Services: List all services you want to monitor
4. Configure Monitoring: Set up health checks for each service
5. Save and Publish: Your page will be live immediately

Customizing Your Status Page

• Page Title: Customize the page header
• Service Names: Use descriptive names your users will understand
• Descriptions: Add helpful context for each service
• Branding: Apply your company colors and logo

Best Practices for Status Pages

Service Naming Guidelines

Monitoring Strategy

• Start Simple: Monitor 3-5 core services first
• Expand Gradually: Add more services as needed
• Keep Updated: Remove services you no longer use
• Test Regularly: Verify your monitoring is working

Integrating with Your Workflow

Team Notifications

1. Slack Integration: Get alerts in your team channel
2. Email Alerts: Receive notifications when status changes
3. Webhook Support: Connect to your incident management system

Customer Communication

• Email Signup: Allow customers to subscribe for updates
• Incident History: Maintain transparency with past incidents
• Scheduled Maintenance: Communicate planned downtime

Common Use Cases

Scenario 1: SaaS Application

Services to Monitor:

• User Authentication
• Database Connection
• API Endpoints
• Third-party Integrations
• Email Service

Scenario 2: E-commerce Platform

Services to Monitor:

• Product Catalog
• Shopping Cart
• Payment Processing
• Order Management
• Customer Accounts

Troubleshooting

Status Page Not Loading

1. Check URL: Verify your page ID is correct
2. Test Connection: Try accessing from different networks
3. Clear Cache: Refresh your browser or clear cache
4. Contact Support: Reach out if issues persist

Services Not Showing

• Check Service Configuration: Ensure services are properly added
• Verify Monitoring: Check if health checks are running
• Review Permissions: Ensure public access is enabled

Remember: Your status page is a powerful tool for transparency and communication. Keep it updated and share it proactively with stakeholders to build trust and reduce support inquiries.