Skip to main content
GET
/
project
/
{projectId}
/
results
/
overview
Get overview of a project
curl --request GET \
  --url https://us.cybedefend.com/project/{projectId}/results/overview \
  --header 'Authorization: Bearer <token>'
{
  "totalBySeverity": [
    {
      "severity": "<string>",
      "count": 123
    }
  ],
  "totalByState": [
    {
      "state": "<string>",
      "count": 123
    }
  ],
  "totalByAnalysisType": [
    {
      "analysisType": "<string>",
      "count": 123
    }
  ],
  "vulnerabilitiesOverTime": [
    {
      "date": "<string>",
      "severity": 123,
      "count": 123
    }
  ]
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
projectId
string<uuid>
required

Query Parameters

​
branches
array[]

Filter vulnerabilities by branch names. Only vulnerabilities from these branches will be counted. Use GET /project/:projectId/branches to get available branches. Can be passed as comma-separated string or multiple query params.

Example:
["main", "develop"]

Response

Project overview

​
totalBySeverity
object[]
required

Aggregation of vulnerabilities grouped by severity

​
totalByState
object[]
required

Aggregation of vulnerabilities grouped by state

​
totalByAnalysisType
object[]
required

Aggregation of vulnerabilities grouped by analysis type

​
vulnerabilitiesOverTime
object[]
required

Number of vulnerabilities over time grouped by severity