Graph Health

Database Health Check

get/v1/graphs/{graph_id}/health

Request

  • Base URL: https://api.robosystems.ai (the document declares no server; this is the origin it was published from)
  • URL: https://api.robosystems.ai/v1/graphs/{graph_id}/health
  • Auth: one of:
    • API key in header X-API-Key
    • HTTP bearer

Path parameters

graph_idstring required

Response

Successful Response

graph_idstring required

Graph database identifier

statusstring required

Overall health status

connection_statusstring required

Database connection status

uptime_secondsnumber required

Database uptime in seconds

last_query_timestring nullable

Timestamp of last query execution

query_count_24hinteger required

Number of queries executed in last 24 hours

avg_query_time_msnumber required

Average query execution time in milliseconds

error_rate_24hnumber required

Error rate in last 24 hours (percentage)

memory_usage_mbnumber nullable

Instance memory in use, MB. Only populated for dedicated single-tenant instances; null on shared repositories and packed tiers.

memory_usage_percentnumber nullable

Instance memory in use, percent. Expect high values during materialization — the engine deliberately boosts to near the whole instance while rebuilding. Read resource_status rather than this number alone. Dedicated instances only.

cpu_usage_percentnumber nullable

Instance CPU in use, percent. Dedicated single-tenant instances only.

resource_statusstring nullable

Interpreted instance load: 'idle' (headroom), 'busy' (working normally — typical while materializing), 'constrained' (sustained pressure worth acting on). Null when resource metrics are not exposed.

storage_usage_mbnumber nullable

Storage usage in MB

alertsstring[]

Active alerts or warnings

is_staleboolean

Whether the graph has staged changes not yet materialized

stale_reasonstring nullable

Reason the graph was marked stale (e.g. 'file_deleted: data.parquet')

stale_sincestring nullable

ISO timestamp when the graph became stale

last_materialized_atstring nullable

ISO timestamp of the last successful materialization

hours_since_materializationnumber nullable

Hours elapsed since last materialization

Example response

{
  "graph_id": "kg1a2b3c4d5",
  "status": "healthy",
  "connection_status": "connected",
  "uptime_seconds": 3600.5,
  "last_query_time": "2024-01-15T10:30:00Z",
  "query_count_24h": 150,
  "avg_query_time_ms": 45.2,
  "error_rate_24h": 0.5,
  "memory_usage_mb": 512.3,
  "memory_usage_percent": 41.8,
  "cpu_usage_percent": 12.4,
  "resource_status": "idle",
  "storage_usage_mb": 1024.7,
  "alerts": [
    "High memory usage detected"
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.