This endpoint converts an existing workbook into a new report. When you convert a workbook, the existing workbook is not modified. Elements and functionality in the workbook that are not supported in reports are listed in a warnings array in the response. Unsupported workbook contents are either removed (not added to the new report) or, if supported contents depend on them, are added to a hidden page at the end of the report. See Limitations and unsupported elements.

You can also convert a workbook to a report from the UI. See [Convert workbooks to reports](https://help.sigmacomputing.com/docs/convert-workbooks-to-reports).

Usage notes

• Retrieve the workbookId by calling the /v2/workbooks endpoint.
• The name parameter is required.
• Use destinationFolderId to choose where to save the report. If not provided, the report is saved to your My Documents folder.
• Use pageIds to convert only specific workbook pages. If not provided, the entire workbook is converted.
• Use format to set the page size and orientation. The default size is letter, and the default orientation is portrait.