post https://api.sigmacomputing.com/v2/workbooks//materializations
This endpoint runs a scheduled materialization for a specific element within a workbook. Materialization processes the data of the specified element, allowing the data to be stored or cached for optimized access and performance.
For more details on materialization, see Materialization.
Usage notes
- The materialization schedule for the specified element must be created beforehand.
- Retrieve the sheetId by calling the /v2/workbooks/{workbookId}/materialization-schedules endpoint.
- Retrieve the workbookId by calling the /v2/workbooks endpoint.
Usage scenarios
- Performance optimization: Use this endpoint to improve response times for frequently accessed workbook elements.
- Data refresh: Allows users to manually (programmatically) refresh the data of specific workbook elements to ensure that the latest data is available for analysis and reporting.
Best practices
- Prioritize materialization for elements that are heavily used or form critical components of business reports.
- Monitor the performance impacts of materialization and adjust strategies as necessary to optimize resource usage and response times.
Recipes
📖
Workbook: Initiate Materialization Job (JavaScript)
Open Recipe