Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

GetInsightEvents

X-Ray reevaluates insights periodically until they're resolved, and records each intermediate state as an event. You can review an insight's events in the Impact Timeline on the Inspect page in the X-Ray console.

Request Syntax


POST /InsightEvents HTTP/1.1
Content-type: application/json

{
   "InsightId": "string",
   "MaxResults": number,
   "NextToken": "string"
}

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

InsightId

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

MaxResults

Used to retrieve at most the specified value of events.

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 50.

Required: No

NextToken

Specify the pagination token returned by a previous request to retrieve the next page of events.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 2000.

Required: No

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "InsightEvents": [ 
      { 
         "ClientRequestImpactStatistics": { 
            "FaultCount": number,
            "OkCount": number,
            "TotalCount": number
         },
         "EventTime": number,
         "RootCauseServiceRequestImpactStatistics": { 
            "FaultCount": number,
            "OkCount": number,
            "TotalCount": number
         },
         "Summary": "string",
         "TopAnomalousServices": [ 
            { 
               "ServiceId": { 
                  "AccountId": "string",
                  "Name": "string",
                  "Names": [ "string" ],
                  "Type": "string"
               }
            }
         ]
      }
   ],
   "NextToken": "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.

InsightEvents

A detailed description of the event. This includes the time of the event, client and root cause impact statistics, and the top anomalous service at the time of the event.

Type: Array of InsightEvent objects

NextToken

Use this token to retrieve the next page of insight events.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 2000.

Errors

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

InvalidRequestException

The request is missing required parameters or has invalid parameters.

HTTP Status Code: 400

ThrottledException

The request exceeds the maximum number of requests per second.

HTTP Status Code: 429