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

GetMetricsSummary

Returns top level metrics about 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.

date

The date you want to retrieve summary metrics from, rounded to the nearest day. The date must be within the past two years since metrics data is only stored for two years. If a date outside of this range is passed, the response will be empty.

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