USER MANUAL · PRODUCTIVITY

Reports

Generate, download, and schedule operational reports for cost summaries, agent health, and audit trails.

/reports

Overview#

The Reports page lets you create on-demand operational reports from your ClawButler data. Reports aggregate information across agents, costs, and audit events into downloadable documents.

Supported report types include cost summaries, agent health snapshots, and audit trail summaries. Export formats include CSV for data analysis and PDF for sharing with stakeholders.

Prerequisites#

Prerequisites
  • Sufficient data available for the desired report type (e.g., cost records for cost summary)
  • Appropriate permissions to access the data included in the report

Expected Results#

The Reports page provides a complete workflow for report management:

  • -Report list showing previously generated reports with status, type, date range, and download links
  • -Generation status indicators (queued, processing, completed, failed) with progress tracking
  • -Download links for completed reports in CSV and PDF formats

Web Operations#

The Reports page is organized around four key workflows: browsing existing reports, generating new ones, downloading results, and managing scheduled reports.

Report List

The main view displays all generated reports in a table with columns for report name, type, date range, status, and creation date. Filter by report type or status to find specific reports quickly.

Generate Report

Click the Generate Report button to create a new report. Select the report type (cost summary, agent health, or audit summary), choose a date range, and optionally filter by specific agents or categories. Report generation runs in the background.

Download & Export

Once a report is completed, download it in your preferred format. CSV exports contain raw tabular data suitable for spreadsheets and data tools. PDF exports include formatted summaries with charts, ready for sharing.

Scheduled Reports

Set up recurring report generation on a daily, weekly, or monthly schedule. Scheduled reports are automatically generated and stored in your report list. Configure email delivery to receive reports directly in your inbox.

CLI Operations#

List all previously generated reports with their status and metadata

Terminal
$ ap report list

Generate a new report by specifying the type and date range

Terminal
$ ap report generate --type cost-summary --range 30d

Download a completed report to a local file in the specified format

Terminal
$ ap report export <id> --format pdf --output ./report.pdf

FAQ#

Q: How long does it take to generate a report?
A: Most reports complete within a few seconds. Large reports covering extended time periods or many agents may take up to a minute. You can navigate away and return later — the report continues generating in the background.
Q: What is the difference between CSV and PDF exports?
A: CSV exports contain raw data in a tabular format, ideal for importing into spreadsheets or data analysis tools. PDF exports include formatted summaries with visual charts, designed for sharing with team members or stakeholders.
Q: Can I schedule a report to be generated automatically?
A: Yes. On the Scheduled Reports tab, you can configure recurring generation on a daily, weekly, or monthly basis. Each scheduled report uses the same parameters as a manual report and is stored in your report list when completed.
Reports — ClawButler User Manual