get https://api.sigmacomputing.com/v2.1/workbooks//schedules
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.