SIsigmacomputing
Reports

Get version history for a report

Get version history for a report given the reportId. If the version history contains any tagged versions, the response includes information about those tags.

Usage notes

  • Retrieve the reportId by calling the /v2/reports endpoint.

Usage scenarios

  • Audit and compliance: Demonstrate the history of changes to a report for audit and compliance purposes.
  • Restoring previous versions: Locate a prior version to compare against or restore after an unwanted change.

Best practices

  • Validate the reportId before making a request to avoid invalid requests.
get/v2/reports/{reportId}/version-history

Request

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

Path parameters

reportIdstring required

Unique identifier of the report.

Query parameters

pageTokenstring

Use to specify the next set of results with the string returned in the nextPageToken field of the previous response.

pageSizeinteger

Number of results to return per page, with a maximum of 1000. Defaults to 50.

Response

The response body.

nextPageTokenstring

A string that can be passed to the pageToken parameter in the next request to fetch the next page of results. Not present in the last page of results. Must be treated as an opaque string.

Changes

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