SIsigmacomputing
Reports

List SQL queries in a report

This endpoint retrieves a list of all SQL queries stored within a specific report.

Usage notes

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

Usage scenarios

  • Audit and review: Enables administrators and data governance teams to audit and review all the queries associated with a report for compliance and optimization.
  • Query optimization: Allows users to identify and optimize potentially inefficient or slow queries to improve performance.

Best practices

  • Use pagination to manage large sets of queries efficiently, especially in reports with extensive data manipulation.
  • Regularly review queries as part of data governance practices to ensure they remain up to date and perform optimally.
get/v2/reports/{reportId}/queries

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.