New /status Endpoint: Monitoring System Health in Real-Time

Prompt: Unusual status symbol

We're excited to announce the release of our new `/status` endpoint, designed to provide comprehensive insights into the health and performance of your integrations. This powerful feature enables you to monitor the status of your services in real-time, helping you quickly identify and address any issues that may arise.

How the Status Endpoint Works

The `/status` endpoint provides information on your integrations. You need to provide an API key to access it.

When properly authenticated, the `/status` endpoint delivers a wealth of information about your integrations:

{
  "status": "ok",
  "data": {
    "integrations": [
      {"id": "1", "status": "healthy", "type": "MJ"},
      {"id": "2", "status": "healthy", "type": "DALL-E"}
    ],
    "healthy_integrations_count": 2,
    "total_integrations_count": 2,
    "healthy_percentage": 100.0,
    "stats_by_integration_type": {
      "MJ": {
        "total_count": 1,
        "healthy_count": 1,
        "healthy_percentage": 100.0,
        "status": "ok"
      },
      "DALL-E": {
        "total_count": 1,
        "healthy_count": 1,
        "healthy_percentage": 100.0,
        "status": "ok"
      }
    }
  }
}

Understanding the Status Response

The status response provides several key pieces of information:

Overall System Status

The top-level `status` field indicates the overall health of your system:

• `ok`: All integrations are healthy
• `degraded`: Some integrations have issues
• `unhealthy`: All integrations have issues

This at-a-glance indicator helps you quickly assess your system's health.

Detailed Integration Information

The `data` object contains comprehensive details about your integrations:

• `integrations`: A list of all your integrations with their individual status and type
• `healthy_integrations_count`: Number of integrations that are functioning properly
• `total_integrations_count`: Total number of integrations in your system
• `healthy_percentage`: Percentage of integrations that are healthy (0-100%)
• `stats_by_integration_type`: Breakdown of health statistics by integration type (MJ, DALL-E, etc.)

Integration-Specific Statistics

For each integration type, you'll receive:

• Total count of integrations of that type
• Count of healthy integrations
• Percentage of healthy integrations
• Status indicator for that integration type

Why This Matters

This endpoint offers several key benefits:

1. Early Problem Detection: Identify integration issues before they affect your users
2. Granular Insights: See exactly which integration types are experiencing problems
3. Status Tracking: Monitor the health percentage of your system over time
4. Integration-Specific Monitoring: Focus on the health of specific integration types

How to Use the Status Endpoint

To access your status information:

curl -H "Authorization: Bearer YOUR_API_TOKEN" https://cl.imagineapi.dev/status

Best Practices

1. Regular Polling: Check the endpoint periodically to monitor system health
2. Automated Alerts: Set up notifications for status changes
3. Dashboard Integration: Incorporate status data into your monitoring dashboards
4. Historical Tracking: Log status data to identify trends over time

We're committed to providing you with the tools you need to maintain reliable services. The `/status` endpoint is just one of many features we're developing to improve transparency and monitoring capabilities.Have questions about using the status endpoint? Drop us a line on the chat widget (bottom right)!