List SQL queries in a workbook

GET

/v2/workbooks/:workbookId/queries

GET

/v2/workbooks/:workbookId/queries

$ curl https://api.sigmacomputing.com/v2/workbooks/workbookId/queries \
>      -H "Authorization: Bearer <token>" \
>      -H "Content-Type: application/json"

200Retrieved

1 {
2   "entries": [
3     {
4       "elementId": "a1b2c3d4-e5f6-7890-ab12-cd34ef567890",
5       "name": "Monthly Sales Summary",
6       "sql": "SELECT region, SUM(sales) AS total_sales, MONTH(order_date) AS month FROM sales_data GROUP BY region, month ORDER BY month",
7       "error": null
8     },
9     {
10       "elementId": "f0e1d2c3-b4a5-6789-0abc-def123456789",
11       "name": "Customer Segmentation Query",
12       "sql": "SELECT customer_id, CASE WHEN total_spent > 1000 THEN 'Premium' ELSE 'Standard' END AS segment FROM customer_purchases",
13       "error": null
14     },
15     {
16       "elementId": "12345678-90ab-cdef-1234-567890abcdef",
17       "name": "Failed Query Example",
18       "sql": "SELECT * FROM non_existent_table",
19       "error": "Table 'non_existent_table' does not exist"
20     }
21   ],
22   "nextPage": "eyJwYWdlIjoiMg==",
23   "total": 3
24 }

Usage notes

Retrieve the workbookId by calling the /v2/workbooks endpoint.

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.

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 - Retrieve the **workbookId** by calling the [/v2/workbooks](https://help.sigmacomputing.com/reference/list-workbooks) endpoint. ### 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.

Authentication

AuthorizationBearer

OAuth authentication of the form <token>.

Path parameters

workbookIdstringRequired

Query parameters

pagestringOptional

limitdoubleOptional

Response

The response body.

entrieslist of objects

nextPagestring or null

totaldouble