Sign in

v1

latestOpenAPI 3.0.32026-07-26233989.2 KB
Analysis

Get Full Analysis Report

Generates a sectioned CSV analysis report for a specific repository and commit, covering up to ten categories: SAST, Secrets, SCA, IaC, Anti-Patterns, Complex Functions, Docstring, Duplicate Code, Dead Code, and SBOM. Each category is emitted as its own labeled section with category-specific columns. By default, issues dismissed via the admin UI's dismiss-alerts workflow and issues flagged as false positives are excluded - use include_dismissed / include_false_positives to override. Returns a presigned URL for the resulting CSV.

post/api/analysis/results/full_report

Request body

repostring required

Repository identifier (format varies by service)

commit_idstring

Git commit SHA or identifier. Either commit_id or branch is required. If both are provided, commit_id takes precedence.

access_tokenstring required

Authentication token for the service

service'github' | 'azuredevops' | 'gitlab' | 'bitbucket' required

Version control service provider

branchstring

Git branch name. When provided without commit_id, the service resolves the latest commit from scan history for this branch. Either commit_id or branch is required.

fieldsstring[]

List of analysis categories to include in the sectioned CSV report. Each category becomes its own section with category-specific columns.

include_dismissedboolean

When true, dismissed issues (those marked as dismissed via the admin UI's dismiss-alerts workflow) are included in the report. Defaults to false, matching the admin UI behavior where dismissed issues are hidden.

include_false_positivesboolean

When true, issues flagged as false positives are included - specifically SAST issues with false_positive=true and Secrets with confidence_score=FALSE_POSITIVE. Defaults to false.

gitlab_base_urlstring

Base URL for GitLab service (optional)

github_base_urlstring

Base URL for GitHub service (optional)

azure_devops_base_urlstring

Base URL for Azure DevOps service (optional)

bitbucket_base_urlstring

Base URL for Bitbucket service (optional)

Example request

{
  "repo": "owner/repository",
  "commit_id": "abc123def456",
  "access_token": "ghp_xxxxxxxxxxxx",
  "service": "github",
  "branch": "main",
  "fields": [
    "Static Application Security Testing (SAST)",
    "Secrets",
    "Software Composition Analysis (SCA)",
    "Infrastructure as Code",
    "Anti-Patterns",
    "Complex Functions",
    "Docstring",
    "Duplicate Code",
    "Dead Code",
    "SBOM"
  ],
  "gitlab_base_url": "https://gitlab.com",
  "github_base_url": "https://github.com",
  "azure_devops_base_url": "https://dev.azure.com",
  "bitbucket_base_url": "https://api.bitbucket.org/2.0"
}

Response

Full report generated successfully

report_urlstring

URL to access the generated HTML report

status'success' | 'failed'

Status of the report generation

commit_idstring

Git commit SHA that was analyzed

branchstring

Git branch name that was analyzed

Example response

{
  "report_url": "https://storage.example.com/reports/owner-repository-abc123def456.html",
  "status": "success",
  "commit_id": "abc123def456",
  "branch": "main"
}