get-insight-results

restish dci get-insight-results [flags]

Get Insight Results containing aggregate summary of results

Flags

--search-term: (string)

--display-status: (array)

--category: (string enum:"FinOps","OperationalExcellence","PerformanceEfficiency","Reliability","Security","Sustainability")

--provider: (string) The cloud provider associated with the resource.

--source: (array)

--priority: (array)

--tag: (array)

--easy-win: (boolean)

--cloud-flows: (boolean)

--page: (integer)

--page-size: (integer)

Responses

200 (application/json)

Successful operation

{
  "type": "object",
  "properties": {
    "results": {
      "type": "array",
      "items": {
        "type": "object",
        "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"
          },
          "title": {
            "type": "string"
          },
          "shortDescription": {
            "type": "string"
          },
          "detailedDescriptionMdx": {
            "type": "string"
          },
          "displayStatus": {
            "type": "string",
            "enum": [
              "actionable",
              "acknowledged",
              "optimized",
              "dismissed",
              "in progress",
              "upgrade needed",
              "permissions needed"
            ],
            "description": "The display status of the insight."
          },
          "provider": {
            "type": "string",
            "example": [
              "aws",
              "gcp",
              "azure",
              "snowflake",
              "wiz"
            ],
            "description": "The cloud provider associated with the resource."
          },
          "categories": {
            "type": "array",
            "items": {
              "type": "string",
              "enum": [
                "FinOps",
                "Operational excellence",
                "Performance efficiency",
                "Reliability",
                "Security",
                "Sustainability"
              ]
            }
          },
          "summary": {
            "type": "object",
            "properties": {
              "operationalRisks": {
                "type": "number"
              },
              "performanceRisks": {
                "type": "number"
              },
              "potentialDailySavings": {
                "type": "number"
              },
              "reliabilityRisks": {
                "type": "number"
              },
              "securityRisks": {
                "type": "number"
              },
              "sustainabilityRisks": {
                "type": "number"
              }
            }
          },
          "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"
          },
          "tags": {
            "description": "primary purpose, initially, is to provide security certification information, eg. ISO etc.",
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "reportUrl": {
            "type": "string"
          },
          "cloudFlowTemplateId": {
            "type": "string"
          },
          "easyWinDescription": {
            "type": "string"
          }
        }
      }
    },
    "pagination": {
      "type": "object",
      "description": "Pagination support is planned but not implemented yet. Supplying pagination parameters will have no effect at this time.",
      "required": [
        "hasNextPage"
      ],
      "properties": {
        "hasNextPage": {
          "type": "boolean",
          "description": "True if there are more results to fetch."
        }
      }
    }
  }
}

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-results, getinsightresults