> For clean Markdown of any page, append .md to the page URL. > For a complete documentation index, see https://help.sigmacomputing.com/llms.txt. > For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://help.sigmacomputing.com/_mcp/server. # List materialization schedules for a data model GET https://api.sigmacomputing.com/v2/dataModels/{dataModelId}/materializationSchedules This endpoint retrieves a list of all materialization schedules associated with a data model. Each schedule details when and how often specific data model elements are automatically materialized to optimize performance and data freshness. ### Usage notes - Retrieve the **dataModelId** by calling the [/v2/dataModels](https://help.sigmacomputing.com/reference/list-data-models) endpoint. - To retrieve additional pages of results, use the response of the `nextPageToken` parameter as the `pageToken` 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. Reference: https://help.sigmacomputing.com/reference/list-data-model-materialization-schedules ## OpenAPI Specification ```yaml openapi: 3.1.0 info: title: sigma-rest-api version: 1.0.0 paths: /v2/dataModels/{dataModelId}/materializationSchedules: get: operationId: listDataModelMaterializationSchedules summary: List materialization schedules for a data model description: |2- This endpoint retrieves a list of all materialization schedules associated with a data model. Each schedule details when and how often specific data model elements are automatically materialized to optimize performance and data freshness. ### Usage notes - Retrieve the **dataModelId** by calling the [/v2/dataModels](https://help.sigmacomputing.com/reference/list-data-models) endpoint. - To retrieve additional pages of results, use the response of the `nextPageToken` parameter as the `pageToken` 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. tags: - dataModels parameters: - name: dataModelId in: path required: true schema: type: string - name: pageToken in: query required: false schema: type: string - name: pageSize in: query required: false schema: type: integer - name: Authorization in: header description: OAuth authentication required: true schema: type: string responses: '200': description: The response body. content: application/json: schema: $ref: >- #/components/schemas/dataModels_listDataModelMaterializationSchedules_Response_200 servers: - url: https://api.sigmacomputing.com description: Server for GCP (US) hosted organizations - url: https://api.sa.gcp.sigmacomputing.com description: Server for GCP (KSA) hosted organizations - url: https://aws-api.sigmacomputing.com description: Server for AWS US (West) hosted organizations - url: https://api.us-a.aws.sigmacomputing.com description: Server for AWS US (East) hosted organizations - url: https://api.ca.aws.sigmacomputing.com description: Server for AWS Canada hosted organizations - url: https://api.eu.aws.sigmacomputing.com description: Server for AWS Europe hosted organizations - url: https://api.au.aws.sigmacomputing.com description: Server for AWS Australia and APAC hosted organizations - url: https://api.uk.aws.sigmacomputing.com description: Server for AWS UK hosted organizations - url: https://api.us.azure.sigmacomputing.com description: Server for Azure US hosted organizations - url: https://api.eu.azure.sigmacomputing.com description: Server for Azure Europe hosted organizations - url: https://api.ca.azure.sigmacomputing.com description: Server for Azure Canada hosted organizations - url: https://api.uk.azure.sigmacomputing.com description: Server for Azure United Kingdom hosted organizations - url: https://api.au.azure.sigmacomputing.com description: Server for Azure Australia hosted organizations components: schemas: V2DataModelsDataModelIdMaterializationSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsSchedule: type: object properties: cronSpec: type: string description: Cron expression to use for the schedule timezone: type: string description: Timezone code, for example, PST title: >- V2DataModelsDataModelIdMaterializationSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsSchedule V2DataModelsDataModelIdMaterializationSchedulesGetResponsesContentApplicationJsonSchemaEntriesItems: type: object properties: sheetId: type: string description: Identifier of the materialization schedule for the element elementName: type: string schedule: oneOf: - $ref: >- #/components/schemas/V2DataModelsDataModelIdMaterializationSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsSchedule - type: 'null' configuredAt: type: string format: date-time paused: type: boolean required: - sheetId - elementName - schedule - configuredAt - paused title: >- V2DataModelsDataModelIdMaterializationSchedulesGetResponsesContentApplicationJsonSchemaEntriesItems dataModels_listDataModelMaterializationSchedules_Response_200: type: object properties: entries: type: array items: $ref: >- #/components/schemas/V2DataModelsDataModelIdMaterializationSchedulesGetResponsesContentApplicationJsonSchemaEntriesItems description: Array of results returned by the endpoint nextPageToken: type: string description: >- A string that can be passed to the `pageToken` parameter in the next request to fetch the next page of results. Not present in the last page of results. **Must be treated as an opaque string.** required: - entries title: dataModels_listDataModelMaterializationSchedules_Response_200 securitySchemes: OAuth: type: http scheme: bearer description: OAuth 2.0 authentication ``` ## Examples **Request** ```json {} ``` **Response** ```json { "entries": [ { "sheetId": "sch-8f4a2c9d", "elementName": "Sales Revenue Summary", "schedule": { "cronSpec": "0 2 * * *", "timezone": "America/Los_Angeles" }, "configuredAt": "2024-01-15T09:30:00Z", "paused": false }, { "sheetId": "sch-3b7e1f4a", "elementName": "Customer Churn Rate", "schedule": { "cronSpec": "0 0 1 * *", "timezone": "UTC" }, "configuredAt": "2024-02-10T14:45:00Z", "paused": true } ], "nextPageToken": "eyJwYWdlIjoxfQ==" } ``` **SDK Code** ```python import requests url = "https://api.sigmacomputing.com/v2/dataModels/dataModelId/materializationSchedules" payload = {} headers = { "Authorization": ".", "Content-Type": "application/json" } response = requests.get(url, json=payload, headers=headers) print(response.json()) ``` ```javascript const url = 'https://api.sigmacomputing.com/v2/dataModels/dataModelId/materializationSchedules'; const options = { method: 'GET', headers: {Authorization: '.', 'Content-Type': 'application/json'}, body: '{}' }; try { const response = await fetch(url, options); const data = await response.json(); console.log(data); } catch (error) { console.error(error); } ``` ```go package main import ( "fmt" "strings" "net/http" "io" ) func main() { url := "https://api.sigmacomputing.com/v2/dataModels/dataModelId/materializationSchedules" payload := strings.NewReader("{}") req, _ := http.NewRequest("GET", url, payload) req.Header.Add("Authorization", ".") req.Header.Add("Content-Type", "application/json") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := io.ReadAll(res.Body) fmt.Println(res) fmt.Println(string(body)) } ``` ```ruby require 'uri' require 'net/http' url = URI("https://api.sigmacomputing.com/v2/dataModels/dataModelId/materializationSchedules") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true request = Net::HTTP::Get.new(url) request["Authorization"] = '.' request["Content-Type"] = 'application/json' request.body = "{}" response = http.request(request) puts response.read_body ``` ```java import com.mashape.unirest.http.HttpResponse; import com.mashape.unirest.http.Unirest; HttpResponse response = Unirest.get("https://api.sigmacomputing.com/v2/dataModels/dataModelId/materializationSchedules") .header("Authorization", ".") .header("Content-Type", "application/json") .body("{}") .asString(); ``` ```php request('GET', 'https://api.sigmacomputing.com/v2/dataModels/dataModelId/materializationSchedules', [ 'body' => '{}', 'headers' => [ 'Authorization' => '.', 'Content-Type' => 'application/json', ], ]); echo $response->getBody(); ``` ```csharp using RestSharp; var client = new RestClient("https://api.sigmacomputing.com/v2/dataModels/dataModelId/materializationSchedules"); var request = new RestRequest(Method.GET); request.AddHeader("Authorization", "."); request.AddHeader("Content-Type", "application/json"); request.AddParameter("application/json", "{}", ParameterType.RequestBody); IRestResponse response = client.Execute(request); ``` ```swift import Foundation let headers = [ "Authorization": ".", "Content-Type": "application/json" ] let parameters = [] as [String : Any] let postData = JSONSerialization.data(withJSONObject: parameters, options: []) let request = NSMutableURLRequest(url: NSURL(string: "https://api.sigmacomputing.com/v2/dataModels/dataModelId/materializationSchedules")! as URL, cachePolicy: .useProtocolCachePolicy, timeoutInterval: 10.0) request.httpMethod = "GET" request.allHTTPHeaderFields = headers request.httpBody = postData as Data let session = URLSession.shared let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in if (error != nil) { print(error as Any) } else { let httpResponse = response as? HTTPURLResponse print(httpResponse) } }) dataTask.resume() ```