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

Authorizations

​
x-api-key
string
header
required

API Key for authentication. You can generate an API key from your personal settings.

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
​
totalByState
object[]
required
​
totalByAnalysisType
object[]
required
​
vulnerabilitiesOverTime
object[]
required
​
riskScore
number
required

The risk score of the project

​
riskLevel
string
required

The risk level of the project