SIsigmacomputing
Workbooks

Get a materialization job

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

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.
get/v2/workbooks/{workbookId}/materializations/{materializationId}

Request

  • Base URL
    https://api.sigmacomputing.com
  • Auth
    HTTP bearer

Path parameters

workbookIdstring required

Unique identifier of the workbook.

materializationIdstring required

Unique identifier of the materialization job

Response

The response body.

materializationIdstring required
statusstring required
startedAtstring date-time
readyAtstring date-time
expiredAtstring date-time
errorstring

Changes

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