Reports

Duplicate a report

This endpoint lets you duplicate an existing report. The report copy can be placed in a different folder from the original report, potentially with a different name and description.

Usage notes

  • The reportId parameter specifies the original report to be copied. Retrieve the reportId by calling the /v2/reports endpoint.
  • The destinationFolderId in the request body specifies where to place the new report.
    • To use the "My Documents" folder for a specific user as the destination folder, call the /v2/members/{memberId} endpoint and use the homeFolderId included in the response.
    • Retrieve the folderId of all folders by calling the /v2/files endpoint and reviewing the id field in the response for files with a type of folder.

Usage scenarios

  • Reuse report structure: Use an existing report as a baseline to make changes to.
  • Backup: Make a backup of a report before making significant changes.

Best practices

  • Always verify that the destination folder has the correct permissions set to avoid access issues.
post/v2/reports/{reportId}/copy

Request

  • Base URL
    https://api.sigmacomputing.com
  • Auth
    HTTP bearer

Path parameters

reportIdstring required

Unique identifier of the report.

Request body

destinationFolderIdstring required

ID of the folder in which to place the copied report.

namestring required

Name for the copied report as it appears in Sigma.

descriptionstring

A description for the new report.

Response

The response body.

reportIdstring required

Unique identifier of the report.

reportUrlIdstring required
namestring required
urlstring required
pathstring required
latestVersionnumber double required

The most recently published document version of the report.

ownerIdstring required
createdBystring required

The identifier of the user who created this object.

updatedBystring required

The identifier of the user or process that last updated this object.

createdAtstring date-time required

When the object was created.

updatedAtstring date-time required

When the object was last updated.

isArchivedboolean
descriptionstring

Changes

No recorded changes to this operation across all 1 revision of this API.