Export report (CSV)
export_reportExport one saved analysis's results as CSV through the single audited egress path. Pass report_id for a saved analysis or an inline ReportSpec; returns the CSV text + row count + filename. A dashboard is not one CSV: choose a linked panel's source analysis or an inline panel's spec. Every export is recorded (a report_runs row + an audit_log report.export event).
When to use: Export one saved analysis or an inline ReportSpec as CSV. A dashboard needs a panel chosen first; it is not exported as one table. Every export is logged for governance.
Example: Export the ARR-by-industry report as a CSV.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| report_id | No | A saved analysis's id (uuid) to export; give this or definition (report_id wins when both are passed). A dashboard or segment id is refused. | |
| definition | No | An inline ReportSpec for a single analysis (not a dashboard) to export without saving it; omit when passing report_id. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| csv | No | ||
| format | No | ||
| filename | No | ||
| row_count | No | ||
| truncated | No |