SIsigmacomputing
Workbooks

List SQL queries in a workbook

This endpoint retrieves a list of all SQL queries stored within a specific workbook. It is useful for developers and analysts who need to review or audit the queries being used for data manipulation and reporting within the workbook.

Usage notes

Usage scenarios

  • Audit and review: Enables administrators and data governance teams to audit and review all the queries associated with a workbook 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 workbooks 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/workbooks/{workbookId}/queries

Request

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

Path parameters

workbookIdstring required

Unique identifier of the workbook.

Query parameters

pagestring

Use to specify further pages using the string returned in the nextPage portion of the response.

limitnumber double

Number of results to return per page, with a maximum of 1,000 per request. Use the page option in subsequent requests to retrieve the next set of results.

Response

The response body.

nextPagestring nullable required
totalnumber double

Changes

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