Convert a workbook to a report

POST

/v2/workbooks/:workbookId/convertToReport

POST

/v2/workbooks/:workbookId/convertToReport

curl -X POST https://api.sigmacomputing.com/v2/workbooks/workbookId/convertToReport \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json" \
     -d '{
  "name": "string"
}'

201Created

{
  "convertedReport": {
    "reportId": "string",
    "reportUrlId": "string",
    "name": "string",
    "url": "string",
    "path": "string",
    "latestVersion": 1.1,
    "ownerId": "string",
    "createdBy": "string",
    "updatedBy": "string",
    "createdAt": "2024-01-15T09:30:00Z",
    "updatedAt": "2024-01-15T09:30:00Z",
    "isArchived": true,
    "tags": [
      {
        "versionTagId": "string",
        "tagName": "string",
        "sourceVersion": 1.1,
        "taggedAt": "2024-01-15T09:30:00Z",
        "taggedReportId": "string"
      }
    ],
    "description": "string"
  },
  "sourceWorkbook": {
    "workbookId": "string",
    "name": "string",
    "url": "string"
  },
  "warnings": [
    {
      "code": "string",
      "message": "string",
      "details": [
        {
          "type": "string",
          "count": 1.1,
          "sourceElementIds": [
            "string"
          ],
          "reportElementIds": [
            "string"
          ],
          "parent": {
            "type": "string",
            "id": "string"
          }
        }
      ]
    }
  ]
}

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.

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.

Authentication

AuthorizationBearer

OAuth authentication of the form <token>.

Path parameters

workbookIdstringRequired

Unique identifier of the workbook.

Request

Body parameters for converting a workbook to a report.

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 newly created report and conversion details.

convertedReportobject

sourceWorkbookobject

warningslist of objects

Warnings about content that could not be carried over to the report. May be empty.