Route Metadata
| Field | Value |
|---|---|
| Method | GET |
| Path | /v1/data-quality/incidents |
| operationId | listIncidents |
| Tag | Data Quality |
| Family | Data Quality |
| Deprecated or legacy | no |
Request Parameters
Query Parameters
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"title": "listIncidents query parameters",
"type": "object",
"properties": {
"status": {
"description": "Filter by incident status",
"type": "string",
"enum": [
"open",
"investigating",
"identified",
"monitoring",
"resolved"
],
"x-parameter-location": "query"
},
"exchange": {
"description": "Filter by a venue-family key recognized by this route, such as `hyperliquid`.",
"type": "string",
"x-parameter-location": "query"
},
"since": {
"description": "Only show incidents starting after this timestamp (Unix ms)",
"type": "integer",
"format": "int64",
"x-parameter-location": "query"
},
"limit": {
"description": "Maximum results per page (default: 20, max: 100)",
"type": "integer",
"default": 20,
"maximum": 100,
"x-parameter-location": "query"
},
"offset": {
"description": "Pagination offset",
"type": "integer",
"default": 0,
"x-parameter-location": "query"
}
}
}
Response Contracts
Status 200
List of incidentsapplication/json
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"title": "listIncidents response 200",
"description": "Incidents list response",
"type": "object",
"properties": {
"incidents": {
"type": "array",
"items": {
"description": "Data quality incident",
"type": "object",
"properties": {
"data_types": {
"description": "Affected data types",
"type": "array",
"items": {
"type": "string"
}
},
"description": {
"type": "string",
"nullable": true
},
"duration_minutes": {
"type": "integer",
"nullable": true
},
"exchange": {
"description": "Affected venue-family key recognized by this route",
"type": "string",
"nullable": true
},
"id": {
"description": "Unique incident ID",
"type": "string"
},
"records_affected": {
"type": "integer",
"format": "int64",
"nullable": true
},
"records_recovered": {
"type": "integer",
"format": "int64",
"nullable": true
},
"resolution": {
"type": "string",
"nullable": true
},
"resolved_at": {
"type": "string",
"format": "date-time",
"nullable": true
},
"root_cause": {
"type": "string",
"nullable": true
},
"severity": {
"type": "string",
"enum": [
"minor",
"major",
"critical"
]
},
"started_at": {
"type": "string",
"format": "date-time"
},
"status": {
"type": "string",
"enum": [
"open",
"investigating",
"identified",
"monitoring",
"resolved"
]
},
"symbols_affected": {
"description": "Affected symbols",
"type": "array",
"items": {
"type": "string"
}
},
"title": {
"type": "string"
}
}
}
},
"pagination": {
"description": "Pagination info",
"type": "object",
"properties": {
"limit": {
"description": "Page size limit",
"type": "integer"
},
"offset": {
"description": "Current offset",
"type": "integer"
},
"total": {
"description": "Total number of items",
"type": "integer"
}
}
}
}
}
Status 401
Authentication requiredapplication/json
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"title": "listIncidents 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"
},
"request_id": {
"description": "Unique request ID for support",
"type": "string",
"format": "uuid"
}
}
}
OpenAPI example
{
"code": 401,
"error": "Missing or invalid API key. Provide X-API-Key header."
}