export_report
Export a Visual Analytics report or selected objects in package, PDF, PNG, SVG, CSV, TSV, XLSX, or summary format. Use rendering options for PDF and image size for images.
Instructions
Export a Visual Analytics report (or specific report objects) in any format the VA service exposes, via its synchronous export endpoints.
Formats (export_format):
package— full report bundle as a.zip(source files, query results, and rendered content); whole report or selected objects.pdf— rendered PDF; whole report or selected objects. Pass rendering overrides (e.g.orientation,paperSize,margin,includeCoverPage) viaoptions.png/svg— image of the report or a single object;image_sizeis required, e.g."1200px,800px".csv/tsv/xlsx— the data behind a single report object; exactly one object label is required.summary— the report's text summary.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| options | No | Optional ``pdf`` rendering overrides, passed through as query parameters (e.g. ``{"orientation": "landscape"}``). | |
| report_id | Yes | ID of the report. | |
| image_size | No | Required for ``png``/``svg``; format ``"<w>px,<h>px"``. | |
| export_format | Yes | One of package, pdf, png, svg, csv, tsv, xlsx, summary. | |
| report_objects | No | Report object labels to export. ``package``/``pdf`` accept several; image and data formats accept exactly one; ``summary`` accepts none. Omit to export the whole report where the format allows it. |