Reports

Audience: Customer — this page documents the reports page and data exports.

The reports page (/dashboard/reports) generates exportable violation reports with configurable filters.


URL

/dashboard/reports

Access

Pro and Enterprise only. Feature gate: reports_page.

Wrapped in <FeatureGate featureKey="reports_page">.


Page Layout

The page is divided into three sections:

  1. Report Type Selector — Choose the type of report
  2. Filters + Preview — Configure parameters and preview results
  3. Export — Download the generated report

Report Types

The ReportTypeSelector component offers different report formats:

Type ID Description
Violation Summary violation-summary Overview of all violations with aggregations

Additional report types may be added in future releases.


Filters

The ReportFilters component provides:

Filter Description
Date Range Start and end dates (defaults to last 30 days)
Severity Filter by error, warning, info
Categories Filter by rule category
Branches Filter by git branch
Projects Filter by project
Generate button Triggers report generation

Report Generation

POST /api/v1/reports/generate

Request body:

{
  "reportType": "violation-summary",
  "dateRange": {
    "start": "2026-01-10",
    "end": "2026-02-09"
  },
  "projectId": "optional-project-id"
}

Report Preview

The ReportPreview component renders the generated report data inline on the page. Shows a loading state while the report is being generated.


Export Options

The ReportExport component provides download options:

Format Description
PDF Formatted document with charts and tables
CSV Raw data for spreadsheet analysis

Export is only available after a report has been generated (the data prop must be non-null).


See Also