Insights

Retrieve an insight

Returns the metadata and aggregate summary for a single insight identified by source and key. Does not include individual resource-level results — use the resource-results endpoint for those.

get/insights/v1/results/source/{sourceID}/insight/{insightKey}

Request

  • Base URL
    https://api.doit.com
  • URL
    https://api.doit.com/insights/v1/results/source/{sourceID}/insight/{insightKey}
  • Auth
    • API key in header Authorization
    • or API key in header X-Tenant-Id and API key in header Authorization

Path parameters

sourceIDstring required

The identifier of the source that generated the insight.

insightKeystring required

The unique key identifying the insight.

Response

Successful operation

sourcestring

The source that generated the insight.

keystring

The unique key identifying this insight.

titlestring

The display title of the insight.

shortDescriptionstring

A brief summary of the insight.

detailedDescriptionMdxstring

A detailed description of the insight in MDX format.

displayStatus'actionable' | 'acknowledged' | 'optimized' | 'dismissed' | 'in progress' | 'upgrade needed' | 'permissions needed'

The display status of the insight.

cloudProviderstring

The cloud provider associated with the resource.

categoriesCategory[]

Categories this insight belongs to.

lastUpdatedstring date-time

Timestamp of the last update to this insight.

tagsstring[]

Tags for the insight, primarily used for security certification labels (e.g. ISO).

reportUrlstring

URL to an external report related to this insight.

cloudFlowTemplateIdstring

ID of a CloudFlow template that can automate the remediation of this insight.

easyWinDescriptionstring

A description of why this insight is considered an easy win.

Example response

{
  "source": "aws-trusted-advisor, aws-cost-optimization-hub, aws-security-hub, azure-advisor, custom, gcp-recommender",
  "cloudProvider": "aws",
  "lastStatusChange": {
    "userId": "/users/0Rkrkeq5P0XLe8QFHKq2"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.