APIs
Reports
APIs
Reports
You can query for a report associated with an Account or a Repository. You can do so by querying for the reports field in the Account or Repository objects. Account.reports contains all the reports available for an Account. Repository.reports contains all the reports available for a Repository.
Fetching the OWASP Top 10 report for a repository
Query:repository:report:owaspTop10 Query for fetching the OWASP Top 10 report associated with a Repository.
Sample Request
Sample Response
Fetching the OWASP Top 10 report for an account
Query:repository:report:owaspTop10 Query for fetching the OWASP Top 10 report associated with an Account.
Sample Request
Sample Response
Fetching a report for a repository [Deprecated]
Query:repository:report field is deprecated in favor of Query:repository:reports field.
Query:repository:report Query for fetching a report associated with a Repository.
Sample Request
Sample Response
Fetching a report for an account [Deprecated]
Query:account:report field is deprecated in favor of Query:account:reports field.
Query:account:report Query for fetching a report associated with an Account.
Sample Request
Sample Response
Objects
AccountReportsNamespace
A namespace containing all the reports available in an Account.
| Field | Type | Description |
|---|---|---|
| owaspTop10 | OwaspTop10Report! | The OWASP Top 10 report for a account. |
| sansTop25 | SansTop25Report! | The SANS Top 25 report for a account. |
| codeHealthTrend | CodeHealthTrendReport! | The Code Health Trend report for a account. |
| issueDistribution | IssueDistributionReport! | The Issue Distribution report for a account. |
| issuesPrevented | IssuesPreventedReport! | The Issues Prevented report for a account. |
| issuesAutofixed | IssuesAutofixedReport! | The Issues Autofixed report for a account. |
RepositoryReportsNamespace
A namespace containing all the reports available in a Repository.
| Field | Type | Description |
|---|---|---|
| owaspTop10 | OwaspTop10Report! | The OWASP Top 10 report for a repository. |
| sansTop25 | SansTop25Report! | The SANS Top 25 report for a repository. |
| codeHealthTrend | CodeHealthTrendReport! | The Code Health Trend report for a repository. |
| issueDistribution | IssueDistributionReport! | The Issue Distribution report for a repository. |
| issuesPrevented | IssuesPreventedReport! | The Issues Prevented report for a repository. |
| issuesAutofixed | IssuesAutofixedReport! | The Issues Autofixed report for a repository. |
OwaspTop10Report
Represents the OWASP Top 10 report.
| Field | Type | Description |
|---|---|---|
| key | ReportKey! | An enum that uniquely identifies a report. |
| title | String! | The title of the report. |
| currentValue | Int | The current value of the reported statistic. |
| values | [ReportValueItem]! | The values of the report between the given start and end dates. |
| startDate | Date! | The start date for the values. |
| endDate | Date! | The end date for the values. |
| trends | [Trend]! | The trends across 1 month, 3 month, 6 month and 12 months. |
| status | ReportStatus! | The status of the report. |
| securityIssueStats | [SecurityIssueStat]! | This contains all data regarding the occurrences of the compliance issues. |
SansTop25Report
Represents the SANS Top 25 report.
| Field | Type | Description |
|---|---|---|
| key | ReportKey! | An enum that uniquely identifies a report. |
| title | String! | The title of the report. |
| currentValue | Int | The current value of the reported statistic. |
| values | [ReportValueItem]! | The values of the report between the given start and end dates. |
| startDate | Date! | The start date for the values. |
| endDate | Date! | The end date for the values. |
| trends | [Trend]! | The trends across 1 month, 3 month, 6 month and 12 months. |
| status | ReportStatus! | The status of the report. |
| securityIssueStats | [SecurityIssueStat]! | This contains all data regarding the occurrences of the compliance issues. |
CodeCoverageReport
Represents the Code Coverage report.
| Field | Type | Description |
|---|---|---|
| key | ReportKey! | An enum that uniquely identifies a report. |
| title | String! | The title of the report. |
| repositories | CodeCoverageReportRepositoryConnection | The list of repositories along with their code coverage metric values. |
| q | String | The query param to search the repositories by name. |
| sortKey | CodeCoverageReportRepositorySortKey | An enum to sort the list of repositories by. |
| offset | Int | The count of repositories to skip. |
| before | String | A cursor to be used with last for backward pagination. |
| after | String | The number of items to forward paginate. |
| last | Int | The number of items to backward paginate. |
CodeHealthTrendReport
Represents the Code Health Trend report.
| Field | Type | Description |
|---|---|---|
| key | ReportKey! | An enum that uniquely identifies a report. |
| title | String! | The title of the report. |
| currentValue | Int | The current value of the reported statistic. |
| values | [ReportValueItem]! | The values of the report between the given start and end dates. |
| startDate | Date! | The start date for the values. |
| endDate | Date! | The end date for the values. |
| trends | [Trend]! | The trends across 1 month, 3 month, 6 month and 12 months. |
IssueDistributionReport
Represents the Issue Distribution report.
| Field | Type | Description |
|---|---|---|
| key | ReportKey! | An enum that uniquely identifies a report. |
| title | String! | The title of the report. |
| currentValue | Int | The current value of the reported statistic. |
| values | [ReportValueItem]! | The values of the report between the given start and end dates. |
| startDate | Date! | The start date for the values. |
| endDate | Date! | The end date for the values. |
| trends | [Trend]! | The trends across 1 month, 3 month, 6 month and 12 months. |
| issueDistributionByAnalyzer | IssueDistribution! | Distribution of issues by analyzer. |
| issueDistributionByCategory | IssueDistribution! | Distribution of issues by category. |
IssuesPreventedReport
Represents the Issues Prevented report.
| Field | Type | Description |
|---|---|---|
| key | ReportKey! | An enum that uniquely identifies a report. |
| title | String! | The title of the report. |
| currentValue | Int | The current value of the reported statistic. |
| values | [ReportValueItem]! | The values of the report between the given start and end dates. |
| startDate | Date! | The start date for the values. |
| endDate | Date! | The end date for the values. |
| trends | [Trend]! | The trends across 1 month, 3 month, 6 month and 12 months. |
| issueDistributionByAnalyzer | IssueDistribution! | Distribution of issues by analyzer. |
| issueDistributionByCategory | IssueDistribution! | Distribution of issues by category. |
IssuesAutofixedReport
Represents the Issues Autofixed report.
| Field | Type | Description |
|---|---|---|
| key | ReportKey! | An enum that uniquely identifies a report. |
| title | String! | The title of the report. |
| currentValue | Int | The current value of the reported statistic. |
| values | [ReportValueItem]! | The values of the report between the given start and end dates. |
| startDate | Date! | The start date for the values. |
| endDate | Date! | The end date for the values. |
| trends | [Trend]! | The trends across 1 month, 3 month, 6 month and 12 months. |
ReportValueItem
Represents the list of values recorded for a report on a specific date.
| Field | Type | Description |
|---|---|---|
| date | Date! | The date the values were recorded on. |
| values | ReportValue | The list of values recorded. |
ReportValue
Represents a recorded value in a report.
| Field | Type | Description |
|---|---|---|
| key | String! | The key to identify the recorded value |
| value | Int | The recorded value. |
IssueDistribution
| Field | Type | Description |
|---|---|---|
| key | String! | Key representing the category/type of issue. |
| value | Int! | Number of issues in the category/type of issue. |
SecurityIssueStat
| Field | Type | Description |
|---|---|---|
| key | String! | The key of the security issue. |
| title | String! | Title of the security issue. |
| occurrence | SeverityDistribution! | Denotes the count of occurrences of various security issues. |
SeverityDistribution
| Field | Type | Description |
|---|---|---|
| critical | Int | Number of security issues categorized as critical. |
| major | Int | Number of security issues categorized as major. |
| minor | Int | Number of security issues categorized as minor. |
| major | Int! | Total number of security issues. |
CodeCoverageReportRepositoryConnection
| Field | Type | Description |
|---|---|---|
| pageInfo | PageInfo! | Pagination data for this connection. |
| edges | [CodeCoverageReportRepositoryEdge]! | Contains the nodes in this connection. |
| totalCount | Int | The total count of the nodes. |
CodeCoverageReportRepositoryEdge
| Field | Type | Description |
|---|---|---|
| node | CodeCoverageReportRepository | The CodeCoverageReportRepository object. |
| cursor | [String]! | The cursor to be used for pagination. |
CodeCoverageReportRepository
| Field | Type | Description |
|---|---|---|
| name | [String]! | The name of the repository. |
| id | [ID]! | The ID of the repository. |
| lcvMetricValue | [Float] | The LCV metric value for the repository. |
| bcvMetricValue | [Float] | The BCV metric value for the repository. |
| isLcvPassing | [Boolean] | Whether the LCV value is passing the threshold set for the metric. |
| isBcvPassing | [Boolean] | Whether the BCV value is passing the threshold set for the metric. |
Trend
Compares the report value across different time periods.
| Field | Type | Description |
|---|---|---|
| label | String! | A label for the trend. For example: “1 Month Ago” |
| value | Int! | The value of the trend. |
| changePercentage | Float! | The rate of change compared to the current value. |
Deprecated
The following GraphQL interfaces & objects have been deprecated and will be removed soon.
Interfaces
Report
Represents the report associated with an Account or Repository.
| Field | Type | Description |
|---|---|---|
| key | ReportKey! | This is an enum that is used to uniquely identify a report. |
| title | String! | Title of the report. |
| currentValue | Int! | The current value of the reported statistic. |
| historicalValues | [HistoricalValueItem]! | The historical data of the report. |
| startDate | Date! | The start date for the historical values. |
| endDate | Date! | The end date for the historical values. |
| trends | [Trend]! | The trends across 1 month, 3 month, 6 month and 12 months. |
Objects
ComplianceReport
Represents a compliance report. Currently there are two compliance reports - OWASP_TOP_10 and SANS_TOP_25.
Implements the Report interface.
| Field | Type | Description |
|---|---|---|
| key | ReportKey! | This is an enum that is used to uniquely identify a report. |
| title | String! | Title of the report. |
| currentValue | Int! | The current value of the reported statistic. |
| historicalValues | [HistoricalValueItem]! | The historical data of the report. |
| startDate | Date! | The start date for the historical values. |
| endDate | Date! | The end date for the historical values. |
| trends | [Trend]! | The trends across 1 month, 3 month, 6 month and 12 months. |
| complianceIssueStats | [ComplianceIssueStat]! | This contains all data regarding the occurrences of the compliance issues. |
ComplianceIssueStat
| Field | Type | Description |
|---|---|---|
| key | String! | The key of the compliance issue. |
| title | String! | Title of the compliance issue. |
| occurrence | ComplianceIssueOccurrenceCount! | Denotes the count of occurences of various compliance issues. |
ComplianceIssueOccurrenceCount
| Field | Type | Description |
|---|---|---|
| critical | Int | Number of compliance issues categorized as critical. |
| major | Int | Number of compliance issues categorized as major. |
| minor | Int | Number of compliance issues categorized as minor. |
| major | Int! | Total number of compliance issues. |
HistoricalValue
| Field | Type | Description |
|---|---|---|
| key | String! | The key to uniquely identify the recorded value. |
| value | Int! | The value of the recorded value. |
HistoricalValueItem
| Field | Type | Description |
|---|---|---|
| date | Date! | Date of the recorded value. |
| values | [HistoricalValue]! | A list of values recorded on the associated date. |