> ## Documentation Index
> Fetch the complete documentation index at: https://docs.wistx.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Status

> Real-time status and uptime information for WISTX services

# Status

Real-time status and uptime information for WISTX services.

<Info>
  Status information is checked on-demand via the [Status API](/api-reference/health#get-status). For programmatic access, use the API endpoints.
</Info>

## Current Status

<StatusIndicator status="operational">
  All systems operational
</StatusIndicator>

<Note>
  Status indicators reflect the current operational state. Use the [Status API](/api-reference/health#get-status) endpoint for real-time status checks.
</Note>

## Service Components

WISTX consists of the following service components, each monitored independently:

### API Service

* **Endpoint**: `api.wistx.ai`
* **Status**: Monitors REST API availability and response times
* **Health Check**: `/v1/health` (basic) or `/v1/status` (comprehensive)
* **Metrics**: API version, uptime, response times

### Database Services

* **Service**: MongoDB
* **Status**: Monitors database connectivity, latency, and connection pool
* **Metrics**: Connection count, query latency, server version, connection pool status

### Vector Search

* **Service**: Pinecone
* **Status**: Monitors vector database connectivity and index availability
* **Metrics**: Total vectors, index statistics, index name
* **Note**: Shows as "not\_configured" if Pinecone API key is not set

### Indexing Service

* **Status**: Monitors indexing job processing
* **Metrics**: Active jobs, recent job counts (jobs created today)

### Authentication Service

* **Status**: Monitors user authentication and authorization
* **Metrics**: Total users, active users

## Status API

For programmatic access to status information, use the Status API endpoints:

### Get System Status

```bash theme={null}
GET /v1/status
```

Returns comprehensive status for all services including:

* Overall system status (`operational`, `degraded`, or `down`)
* Individual service status for API, Database, Vector Search, Indexing, and Authentication
* Service-specific metrics (latency, connections, job counts, etc.)
* Check timestamp and duration

**Example Response:**

```json theme={null}
{
  "status": "operational",
  "timestamp": "2024-12-20T10:30:00.000Z",
  "check_duration_ms": 45.2,
  "services": {
    "api": {
      "status": "operational",
      "version": "1.0.0",
      "title": "WISTX API",
      "uptime_seconds": 86400
    },
    "database": {
      "status": "operational",
      "latency_ms": 12.5,
      "connections": {
        "current": 15,
        "available": 35,
        "max": 50
      },
      "server_version": "7.0.0"
    },
    "vector_search": {
      "status": "operational",
      "index_name": "wistx",
      "total_vectors": 150000
    },
    "indexing": {
      "status": "operational",
      "recent_jobs_today": 25,
      "active_jobs": 2
    },
    "authentication": {
      "status": "operational",
      "total_users": 1250,
      "active_users": 1180
    }
  }
}
```

### Get Uptime Statistics

```bash theme={null}
GET /v1/status/uptime?days=30
```

Returns uptime statistics for a specified period (1-365 days).

<Warning>
  **Uptime Statistics**: Historical uptime statistics require periodic status checks to be stored. Currently, uptime statistics are calculated from stored status checks. If no historical data exists, the endpoint will return an error. For real-time status, use `/v1/status` instead.
</Warning>

<Card title="View API Documentation" icon="code" href="/api-reference/health">
  Complete Status API reference with request/response examples in 7 programming languages
</Card>

## Status Indicators

Status indicators use the following status values:

* **operational** (Green) - Service is functioning normally
* **degraded** (Yellow) - Service is operational but experiencing issues or errors
* **down** (Red) - Service is unavailable or failing
* **not\_configured** (Gray) - Service is not configured (e.g., optional services like Pinecone)

## Overall Status Determination

The overall system status is determined from individual service statuses:

* **down** - If any service is `down`
* **degraded** - If any service is `degraded` or `not_configured`
* **operational** - If all services are `operational`

## Monitoring

WISTX status can be monitored using:

* **Health Check Endpoint** (`/v1/health`) - Simple health check, no authentication required
* **Status Endpoint** (`/v1/status`) - Comprehensive status for all services, requires authentication
* **Uptime Statistics** (`/v1/status/uptime`) - Historical uptime data, requires authentication

<Info>
  **Integration Tips:**

  * Use `/v1/health` for load balancer health checks (no auth required)
  * Use `/v1/status` for monitoring dashboards and alerting (requires API key)
  * Poll `/v1/status` at your desired interval (e.g., every 60 seconds) for continuous monitoring
  * Set up alerts based on the `status` field in the response
</Info>

## Service-Specific Details

### API Service Status

* Always returns `operational` if the API is responding
* Includes API version and title from configuration
* Calculates uptime from service start time

### Database Service Status

* Checks MongoDB connectivity via ping command
* Returns connection pool statistics
* Includes server version and latency metrics
* Returns `down` if database is unreachable

### Vector Search Status

* Checks Pinecone index availability
* Returns `not_configured` if Pinecone API key is not set
* Returns `degraded` if index is not found
* Returns `down` if Pinecone API is unreachable
* Includes total vector count and index statistics

### Indexing Service Status

* Checks active indexing jobs (status: `indexing` or `pending`)
* Counts jobs created today
* Returns `degraded` if database query fails

### Authentication Service Status

* Checks user collection statistics
* Returns total and active user counts
* Returns `degraded` if database query fails

## Error Handling

If a status check fails:

* Individual service status will show `degraded` or `down` with an error message
* Overall status will reflect the most severe service status
* Error details are included in the service response for debugging

## Related Documentation

<CardGroup cols={2}>
  <Card title="Status API Reference" icon="code" href="/api-reference/health">
    Complete API documentation with examples
  </Card>

  <Card title="Support" icon="help" href="mailto:hi@wistx.ai">
    Contact support for status-related questions
  </Card>
</CardGroup>

***

<Warning>
  **Note**: This status page provides an overview of WISTX service status. For real-time, programmatic access to status information, use the [Status API](/api-reference/health#get-status) endpoint. The status indicators shown above are representative - actual status should be verified via the API.
</Warning>


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.