Convert a workbook to a report

View as Markdown
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](https://help.sigmacomputing.com/docs/convert-workbooks-to-reports#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](https://help.sigmacomputing.com/reference/list-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.

Authentication

AuthorizationBearer

OAuth authentication of the form <token>.

Path parameters

workbookIdstringRequired

Request

The request body.
namestringRequired
Name for the new report.
destinationFolderIdstringOptional
ID of the folder in which to create the new report. Defaults to your "My Documents" folder.
descriptionstringOptional
A description for the new report.
pageIdslist of stringsOptional
IDs of the workbook pages to convert. Defaults to the entire workbook.
formatobjectOptional
Page size and orientation for the report. Defaults to letter portrait.

Response

The response body.
convertedReportobject
sourceWorkbookobject
warningslist of objects
Warnings about content that could not be carried over to the report. May be empty.