post https://api.sigmacomputing.com/v2/workbooks
This endpoint lets you create an empty workbook in Sigma, letting you start a data analysis project or report without any pre-existing templates or data sources set up.
Usage notes
- The
name
parameter is required to provide a name for the new workbook. - Use the folderId to specify the folder in which to save the workbook. Retrieve the folderId by calling the /v2/files endpoint and reviewing the
id
field in the response for files with atype
offolder
.
Usage scenarios
- Project initialization: When starting a new project that requires data analysis or reporting, users can quickly generate a new blank workbook to begin structuring their data and analyses.
- Template preparation: Administrators or team leads might create blank workbooks to set up standardized templates that their teams can use to maintain consistency in data handling and reporting.
Best practices
- Naming conventions: Establish and follow consistent naming conventions for workbooks to make it easier to manage and identify them within larger projects.
- Folder organization: Use the folderId to organize workbooks into relevant folders, which helps in maintaining a tidy workspace, especially in environments with multiple users or teams.
- Access control: Regularly review and manage access permissions for new workbooks, ensuring that only the appropriate personnel can view or edit sensitive data.