List scheduled workbook exports (Paginated)

GET

/v2.1/workbooks/:workbookId/schedules

GET

/v2.1/workbooks/:workbookId/schedules

$ curl https://api.sigmacomputing.com/v2.1/workbooks/workbookId/schedules \
>      -H "Authorization: Bearer <token>"

200Retrieved

1 {
2   "entries": [
3     {
4       "scheduledNotificationId": "string",
5       "workbookId": "string",
6       "schedule": {
7         "cronSpec": "string",
8         "timezone": "string"
9       },
10       "configV2": {
11         "title": "string",
12         "messageBody": "string",
13         "notificationAttachments": [
14           {
15             "formatOptions": {
16               "type": "CSV"
17             },
18             "chartId": "string",
19             "workbookExportSource": {
20               "elementId": "string",
21               "type": "element"
22             }
23           }
24         ],
25         "includeLink": true,
26         "runAsRecipient": true,
27         "attachmentSettings": {
28           "mergePdfAttachments": true,
29           "zipAttachments": true
30         },
31         "conditionOptions": {
32           "type": "always"
33         },
34         "alertConfig": {
35           "window": "alltime",
36           "volume": 1.1
37         },
38         "notificationName": "string",
39         "dashboardSettings": {
40           "filters": [
41             {
42               "id": "string",
43               "filterStr": "string"
44             }
45           ],
46           "variableValues": {}
47         },
48         "dynamicExportSettings": {
49           "variables": {}
50         },
51         "dynamicRecipientSettings": {
52           "sourceNodeId": "string",
53           "recipientColumnId": "string"
54         },
55         "rowLimit": 1.1,
56         "workbookVariant": {
57           "tagId": "string",
58           "exploreKey": "string",
59           "bookmarkId": "string"
60         },
61         "embedOpts": {
62           "embedId": "string",
63           "evalConnectionId": "string"
64         },
65         "formatting": {
66           "pivotHeaderStyle": "merged"
67         }
68       },
69       "isSuspended": true,
70       "ownerId": "string",
71       "lastUpdatedByUser": "string",
72       "disabledAt": "2024-01-15T09:30:00Z",
73       "disabledBy": "string",
74       "createdBy": "string",
75       "updatedBy": "string",
76       "createdAt": "2024-01-15T09:30:00Z",
77       "updatedAt": "2024-01-15T09:30:00Z"
78     }
79   ],
80   "nextPage": "string",
81   "total": 1.1,
82   "hasMore": true
83 }

Attention: This API endpoint uses pagination by default.

This endpoint retrieves a list of all scheduled exports for a specified workbook. These schedules represent planned events that can trigger exports based on various conditions and timings.

Usage Notes

The workbookId in the path parameter identifies the workbook whose scheduled exports are to be listed. Retrieve the workbookId by calling the /v2/workbooks endpoint.
Use pagination query parameters to manage the volume of data returned by this endpoint.

Usage Scenarios

Schedule Overview: Administrators or users with appropriate permissions can monitor and review all active scheduled exports associated with a workbook.
Audit and Compliance: This functionality is useful for auditing purposes to ensure that all scheduled operations are configured correctly and comply with organizational policies.

Best Practices

Implement client-side handling to manage paginated data effectively, especially in cases where a workbook has a large number of scheduled exports.
Regularly audit schedules to keep them up-to-date and aligned with the current needs and workflows.

**Attention:** This API endpoint uses pagination by default. This endpoint retrieves a list of all scheduled exports for a specified workbook. These schedules represent planned events that can trigger exports based on various conditions and timings. ### Usage Notes - The **workbookId** in the path parameter identifies the workbook whose scheduled exports are to be listed. Retrieve the **workbookId** by calling the [/v2/workbooks](https://help.sigmacomputing.com/reference/list-workbooks) endpoint. - Use pagination query parameters to manage the volume of data returned by this endpoint. ### Usage Scenarios - **Schedule Overview:** Administrators or users with appropriate permissions can monitor and review all active scheduled exports associated with a workbook. - **Audit and Compliance:** This functionality is useful for auditing purposes to ensure that all scheduled operations are configured correctly and comply with organizational policies. ### Best Practices - Implement client-side handling to manage paginated data effectively, especially in cases where a workbook has a large number of scheduled exports. - Regularly audit schedules to keep them up-to-date and aligned with the current needs and workflows.

Authentication

AuthorizationBearer

OAuth authentication of the form <token>.

Path parameters

workbookIdstringRequired

Query parameters

pagestringOptional

limitdoubleOptional

Response

The response body.

entrieslist of objects

Array of results returned by the endpoint

nextPagestring or null

Returns a string that can be used as the page parameter in the next request to fetch the next page of results. The last page of results returns null.

totaldouble

Total number of results. Useful to determine if there is a need to paginate.

hasMoreboolean

[Deprecated] Indicates whether more results are available.