Insight Types List

Overview

Get all insight types available for an application, grouped by their category, criticality, and contribution. Each insight type includes its associated rules. This endpoint is useful for discovering available insight filters when creating custom nodes.

URI

GET /rest/applications/{application}/insights/types

Path parameters

application (string)

This parameter identifies the analyzed application. The application name must be properly encoded if required. Character back-quote is not allowed.

Responses

application/json

Example:

[
    {
        "insightType": "CloudReady",
        "category": "IBM Mainframes",
        "criticality": "Low",
        "contribution": "Blocker",
        "rules": [
            "Avoid using CICS BMS MAP",
            "Avoid using CICS DFHCOMMAREA"
        ]
    },
    {
        "insightType": "CloudReady",
        "category": "Files",
        "criticality": "Medium",
        "contribution": "Blocker",
        "rules": [
            "Avoid hardcoded file paths",
            "Avoid using local file system APIs"
        ]
    },
    {
        "insightType": "Green",
        "category": "Performance",
        "criticality": "High",
        "contribution": "Booster",
        "rules": [
            "Use efficient data structures",
            "Avoid unnecessary object creation"
        ]
    },
    {
        "insightType": "Container",
        "category": "Network",
        "criticality": "Medium",
        "contribution": "Blocker",
        "rules": [
            "Avoid hardcoded IP addresses",
            "Avoid hardcoded port numbers"
        ]
    }
]

JSON representation

Property Type Description
insightType string The insight type name (e.g., “CloudReady”, “Green”, “Container”).
category string The category within the insight type (e.g., “IBM Mainframes”, “Files”, “Network”).
criticality string The criticality level (e.g., “Low”, “Medium”, “High”).
contribution string The contribution type (e.g., “Blocker”, “Booster”).
rules []string List of specific rule names that belong to this insight type/category/criticality combination.

Usage Notes

Understanding the Response Structure

Each entry in the response represents a unique combination of:

  • insightType: The main insight category (CloudReady, Green, Container, etc.)
  • category: A sub-category within the insight type
  • criticality: The severity level (Low, Medium, High)
  • contribution: Whether it blocks or boosts cloud readiness

Using with Custom Nodes

When creating custom nodes with insight filters, use the format "InsightType - Value" where Value can be:

  1. Contribution: "CloudReady - Blocker" - matches all CloudReady blockers
  2. Criticality: "CloudReady - Medium" - matches all medium criticality CloudReady insights
  3. Category: "CloudReady - IBM Mainframes" - matches all CloudReady insights in the IBM Mainframes category

The matching priority is: contribution > criticality > category

Example: Finding Rules for Custom Node Filter

To create a custom node for CloudReady blockers:

  1. Call this API to get all insight types
  2. Filter entries where insightType = "CloudReady" and contribution = "Blocker"
  3. Collect all rules from matching entries
  4. Use these rules in the custom node’s insightFilters
{
    "insightFilters": [
        {
            "category": "CloudReady - Blocker",
            "rules": ["Avoid using CICS BMS MAP", "Avoid using CICS DFHCOMMAREA", ...]
        }
    ]
}