Create a report

This endpoint lets you create an empty report in Sigma, enabling you to build presentation-ready documents for sharing insights with stakeholders.

Usage notes

• The name parameter is required to provide a name for the new report.
• Use the folderId to specify the folder in which to save the report. Retrieve the folderId by calling the /v2/files endpoint and reviewing the id field in the response for files with a type of folder.

Usage scenarios

• Reliable export formatting: Users can quickly generate a new blank report to create predictable, paginated exports.

Best practices

• Naming conventions: Establish and follow consistent naming conventions for reports to make it easier to manage and identify them within larger projects.
• Folder organization: Use the folderId to organize reports 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 reports, ensuring that only the appropriate personnel can view or edit sensitive data.

Create a report from a code representation (Beta)

Beta: This documentation describes a public beta feature and is subject to the Beta features disclaimer.

You can use this endpoint to create a new report in Sigma based on a code representation. This allows you to programmatically define the contents of the report, which is then accessible from the Sigma UI.

To define elements, data sources, layouts, and more, populate the contents parameter in the request body with a code representation. For more information, see Manage reports as code.

Usage notes for the code representation of a report

• The default response format is JSON. To use YAML, add the header Accept: application/yaml.
• Set dryRun to true to validate a representation without creating a report.
• To retrieve the current representation of a report, use GET /reports/{reportId}?includeContents=true.
• To update an existing report from code, use PUT /reports/{reportId}/contents.