API Reference
OPEN FOSSA APP

/v2/issues/compare/summaries

get
https://app.fossa.com/api/v2/issues/compare/summaries

Retrieve the counts for the different change statuses when in Issue Comparison mode. Supports both Project (revision comparison) and Release Group (release comparison) scopes.

Query Params
string
enum
required

Issue category

Allowed:
string
enum
required

Scope of issues to view

Allowed:
string

Project or release group ID (required when scope[type] is "project" or "releaseGroup")

string

Revision ID (when scope[type] is "project")

int32

Revision scan ID (when scope[type] is "project")

string

Release group ID (when scope[type] is "releaseGroup")

string

Release scan ID (when scope[type] is "releaseGroup")

string

The revision ID to compare issues with. Only available for Project Scope.

string

The release ID to compare issues with. Only available for Release Group Scope.

string
enum

The status of issues to fetch when comparing issues. - New issues are present in the current revision but not in the comparison revision. - Remediated issues are present in the comparison revision but not in the current revision. - Unchanged issues are present in both revisions. Only available for Project Scope.

Allowed:
ids[]
array of integers

Filter by specific issue IDs

ids[]
filter[revisionIds][]
array of strings

Filter by specific revision IDs

filter[revisionIds][]
string

Filter by package name or CVE (when category is "vulnerability")

filter[depths][]
array of strings

Filter by issue depth

filter[depths][]
filter[ticketed][]
array of strings

Filter by ticketed status. Only available to premium users.

filter[ticketed][]
filter[containerLayers][]
array of strings

Filter by container layer

filter[containerLayers][]
filter[type][]

Filter by licensing issue type (when category is "licensing") or quality issue type (when category is "quality")

filter[packageManagers][]
array of strings

Filter by specific package managers

filter[packageManagers][]
filter[cwes][]
array of strings

Filter by specific CWE identifiers

filter[cwes][]
filter[projectLabels][]
array of strings

Filter by specific project labels

filter[projectLabels][]
filter[identification][]
array of strings

Filter by license identification (when category is "licensing")

filter[identification][]
filter[severity][]
array of strings

Filter by vuln severity (when category is "vulnerability")

filter[severity][]
date-time

Include only issues found on after a given ISO timestamp. Only available to premium users

filter[hasFix][]
array of strings

Filter by vuln fixability (when category is "vulnerability")

filter[hasFix][]
filter[upgradeDistance][]
array of strings

Filter by vuln upgrade distance (when category is "vulnerability")

filter[upgradeDistance][]
filter[exploitMaturity][]
array of strings

Filter by vuln exploit maturity (when category is "vulnerability")

filter[exploitMaturity][]
filter[ignoreReason][]
array of strings

Filter by vuln ignore reason (when category is "vulnerability") This value appears in the vulnerabilities.analysis.detail field in CycloneDX SBOM reports

filter[ignoreReason][]
filter[epss]
object

Filter by epss 'score' or 'percentile'. All fields are required. Only available to premium users.

filter[confidence][]
array of strings

Filter issues by their binary dependency confidence level(s)

filter[confidence][]
filter[issueSource][]

Filter by issue source. Use 'dependency' and 'snippet' to filter by whether the issue comes from a dependency or a code snippet. When the vendored dependency detection feature is enabled, use 'managed-dependency' and 'vendored-dependency' to filter dependency issues by whether the dependency is managed or vendored.

Responses

Updated 5 months ago

Language
Credentials
Bearer
Response 
Click Try It! to start a request and see the response here! Or choose an example:
application/json
Updated 5 months ago