List materialization schedules for a workbook

Attention: This API endpoint is transitioning to a paginated format to enhance performance and scalability. The API will maintain backward compatibility during this transition. To start receiving paginated responses, include the query parameter limit in your requests.

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.
Recipes
📖
Workbook: Initiate Materialization Job (JavaScript)
Open Recipe
Log in to see full request history
timestatususer agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

Unique identifier of the workbook.

Query Params
string

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

number

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.

Responses

Language
Credentials
URL
Click Try It! to start a request and see the response here! Or choose an example:
application/json