Create a report

View as MarkdownOpen in Claude
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](https://help.sigmacomputing.com/reference/list-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.

Authentication

AuthorizationBearer

OAuth authentication of the form <token>.

Request

The request body.
folderIdstringRequired
ID of the folder where the new report is created.
namestringRequired
Name of the new report.
descriptionstringOptional
Description of the report.

Response

The response body.
reportIdstring
Unique identifier of the report.
reportUrlIdstring
namestring
urlstring
pathstring
latestVersiondouble
ownerIdstring
createdBystring
The identifier of the user who created this object.
updatedBystring
The identifier of the user or process that last updated this object.
createdAtdatetime
When the object was created.
updatedAtdatetime
When the object was last updated.
isArchivedboolean
tagslist of objects
descriptionstring