Use the Report Generator

Create custom report templates and trigger generation via the UI or REST API.

Before you start
Who this is for Architect, developer, manager
Role required Editor or higher
Prerequisites Application imported

What the Report Generator does

The Report Generator lets you define custom report templates. A template specifies:

  • Which data dimensions to include (objects, links, modules, transactions)
  • Which filters to apply (technology, tag, complexity threshold)
  • The output format (CSV, XLSX, JSON)

Step 1: Create a template

[TODO: Navigate to the Report Generator; create a new template; configure dimensions and filters; save]

Step 2: Run a report

Select a saved template and click Generate. The report downloads automatically.

Step 3: Schedule or automate

Use the REST API to trigger report generation from a CI/CD pipeline or a scheduled script.

[TODO: Example API call for report generation]

Next steps