Skip to main content
POST
Get report findings
This endpoint is in beta. It may still change before it reaches general availability.

Authorizations

Authorization
string
header
required

Get access to data with your API token. Example header:

Authorization: Bearer 2991e2fb4b540fe75b8f90677b0b892b6314e4961cb001fe6eb452eee248a628

The token can be provisioned from the Tokens section in your Settings, and requires explicitly enabling Web API access.

Path Parameters

deploymentId
string<int64>
required

The unique numerical identifier of the deployment associated with the report.

Example:

"1234"

Body

application/json
reportType
enum<string>
Available options:
REPORT_TYPE_TOTAL_OPEN,
REPORT_TYPE_TOTAL_FIXED,
REPORT_TYPE_TOTAL_IGNORED,
REPORT_TYPE_TOTAL_PROVISIONALLY_IGNORED,
REPORT_TYPE_OPEN_BACKLOG,
REPORT_TYPE_BACKLOG_ACTIVITY,
REPORT_TYPE_PROJECT,
REPORT_TYPE_GUARDRAILS_ACTIVITY
filters
object
cursor
string
limit
integer<int64>
bucketStart
string<date-time>
findingState
enum<string>
Available options:
AGGREGATE_ISSUE_STATE_OPEN,
AGGREGATE_ISSUE_STATE_FIXED,
AGGREGATE_ISSUE_STATE_REMOVED,
AGGREGATE_ISSUE_STATE_IGNORED_APP,
AGGREGATE_ISSUE_STATE_IGNORED_CODE,
AGGREGATE_ISSUE_STATE_UNKNOWN,
AGGREGATE_ISSUE_STATE_REVIEWING,
AGGREGATE_ISSUE_STATE_FIXING,
AGGREGATE_ISSUE_STATE_PROVISIONALLY_IGNORED_APP
guardrailsState
string

Response

200 - application/json

OK

findings
object[]
cursor
string
total
integer<int64>
totalCode
integer<int64>
totalSca
integer<int64>
totalSecrets
integer<int64>