SIsigmacomputing
Workbooks

List materialization schedules (Paginated)

Attention: This API endpoint uses pagination by default.

This endpoint retrieves a list of all materialization schedules associated with a workbook. Each schedule details when and how often specific workbook elements are automatically materialized to optimize performance and data freshness.

Usage notes

  • Retrieve the workbookId by calling the /v2/workbooks endpoint.
  • To retrieve additional pages of results, use the response of the nextPage parameter as the page query parameter in the following request.

Usage scenarios

  • Monitoring and management: Administrators can monitor and manage the schedules for materialization to ensure optimal system performance.
  • Audit and review: Periodic reviews of materialization schedules can help in assessing the efficiency of data processes and making necessary adjustments.

Best practices

  • Regularly review materialization schedules to align them with current data usage patterns and business needs.
  • Use pagination to manage large sets of data and improve response times of API calls.
get/v2.1/workbooks/{workbookId}/materialization-schedules

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

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.

totalnumber double

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

hasMoreboolean

[Deprecated] Indicates whether more results are available.

Changes

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