Get a materialization job

View as MarkdownOpen in Claude
This endpoint retrieves details of a specific materialization job associated with a workbook by materializationId. It provides comprehensive information including status, start and completion times, which helps for monitoring and troubleshooting materialization. ### Usage notes - Retrieve the **materializationId** by calling the [/v2/workbooks/{workbookId}/materializations](https://help.sigmacomputing.com/reference/materialize-workbook-element) endpoint. ### Usage scenarios - **Job Monitoring:** Enables administrators to track the progress and status of materialization jobs, aiding in operational oversight. - **Troubleshooting:** Provides detailed information needed to diagnose and resolve issues in materialization processes. ### Best practices - Monitor materialization jobs regularly to detect and resolve issues promptly. - Use the detailed information provided by this endpoint to optimize materialization settings and performance.

Authentication

AuthorizationBearer

OAuth authentication of the form <token>.

Path parameters

workbookIdstringRequired
materializationIdstringRequired

Response

The response body.
materializationIdstring
statusstring
startedAtdatetime
readyAtdatetime
expiredAtdatetime
errorstring