GetMetricsSummary - Amazon CodeGuru Security


Returns a summary of metrics for an account from a specified date, including number of open findings, the categories with most findings, the scans with most open findings, and scans with most open critical findings.

Request Syntax

GET /metrics/summary?date=date HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.


The date you want to retrieve summary metrics from, rounded to the nearest day. The date must be within the past two years.

Required: Yes

Request Body

The request does not have a request body.

Response Syntax

HTTP/1.1 200 Content-type: application/json { "metricsSummary": { "categoriesWithMostFindings": [ { "categoryName": "string", "findingNumber": number } ], "date": number, "openFindings": { "critical": number, "high": number, "info": number, "low": number, "medium": number }, "scansWithMostOpenCriticalFindings": [ { "findingNumber": number, "scanName": "string" } ], "scansWithMostOpenFindings": [ { "findingNumber": number, "scanName": "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 metrics from the specified date.

Type: MetricsSummary object


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


You do not have sufficient access to perform this action.

HTTP Status Code: 403


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

HTTP Status Code: 500


The request was denied due to request throttling.

HTTP Status Code: 429


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: