Route Metadata
| Field | Value |
|---|---|
| Method | GET |
| Path | /v1/data-quality/status |
| operationId | getDataQualityStatus |
| Tag | Data Quality |
| Family | Data Quality |
| Deprecated or legacy | no |
Human endpoint reference
OpenGET /v1/data-quality/status for authentication, parameters, responses, and examples.
Implementation context
Response Contracts
Status 200
System statusapplication/json
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"title": "getDataQualityStatus response 200",
"description": "Overall system status",
"type": "object",
"properties": {
"active_incidents": {
"description": "Number of active incidents",
"type": "integer"
},
"data_types": {
"description": "Per-data-type status",
"type": "object",
"additionalProperties": {
"description": "Status of a data type",
"type": "object",
"properties": {
"completeness_24h": {
"description": "Data completeness over last 24 hours (0-100)",
"type": "number"
},
"status": {
"type": "string",
"enum": [
"operational",
"degraded",
"outage",
"maintenance"
]
}
}
}
},
"exchanges": {
"description": "Per-exchange status",
"type": "object",
"additionalProperties": {
"description": "Status of a single exchange",
"type": "object",
"properties": {
"last_data_at": {
"description": "Timestamp of last received data",
"type": "string",
"format": "date-time",
"nullable": true
},
"latency_ms": {
"description": "Current latency in milliseconds",
"type": "integer",
"nullable": true
},
"status": {
"type": "string",
"enum": [
"operational",
"degraded",
"outage",
"maintenance"
]
}
}
}
},
"status": {
"description": "Overall system status",
"type": "string",
"enum": [
"operational",
"degraded",
"outage",
"maintenance"
]
},
"updated_at": {
"description": "When this status was computed",
"type": "string",
"format": "date-time"
}
}
}
Status 401
Authentication requiredapplication/json
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"title": "getDataQualityStatus response 401",
"description": "Error response",
"type": "object",
"properties": {
"code": {
"description": "HTTP status code",
"type": "integer"
},
"error": {
"description": "Error message",
"type": "string"
},
"error_code": {
"description": "Machine-readable error code. Common values: `invalid_query_params` (a query parameter failed to parse or validate) and `invalid_path_params` (a path parameter failed to parse). Other endpoint-specific codes exist; treat unknown codes as generic errors of the given HTTP status.",
"type": "string"
},
"param": {
"description": "The parameter at fault, when the error is about one parameter.",
"type": "string"
},
"request_id": {
"description": "Unique request ID for support",
"type": "string",
"format": "uuid"
},
"success": {
"description": "Always false on an error.",
"type": "boolean",
"example": false
}
}
}
OpenAPI example
{
"code": 401,
"error": "Missing authentication credentials. Provide X-API-Key header or Bearer token.",
"error_code": "unauthorized",
"request_id": "71ed4b6f-63ef-4ae1-a123-07ffa47c1c14",
"success": false
}