Get incident JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "getIncident path parameters",
  "type": "object",
  "required": [
    "id"
  ],
  "properties": {
    "id": {
      "description": "Incident ID",
      "type": "string",
      "x-parameter-location": "path"
    }
  }
}

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "getIncident response 200",
  "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"
    }
  }
}

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "getIncident 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
    }
  }
}

{
  "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
}

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "getIncident response 404",
  "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
    }
  }
}

{
  "code": 404,
  "error": "No L4 checkpoint available before requested timestamp",
  "error_code": "not_found",
  "request_id": "ad7df471-eb8a-477c-bd9f-c685a9825f5b",
  "success": false
}