List materialization schedules for a data model

GET

/v2/dataModels/:dataModelId/materializationSchedules

GET

/v2/dataModels/:dataModelId/materializationSchedules

$ curl https://api.sigmacomputing.com/v2/dataModels/dataModelId/materializationSchedules \
>      -H "Authorization: Bearer <token>" \
>      -H "Content-Type: application/json"

200Retrieved

1 {
2   "entries": [
3     {
4       "sheetId": "sch-8f4a2c9d",
5       "elementName": "Sales Revenue Summary",
6       "schedule": {
7         "cronSpec": "0 2 * * *",
8         "timezone": "America/Los_Angeles"
9       },
10       "configuredAt": "2024-01-15T09:30:00Z",
11       "paused": false
12     },
13     {
14       "sheetId": "sch-3b7e1f4a",
15       "elementName": "Customer Churn Rate",
16       "schedule": {
17         "cronSpec": "0 0 1 * *",
18         "timezone": "UTC"
19       },
20       "configuredAt": "2024-02-10T14:45:00Z",
21       "paused": true
22     }
23   ],
24   "nextPageToken": "eyJwYWdlIjoxfQ=="
25 }

Usage notes

Retrieve the dataModelId by calling the /v2/dataModels 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.

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.

Authentication

AuthorizationBearer

OAuth authentication of the form <token>.

Path parameters

dataModelIdstringRequired

Query parameters

pageTokenstringOptional

pageSizeintegerOptional

Response

The response body.

entrieslist of objects

Array of results returned by the endpoint

nextPageTokenstring

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.