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

ListFindingsMetrics

Returns metrics about all findings in an account within a specified time range.

Request Syntax


GET /metrics/findings?endDate=endDate&maxResults=maxResults&nextToken=nextToken&startDate=startDate HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

endDate

The end date of the interval which you want to retrieve metrics from. Round to the nearest day.

Required: Yes

maxResults

The maximum number of results to return in the response. Use this parameter when paginating results. If additional results exist beyond the number you specify, the nextToken element is returned in the response. Use nextToken in a subsequent request to retrieve additional results. If not specified, returns 1000 results.

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

nextToken

A token to use for paginating results that are returned in the response. Set the value of this parameter to null for the first request. For subsequent calls, use the nextToken value returned from the previous request to continue listing results after the first page.

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

Pattern: ^[\S]+$

startDate

The start date of the interval which you want to retrieve metrics from. Rounds to the nearest day.

Required: Yes

Request Body

The request does not have a request body.

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "findingsMetrics": [ 
      { 
         "closedFindings": { 
            "critical": number,
            "high": number,
            "info": number,
            "low": number,
            "medium": number
         },
         "date": number,
         "meanTimeToClose": { 
            "critical": number,
            "high": number,
            "info": number,
            "low": number,
            "medium": number
         },
         "newFindings": { 
            "critical": number,
            "high": number,
            "info": number,
            "low": number,
            "medium": number
         },
         "openFindings": { 
            "critical": number,
            "high": number,
            "info": number,
            "low": number,
            "medium": number
         }
      }
   ],
   "nextToken": "string"
}