ARGUS Enterprise · JSON Structure

Argus Enterprise Health Status Structure

HealthStatus schema from ARGUS Enterprise API

Type: object Properties: 5
Altus GroupAsset ManagementCash Flow ModelingCommercial Real EstatePortfolio ManagementValuation

HealthStatus is a JSON Structure definition published by ARGUS Enterprise, describing 5 properties. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

status queueDepth recentErrorRate uptime lastChecked

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

Raw ↑ 
{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/argus-enterprise/refs/heads/main/json-structure/argus-enterprise-health-status-structure.json",
  "name": "HealthStatus",
  "description": "HealthStatus schema from ARGUS Enterprise API",
  "type": "object",
  "properties": {
    "status": {
      "type": "string",
      "enum": [
        "Healthy",
        "Degraded",
        "Unhealthy"
      ],
      "description": "Overall service health"
    },
    "queueDepth": {
      "type": "int32",
      "description": "Number of events pending delivery"
    },
    "recentErrorRate": {
      "type": "double",
      "description": "Error rate over the last hour (percentage)"
    },
    "uptime": {
      "type": "string",
      "description": "Service uptime duration"
    },
    "lastChecked": {
      "type": "datetime",
      "description": "Timestamp of last health check"
    }
  }
}