ListFindingsMetrics - Amazon CodeGuru Security

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" }

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.

findingsMetrics

A list of AccountFindingsMetric objects retrieved from the specified time interval.

Type: Array of AccountFindingsMetric objects

nextToken

A pagination token. You can use this in future calls to ListFindingMetrics to continue listing results after the current page.

Type: String

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

Pattern: ^[\S]+$

Errors

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

AccessDeniedException

You do not have sufficient access to perform this action.

HTTP Status Code: 403

InternalServerException

The server encountered an internal error and is unable to complete the request.

HTTP Status Code: 500

ThrottlingException

The request was denied due to request throttling.

HTTP Status Code: 429

ValidationException

The input fails to satisfy the specified constraints.

HTTP Status Code: 400

See Also

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