get-insight-result

dci get-insight-result sourceID insightKey

Get Single Insight Result

Responses

200 (application/json)

Successful operation

{
  "type": "object",
  "description": "An insight result containing summary information and metadata.",
  "properties": {
    "source": {
      "type": "string",
      "description": "The source that generated the insight.",
      "example": "aws-trusted-advisor, aws-cost-optimization-hub, aws-security-hub, azure-advisor, custom, gcp-recommender"
    },
    "key": {
      "type": "string",
      "description": "The unique key identifying this insight."
    },
    "title": {
      "type": "string",
      "description": "The display title of the insight."
    },
    "shortDescription": {
      "type": "string",
      "description": "A brief summary of the insight."
    },
    "detailedDescriptionMdx": {
      "type": "string",
      "description": "A detailed description of the insight in MDX format."
    },
    "displayStatus": {
      "type": "string",
      "enum": [
        "actionable",
        "acknowledged",
        "optimized",
        "dismissed",
        "in progress",
        "upgrade needed",
        "permissions needed"
      ],
      "description": "The display status of the insight."
    },
    "cloudProvider": {
      "type": "string",
      "example": "aws",
      "description": "The cloud provider associated with the resource."
    },
    "categories": {
      "description": "Categories this insight belongs to.",
      "type": "array",
      "items": {
        "type": "string",
        "description": "The insight category.",
        "enum": [
          "FinOps",
          "Operational excellence",
          "Performance efficiency",
          "Reliability",
          "Security",
          "Sustainability"
        ]
      }
    },
    "summary": {
      "type": "object",
      "description": "Aggregate summary of risks and savings across all resource results for an insight.",
      "properties": {
        "operationalRisks": {
          "type": "number",
          "format": "double",
          "description": "Total number of operational risks."
        },
        "performanceRisks": {
          "type": "number",
          "format": "double",
          "description": "Total number of performance risks."
        },
        "potentialDailySavings": {
          "type": "number",
          "format": "double",
          "description": "Total potential daily savings in USD."
        },
        "reliabilityRisks": {
          "type": "number",
          "format": "double",
          "description": "Total number of reliability risks."
        },
        "securityRisks": {
          "type": "number",
          "format": "double",
          "description": "Total number of security risks."
        },
        "sustainabilityRisks": {
          "type": "number",
          "format": "double",
          "description": "Total number of sustainability risks."
        }
      }
    },
    "lastStatusChange": {
      "description": "If set, this object contains the last status change made by a user for this insight",
      "type": "object",
      "properties": {
        "userId": {
          "description": "the reference to the user who made the change (if it was made by a user) If the change was made by an automated system, this reference is empty.\n",
          "type": "string",
          "example": "/users/0Rkrkeq5P0XLe8QFHKq2"
        },
        "lastChangedAt": {
          "type": "string",
          "format": "date-time"
        }
      },
      "required": [
        "userId",
        "lastChangedAt"
      ]
    },
    "lastUpdated": {
      "type": "string",
      "format": "date-time",
      "description": "Timestamp of the last update to this insight."
    },
    "tags": {
      "description": "Tags for the insight, primarily used for security certification labels (e.g. ISO).",
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "reportUrl": {
      "type": "string",
      "description": "URL to an external report related to this insight."
    },
    "cloudFlowTemplateId": {
      "type": "string",
      "description": "ID of a CloudFlow template that can automate the remediation of this insight."
    },
    "easyWinDescription": {
      "type": "string",
      "description": "A description of why this insight is considered an easy win."
    }
  }
}

400 (application/json)

Bad Request - The server cannot process the request, often due to a malformed request.

{
  "type": "object",
  "description": "Standard error response structure.",
  "properties": {
    "error": {
      "type": "string",
      "description": "Detailed error message."
    }
  }
}

401 (application/json)

Unauthorized - Invalid API key.

{
  "type": "object",
  "description": "Standard error response structure.",
  "properties": {
    "error": {
      "type": "string",
      "description": "Detailed error message."
    }
  }
}

403 (application/json)

Forbidden - The client is not authorized to perform the request.

{
  "type": "object",
  "description": "Standard error response structure.",
  "properties": {
    "error": {
      "type": "string",
      "description": "Detailed error message."
    }
  }
}

404 (application/json)

Not Found - The requested resource does not exist.

{
  "type": "object",
  "description": "Standard error response structure.",
  "properties": {
    "error": {
      "type": "string",
      "description": "Detailed error message."
    }
  }
}

500 (application/json)

Internal Server Error - Something went wrong with the DoiT API server.

{
  "type": "object",
  "description": "Standard error response structure.",
  "properties": {
    "error": {
      "type": "string",
      "description": "Detailed error message."
    }
  }
}

Aliases: get-insight-result, getinsightresult