GetInsight - AWS X-Ray


Retrieves the summary information of an insight. This includes impact to clients and root cause services, the top anomalous services, the category, the state of the insight, and the start and end time of the insight.

Request Syntax

POST /Insight HTTP/1.1 Content-type: application/json { "InsightId": "string" }

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.


The insight's unique identifier. Use the GetInsightSummaries action to retrieve an InsightId.

Type: String

Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}

Required: Yes

Response Syntax

HTTP/1.1 200 Content-type: application/json { "Insight": { "Categories": [ "string" ], "ClientRequestImpactStatistics": { "FaultCount": number, "OkCount": number, "TotalCount": number }, "EndTime": number, "GroupARN": "string", "GroupName": "string", "InsightId": "string", "RootCauseServiceId": { "AccountId": "string", "Name": "string", "Names": [ "string" ], "Type": "string" }, "RootCauseServiceRequestImpactStatistics": { "FaultCount": number, "OkCount": number, "TotalCount": number }, "StartTime": number, "State": "string", "Summary": "string", "TopAnomalousServices": [ { "ServiceId": { "AccountId": "string", "Name": "string", "Names": [ "string" ], "Type": "string" } } ] } }

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.


The summary information of an insight.

Type: Insight object


For information about the errors that are common to all actions, see Common Errors.


The request is missing required parameters or has invalid parameters.

HTTP Status Code: 400


The request exceeds the maximum number of requests per second.

HTTP Status Code: 429

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: