POST
/InsightSummaries
http://xray.{region}.amazonaws.com/InsightSummariesRetrieves the summaries of all insights in the specified group matching the provided filter values.
Access Token Required: API Key
Query Params
MaxResultsstring
Pagination limit
NextTokenstring
Pagination token
Body Params
Statesarray
The list of insight states.
EndTimestringrequired
The end of the time frame in which the insights ended. The end time can't be more than 30 days old.
GroupARNstring
The Amazon Resource Name (ARN) of the group. Required if the GroupName isn't provided.
GroupNamestring
The name of the group. Required if the GroupARN isn't provided.
NextTokenstring
Pagination token.
StartTimestringrequired
The beginning of the time frame in which the insights started. The start time can't be more than 30 days old.
MaxResultsinteger
The maximum number of results to display.
Responses
{
"success": true,
"data": {
"id": "abc123",
"created_at": "2025-01-01T00:00:00Z"
}
}{
"success": false,
"error": {
"code": "VALIDATION_ERROR",
"message": "Invalid request parameters"
}
}Language
CredentialsAPI KEY
API Key
Enter token below to save for later
cURL Request
1curl --request POST \2 --url 'http://xray.{region}.amazonaws.com/InsightSummaries' \3 --header 'accept: application/json' \4 --header 'content-type: application/json'Response
1{2 "success": true,3 "data": {4 "id": "abc123",5 "created_at": "2025-01-01T00:00:00Z"6 }7}