The Model Monitoring API gives you programmatic access to the Model Monitor.
To invoke these APIs, you must pass the API token in the header. See API Token for more information.
Domino Model Monitoring can only ingest prediction data for Domino endpoints in the form of Domino Datasets captured using Domino’s prediction capture library. To ingest different data types, create a new model in Domino Model Monitor and use a Model Monitor Data Source.
DatasetJob
getDatasetJobs
POST
/model-monitor/v2/api/{model_id}/dataset-jobs
Description
Get the list of jobs associated with a model
Parameters
| Name | Description | Required | Type | In | Example |
|---|---|---|---|---|---|
model_id | Identifier of the model | string | path |
Body Parameter
| Name | Description | Required |
|---|---|---|
jobHistoryRequest | jobHistoryRequest |
Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | Gets the list of jobs for the model | |
| 404 | Dataset not found for the given identifier. | |
| 500 | Internal server error, check server logs. |
getDatasetTimeline
GET
/model-monitor/v2/api/model/{model_id}/dataset-timeline
Description
Gets the dataset ingestion timeline
Parameters
| Name | Description | Required | Type | In | Example |
|---|---|---|---|---|---|
model_id | string | path | |||
start_date | number | query | |||
end_date | number | query |
Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | Gets the dataset ingestion timeline | |
| 400 | Bad request input data. | |
| 403 | Forbidden. The endpoint enforces permissions. | |
| 500 | Internal server error, check server logs. |
DataSource
createDataSource
PUT
/model-monitor/v2/api/datasource
Description
Create or delete a datasource.
Body Parameter
| Name | Description | Required |
|---|---|---|
dataSourceRequest | dataSourceRequest |
Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | Data source added/updated successfully | |
| 400 | Bad request input data. | |
| 403 | Forbidden. The endpoint enforces permissions. | |
| 405 | Method not allowed. | |
| 500 | Internal server error, check server logs. |
deleteDataSource
DELETE
/model-monitor/v2/api/datasource
Description
Create or delete a datasource.
Parameters
| Name | Description | Required | Type | In | Example |
|---|---|---|---|---|---|
datasource_id | string | query |
Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | The data source object that was deleted. | |
| 400 | Bad request input data. | |
| 403 | Forbidden. The endpoint enforces permissions. | |
| 405 | Method not allowed. | |
| 500 | Internal server error, check server logs. |
Model
getPredictionTraffic
GET
/model-monitor/v2/api/model/get-prediction-traffic
Description
Gets the model prediction traffic
Parameters
| Name | Description | Required | Type | In | Example |
|---|---|---|---|---|---|
model_ids | string | query | |||
start_date | number | query | |||
end_date | number | query |
Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | Gets the model prediction traffic | |
| 400 | Bad request input data. | |
| 403 | Forbidden. The endpoint enforces permissions. | |
| 500 | Internal server error, check server logs. |
getGroundTruthTraffic
GET
/model-monitor/v2/api/model/{model_id}/traffic/ground-truth
Description
Gets the model's ground truth traffic for matched labels
Parameters
| Name | Description | Required | Type | In | Example |
|---|---|---|---|---|---|
model_id | string | path | |||
startTimestamp | number | query | |||
endTimestamp | number | query |
Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | Gets the ground truth traffic based on number of ground truth labels that matched prediction data. | |
| 400 | Bad request input data. | |
| 403 | Forbidden. The endpoint enforces permissions. | |
| 404 | Model not found. | |
| 500 | Internal server error, check server logs. |
registerDatasetConfig
PUT
/model-monitor/v2/api/model/{model_id}/register-dataset/{dataset_type}
Description
Dataset registration to a model.
Parameters
| Name | Description | Required | Type | In | Example |
|---|---|---|---|---|---|
model_id | string | path | |||
dataset_type | string | path | prediction ground_truth |
Body Parameter
| Name | Description | Required |
|---|---|---|
datasetRegistrationConfigRequest | datasetRegistrationConfigRequest |
Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | Successfully registered dataset to the Model. | |
| 400 | Bad request input data. | |
| 403 | Forbidden. The endpoint enforces permissions. | |
| 405 | Method not allowed. | |
| 500 | Internal server error, check server logs. |
getModelById
GET
/model-monitor/v2/api/model
Description
Gets a DMM model either via a unique model identifier or via a unique combination of workbench model id and workbench model version id
Parameters
| Name | Description | Required | Type | In | Example |
|---|---|---|---|---|---|
model_id | string | query | |||
workbench_model_version_id | string | query |
Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | Successfully fetched the Model. | |
| 400 | Bad request input data. | |
| 403 | Forbidden. The endpoint enforces permissions. | |
| 404 | Model not found. | |
| 405 | Method not allowed. | |
| 500 | Internal server error, check server logs. |
updateModelById
PATCH
/model-monitor/v2/api/model
Description
Update one or more editable attributes of a DMM model.
Parameters
| Name | Description | Required | Type | In | Example |
|---|---|---|---|---|---|
model_id | string | query |
Body Parameter
| Name | Description | Required |
|---|---|---|
modelUpdateRequest | modelUpdateRequest |
Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | Successfully updated the model. | |
| 400 | Bad request input data. | |
| 403 | Forbidden. The endpoint enforces permissions. | |
| 404 | Model not found. | |
| 405 | Method not allowed. | |
| 500 | Internal server error, check server logs. |
registerModelThroughConfig
PUT
/model-monitor/v2/api/model
Description
Model Operations.
Body Parameter
| Name | Description | Required |
|---|---|---|
modelRegistrationConfigRequest | modelRegistrationConfigRequest |
Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | Successfully registered the Model. | |
| 400 | Bad request input data. | |
| 403 | Forbidden. The endpoint enforces permissions. | |
| 405 | Method not allowed. | |
| 500 | Internal server error, check server logs. |
deleteModelById
DELETE
/model-monitor/v2/api/model
Description
Model Operations.
Parameters
| Name | Description | Required | Type | In | Example |
|---|---|---|---|---|---|
model_id | string | query |
Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | Successfully deleted the Model. | |
| 400 | Bad request input data. | |
| 403 | Forbidden. The endpoint enforces permissions. | |
| 404 | Model not found. | |
| 405 | Method not allowed. | |
| 409 | Conflict with model requested. | |
| 500 | Internal server error, check server logs. |
listModels
GET
/model-monitor/v2/api/models
Description
Parameters
| Name | Description | Required | Type | In | Example |
|---|---|---|---|---|---|
pageNumber | integer | query | |||
pageSize | integer | query | |||
numberOfLastChecksToFetch | integer | query | |||
searchQuery | string | query | |||
tagsQuery | comma-separated values of tag ids to filter by | string | query | ||
sortOn | string | query | created_at updated_at | ||
sortOrder | integer | query | 1 -1 | ||
modelType | Undefined | query |
Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | Successfully fetched the Model. | |
| 400 | Bad request input data. | |
| 403 | Forbidden. The endpoint enforces permissions. | |
| 405 | Method not allowed. | |
| 500 | Internal server error, check server logs. |
getModelSummary
GET
/model-monitor/v2/api/get_model_summary
Description
Gets a DMM model summary either via a unique model identifier or via a unique combination of workbench model id and workbench model version id
Parameters
| Name | Description | Required | Type | In | Example |
|---|---|---|---|---|---|
model_id | string | query | |||
workbench_model_version_id | string | query |
Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | Successfully fetched the Model summary. | |
| 400 | Bad request input data. | |
| 403 | Forbidden. The endpoint enforces permissions. | |
| 404 | Model not found. | |
| 405 | Method not allowed. | |
| 500 | Internal server error, check server logs. |
getModelVariablesSummary
GET
/model-monitor/v2/api/model/{model_id}/variables/summary
Description
Get the model's variables summary list
Parameters
| Name | Description | Required | Type | In | Example |
|---|---|---|---|---|---|
model_id | string | path |
Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | Successfully fetched the Model. | |
| 400 | Bad request input data. | |
| 403 | Forbidden. The endpoint enforces permissions. | |
| 404 | Model not found. | |
| 405 | Method not allowed. | |
| 500 | Internal server error, check server logs. |
updateModelVisibility
PUT
/model-monitor/v2/api/model/{model_id}/visibility
Description
Updates the visibility of a standalone DMM model
Parameters
| Name | Description | Required | Type | In | Example |
|---|---|---|---|---|---|
model_id | string | path | |||
visibility | Undefined | query |
Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | Successfully updated model visibility. | |
| 400 | Bad request input data. | |
| 403 | Forbidden. The endpoint enforces permissions. | |
| 404 | Model not found. | |
| 405 | Method not allowed. | |
| 500 | Internal server error, check server logs. |
getModelCollaborators
GET
/model-monitor/v2/api/model/{model_id}/collaborators
Description
Fetches all collaborators for a standalone DMM model
Parameters
| Name | Description | Required | Type | In | Example |
|---|---|---|---|---|---|
model_id | string | path |
Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | Successfully fetched the model's collaborators. | |
| 400 | Bad request input data. | |
| 403 | Forbidden. The endpoint enforces permissions. | |
| 404 | Model not found. | |
| 405 | Method not allowed. | |
| 500 | Internal server error, check server logs. |
addCollaborators
POST
/model-monitor/v2/api/model/{model_id}/collaborators
Description
Adds collaborators to a standalone DMM model
Parameters
| Name | Description | Required | Type | In | Example |
|---|---|---|---|---|---|
model_id | string | path |
Body Parameter
| Name | Description | Required |
|---|---|---|
collaboratorRequestArray | collaboratorRequestArray |
Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | Successfully add a collaborator to model. | |
| 400 | Bad request input data. | |
| 403 | Forbidden. The endpoint enforces permissions. | |
| 404 | Model not found. | |
| 405 | Method not allowed. | |
| 500 | Internal server error, check server logs. |
updateCollaboratorRole
PUT
/model-monitor/v2/api/model/{model_id}/collaborators
Description
Updates an existing collaborator for a standalone DMM model
Parameters
| Name | Description | Required | Type | In | Example |
|---|---|---|---|---|---|
model_id | string | path |
Body Parameter
| Name | Description | Required |
|---|---|---|
collaboratorRequest | collaboratorRequest |
Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | Successfully updated a model collaborator. | |
| 400 | Bad request input data. | |
| 403 | Forbidden. The endpoint enforces permissions. | |
| 404 | Model not found. | |
| 405 | Method not allowed. | |
| 500 | Internal server error, check server logs. |
deleteCollaborator
DELETE
/model-monitor/v2/api/model/{model_id}/collaborators
Description
Deletes an existing collaborator for a standalone DMM model
Parameters
| Name | Description | Required | Type | In | Example |
|---|---|---|---|---|---|
model_id | string | path | |||
collaborator_id | string | query |
Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | Successfully removed a collaborator from a model. | |
| 400 | Bad request input data. | |
| 403 | Forbidden. The endpoint enforces permissions. | |
| 404 | Model not found. | |
| 405 | Method not allowed. | |
| 500 | Internal server error, check server logs. |
listTags
GET
/model-monitor/v2/api/model/{model_id}/tags
Description
List tags that can be added to a DMM model
Parameters
| Name | Description | Required | Type | In | Example |
|---|---|---|---|---|---|
model_id | string | path | |||
searchQuery | string | query |
Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | List of tags that can be added to the model | |
| 400 | Bad request input data. | |
| 403 | Forbidden. The endpoint enforces permissions. | |
| 404 | Model not found. | |
| 405 | Method not allowed. | |
| 500 | Internal server error, check server logs. |
addTags
POST
/model-monitor/v2/api/model/{model_id}/tags
Description
Adds tags to a DMM model
Parameters
| Name | Description | Required | Type | In | Example |
|---|---|---|---|---|---|
model_id | string | path |
Body Parameter
| Name | Description | Required |
|---|---|---|
tagsRequest | tagsRequest |
Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | Successfully add a tag to a model. | |
| 400 | Bad request input data. | |
| 403 | Forbidden. The endpoint enforces permissions. | |
| 404 | Model not found. | |
| 405 | Method not allowed. | |
| 500 | Internal server error, check server logs. |
removeTag
DELETE
/model-monitor/v2/api/model/{model_id}/tags
Description
Remove a tag from a DMM model
Parameters
| Name | Description | Required | Type | In | Example |
|---|---|---|---|---|---|
model_id | string | path | |||
tagId | string | query |
Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | Successfully removed a tag from a model. | |
| 400 | Bad request input data. | |
| 403 | Forbidden. The endpoint enforces permissions. | |
| 404 | Model not found. | |
| 405 | Method not allowed. | |
| 500 | Internal server error, check server logs. |
ModelTag
archiveTag
PATCH
/model-monitor/v2/api/model-tag/{tag_id}/archive
Description
Archive a model tag
Parameters
| Name | Description | Required | Type | In | Example |
|---|---|---|---|---|---|
tag_id | string | path |
Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | Successfully archive a model tag | |
| 400 | Bad request input data. | |
| 403 | Forbidden. The endpoint enforces permissions. | |
| 404 | Model not found. | |
| 405 | Method not allowed. | |
| 500 | Internal server error, check server logs. |
unarchiveTag
PATCH
/model-monitor/v2/api/model-tag/{tag_id}/unarchive
Description
Unarchive a model tag
Parameters
| Name | Description | Required | Type | In | Example |
|---|---|---|---|---|---|
tag_id | string | path |
Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | Successfully unarchive a model tag. | |
| 400 | Bad request input data. | |
| 403 | Forbidden. The endpoint enforces permissions. | |
| 404 | Model not found. | |
| 405 | Method not allowed. | |
| 500 | Internal server error, check server logs. |
ModelDrift
analyzeDrift
POST
/model-monitor/v2/api/model/{model_id}/analyse-drift
Description
Returns drift analysis for the model based on the user's config (or model's scheduler config). The endpoint is behind the old backend's auth mechanism.
Parameters
| Name | Description | Required | Type | In | Example |
|---|---|---|---|---|---|
model_id | Identifier for the model to be updated. | string | path |
Body Parameter
| Name | Description | Required |
|---|---|---|
driftAnalyzeRequest | driftAnalyzeRequest |
Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | The drift analyze query was done successfully. | |
| 204 | Empty response. | |
| 400 | Bad request input data. | |
| 403 | Forbidden. The endpoint enforces permissions. | |
| 500 | Internal server error, check server logs. |
getDriftUserQuery
GET
/model-monitor/v2/api/model/{model_id}/drift-user-query
Description
Returns drift scheduler config for the model. The endpoint is behind the old backend's auth mechanism.
Parameters
| Name | Description | Required | Type | In | Example |
|---|---|---|---|---|---|
model_id | Identifier for the model to be updated. | string | path |
Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | The drift scheduler query was generated successfully. | |
| 403 | Forbidden. The endpoint enforces permissions. | |
| 500 | Internal server error, check server logs. |
getDriftSchedulerQuery
GET
/model-monitor/v2/api/model/{model_id}/drift-scheduler-query
Description
Returns drift scheduler config for the model.
Parameters
| Name | Description | Required | Type | In | Example |
|---|---|---|---|---|---|
model_id | Identifier for the model to be updated. | string | path |
Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | The drift scheduler query was generated successfully. | |
| 403 | Forbidden. The endpoint enforces permissions. | |
| 500 | Internal server error, check server logs. |
getModelColumnDriftTrend
GET
/model-monitor/v2/api/model/{model_id}/{column_id}/drift-trend
Description
Returns drift trend for the model's column. The endpoint is behind the old backend's auth mechanism.
Parameters
| Name | Description | Required | Type | In | Example |
|---|---|---|---|---|---|
model_id | Identifier for the model for the trends | string | path | ||
column_id | Identifier for the column. | string | path | ||
startDate | Start time for the data used for the query. | number | query | ||
endDate | End time for the data used for the query. | number | query | ||
algorithm | Algorithm function used for the check query | string | query |
Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | The drift trend fetch query was done successfully. | |
| 400 | Bad request input data. | |
| 403 | Forbidden. The endpoint enforces permissions. | |
| 500 | Internal server error, check server logs. |
saveSchedulerQuery
POST
/model-monitor/v2/api/model/{model_id}/save-scheduler-query
Description
Saves drift scheduler config for the model. The endpoint is behind the old backend's auth mechanism.
Parameters
| Name | Description | Required | Type | In | Example |
|---|---|---|---|---|---|
model_id | Identifier for the model to be updated. | string | path |
Body Parameter
| Name | Description | Required |
|---|---|---|
featureQueryConfig | featureQueryConfig |
Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | The drift scheduler query was generated successfully. | |
| 403 | Forbidden. The endpoint enforces permissions. | |
| 500 | Internal server error, check server logs. |
getDriftScheduleChecksHistory
GET
/model-monitor/v2/api/model/{model_id}/drift-schedule-checks-history
Description
Gets the model timeline data for drift schedule history page
Parameters
| Name | Description | Required | Type | In | Example |
|---|---|---|---|---|---|
model_id | string | path | |||
start_date | string | query | |||
end_date | string | query |
Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | Gets the model timeline data | |
| 400 | Bad request input data. | |
| 403 | Forbidden. The endpoint enforces permissions. | |
| 500 | Internal server error, check server logs. |
getScheduledCheckDriftData
GET
/model-monitor/v2/api/model/{model_id}/{scheduler_id}/scheduled-check-drift-data
Description
Get scheduled check drift data
Parameters
| Name | Description | Required | Type | In | Example |
|---|---|---|---|---|---|
model_id | string | path | |||
scheduler_id | string | path | |||
sortOrder | string | query | |||
sortOn | string | query | |||
pageNumber | string | query | |||
pageSize | string | query | |||
searchQuery | string | query |
Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | Gets the model timeline data | |
| 400 | Bad request input data. | |
| 403 | Forbidden. The endpoint enforces permissions. | |
| 500 | Internal server error, check server logs. |
ModelQuality
analyzeModelQuality
POST
/model-monitor/v2/api/model/{model_id}/analyze-model-quality
Description
Returns MQ analyze for the model based on the user's config (or model's default config).
Parameters
| Name | Description | Required | Type | In | Example |
|---|---|---|---|---|---|
model_id | Identifier for the model to be updated. | string | path |
Body Parameter
| Name | Description | Required |
|---|---|---|
modelQualityQueryRequest | modelQualityQueryRequest |
Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | The MQ analyze query was done successfully. | |
| 204 | Empty response. | |
| 400 | Bad request input data. | |
| 403 | Forbidden. The endpoint enforces permissions. | |
| 500 | Internal server error, check server logs. |
getModelQualityUserQuery
GET
/model-monitor/v2/api/model/{model_id}/model-quality-user-query
Description
Returns model quality user config for the model.
Parameters
| Name | Description | Required | Type | In | Example |
|---|---|---|---|---|---|
model_id | Identifier for the model. | string | path |
Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | The model quality user query was fetched successfully. | |
| 204 | The model quality user query does not exist for the user. | |
| 400 | Bad request input data. | |
| 403 | Forbidden. The endpoint enforces permissions. | |
| 500 | Internal server error, check server logs. |
getModelQualityTrend
GET
/model-monitor/v2/api/model/{model_id}/model-quality-trend
Description
Returns model quality trend for the model for specific model quality metric.
Parameters
| Name | Description | Required | Type | In | Example |
|---|---|---|---|---|---|
model_id | Identifier of the model. | string | path | ||
startTimestamp | Start time for the data used for the query. | number | query | ||
endTimestamp | End time for the data used for the query. | number | query | ||
metricName | Metric used for the trend. | string | query |
Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | The model quality trend was fetched successfully. | |
| 400 | Bad request input data. | |
| 403 | Forbidden. The endpoint enforces permissions. | |
| 500 | Internal server error, check server logs. |
getModelQualitySchedulerQuery
GET
/model-monitor/v2/api/model/{model_id}/model-quality-scheduler-query
Description
Returns model quality scheduler query for the model.
Parameters
| Name | Description | Required | Type | In | Example |
|---|---|---|---|---|---|
model_id | Identifier for the model. | string | path |
Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | The model quality scheduler query was fetched successfully. | |
| 400 | Bad request input data. | |
| 403 | Forbidden. The endpoint enforces permissions. | |
| 404 | Model Quality Scheduler Query not found. | |
| 500 | Internal server error, check server logs. |
saveModelQualitySchedulerQuery
POST
/model-monitor/v2/api/model/{model_id}/model-quality-scheduler-query
Description
Returns model quality scheduler query for the model.
Parameters
| Name | Description | Required | Type | In | Example |
|---|---|---|---|---|---|
model_id | Identifier for the model. | string | path |
Body Parameter
| Name | Description | Required |
|---|---|---|
modelQualityQueryRequest | modelQualityQueryRequest |
Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | The model quality scheduler query was saved successfully. | |
| 400 | Bad request input data. | |
| 403 | Forbidden. The endpoint enforces permissions. | |
| 404 | Model Quality Scheduler Query not found. | |
| 500 | Internal server error, check server logs. |
getModelQualityScheduledChecksTimeline
GET
/model-monitor/v2/api/model/{model_id}/model-quality-scheduled-checks-history
Description
Gets the model timeline data for model quality schedule history page
Parameters
| Name | Description | Required | Type | In | Example |
|---|---|---|---|---|---|
model_id | string | path | |||
start_date | string | query | |||
end_date | string | query |
Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | Gets the model timeline data | |
| 400 | Bad request input data. | |
| 403 | Forbidden. The endpoint enforces permissions. | |
| 404 | Model not found or is deleted. | |
| 500 | Internal server error, check server logs. |
getModelQualityScheduledCheckData
GET
/model-monitor/v2/api/model/{scheduled_check_id}/model-quality-scheduled-check-data
Description
Gets the model scheduled check data for MQ schedule history page for the passed scheduled check id
Parameters
| Name | Description | Required | Type | In | Example |
|---|---|---|---|---|---|
scheduled_check_id | string | path |
Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | Gets the scheduled check data | |
| 400 | Bad request input data. | |
| 403 | Forbidden. The endpoint enforces permissions. | |
| 404 | Data for passed Scheduled Check Id not found. | |
| 500 | Internal server error, check server logs. |
Workbench
Get summary for workbench model versions
GET
/model-monitor/v2/api/workbench/model/version/summary
Description
Parameters
| Name | Description | Required | Type | In | Example |
|---|---|---|---|---|---|
model_version_ids | a string of comma separated workbench model version ids. | string | query | ||
start_date | number | query | |||
end_date | number | query |
Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | Model summaries were fetched successfully. | |
| 400 | Bad request input data. | |
| 403 | Forbidden. The endpoint enforces permissions. | |
| 405 | Method not allowed. | |
| 500 | Internal server error, check server logs. |
DefaultSettings
Get drift default settings
GET
/model-monitor/v2/api/setting/default/drift
Description
Parameters
| Name | Description | Required | Type | In | Example |
|---|---|---|---|---|---|
is_active | Whether to fetch only the active drift default setting or not. | boolean | query |
Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | Drift default settings fetched successfully. | |
| 400 | Bad request input data. | |
| 403 | Forbidden. The endpoint enforces permissions. | |
| 405 | Method not allowed. | |
| 500 | Internal server error, check server logs. |
Update the drift default settings.
PUT
/model-monitor/v2/api/setting/default/drift
Description
Body Parameter
| Name | Description | Required |
|---|---|---|
driftDefaultSettingUpdateRequestBodyItemArray | driftDefaultSettingUpdateRequestBodyItemArray |
Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | Drift Default settings updated successfully. | |
| 400 | Bad request input data. | |
| 403 | Forbidden. The endpoint enforces permissions. | |
| 405 | Method not allowed. | |
| 500 | Internal server error, check server logs. |
Get model quality metric default settings
GET
/model-monitor/v2/api/setting/default/metric
Description
Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | Model Quality Metric default settings fetched successfully. | |
| 400 | Bad request input data. | |
| 403 | Forbidden. The endpoint enforces permissions. | |
| 405 | Method not allowed. | |
| 500 | Internal server error, check server logs. |
Update the model quality metric default settings.
PUT
/model-monitor/v2/api/setting/default/metric
Description
Body Parameter
| Name | Description | Required |
|---|---|---|
defaultSettingUpdateRequestBodyItemArray | defaultSettingUpdateRequestBodyItemArray |
Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | Model Quality Metric Default settings updated successfully. | |
| 400 | Bad request input data. | |
| 403 | Forbidden. The endpoint enforces permissions. | |
| 405 | Method not allowed. | |
| 500 | Internal server error, check server logs. |
UserSettings
Get the existing user setting for the given user.
GET
/model-monitor/v2/api/setting/user
Description
Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | User Settings fetched successfully. | |
| 400 | Bad request input data. | |
| 403 | Forbidden. The endpoint enforces permissions. | |
| 405 | Method not allowed. | |
| 500 | Internal server error, check server logs. |
Update the existing user setting for the user.
POST
/model-monitor/v2/api/setting/user
Description
Body Parameter
| Name | Description | Required |
|---|---|---|
userSetting | userSetting |
Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | User Settings updated successfully. | |
| 400 | Bad request input data. | |
| 403 | Forbidden. The endpoint enforces permissions. | |
| 405 | Method not allowed. | |
| 500 | Internal server error, check server logs. |
Notification
Fetch alert config for the given model.
GET
/model-monitor/v2/api/notification/model-config/{model_id}
Description
Parameters
| Name | Description | Required | Type | In | Example |
|---|---|---|---|---|---|
model_id | string | path |
Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | Model Alert Config was fetched successfully. | |
| 400 | Bad request input data. | |
| 403 | Forbidden. The endpoint enforces permissions. | |
| 404 | Model Alert Config not found for the given model id. | |
| 405 | Method not allowed. | |
| 500 | Internal server error, check server logs. |
Create or Update the existing model alert config.
POST
/model-monitor/v2/api/notification/model-config/{model_id}
Description
Parameters
| Name | Description | Required | Type | In | Example |
|---|---|---|---|---|---|
model_id | string | path |
Body Parameter
| Name | Description | Required |
|---|---|---|
modelAlertConfigUpdateRequestBody | modelAlertConfigUpdateRequestBody |
Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | Model Alert Config was updated successfully. | |
| 400 | Bad request input data. | |
| 403 | Forbidden. The endpoint enforces permissions. | |
| 405 | Method not allowed. | |
| 500 | Internal server error, check server logs. |
Fetch channel config for notifications in DMM.
GET
/model-monitor/v2/api/notification/channel-config
Description
Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | Channel config fetched successfully. | |
| 400 | Bad request input data. | |
| 403 | Forbidden. The endpoint enforces permissions. | |
| 404 | Notification Channel config not found. | |
| 405 | Method not allowed. | |
| 500 | Internal server error, check server logs. |
Create or Update existing channel config for notifications in DMM.
POST
/model-monitor/v2/api/notification/channel-config
Description
Body Parameter
| Name | Description | Required |
|---|---|---|
smtpChannelConfig | smtpChannelConfig |
Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | Notification Channel Config was updated successfully. | |
| 400 | Bad request input data. | |
| 403 | Forbidden. The endpoint enforces permissions. | |
| 405 | Method not allowed. | |
| 500 | Internal server error, check server logs. |
Other
getCurrentUser
GET
/model-monitor/v2/api/auth/user/current
Description
Get current user Information.
Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | Successfully returned user information. | |
| 400 | Bad request input data. | |
| 401 | Unauthorized. The endpoint requires authentication. | |
| 403 | Forbidden. The endpoint enforces authorization. | |
| 405 | Method not allowed. | |
| 500 | Internal server error, check server logs. |
getApiKeyReport
GET
/model-monitor/v2/api/auth/api_key_report
Description
Get CSV report of active API keys with their corresponding users.
Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | Successfully returned an API key report in CSV format. | |
| 400 | Bad request input data. | |
| 403 | Forbidden. The endpoint enforces permissions. | |
| 405 | Method not allowed. | |
| 500 | Internal server error, check server logs. |
getOIDCDetails
GET
/model-monitor/v2/api/auth/get_oidc_details
Description
Get OIDC details.
Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | OIDC details. | |
| 400 | Bad request input data. | |
| 403 | Forbidden. The endpoint enforces permissions. | |
| 404 | Not found. | |
| 405 | Method not allowed. | |
| 410 | No longer supported. | |
| 500 | Internal server error, check server logs. |
getUserApiKey
GET
/model-monitor/v2/api/auth/user/api_key
Description
Gets current user's DMM API key.
Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | Gets user DMM API key. | |
| 400 | Bad request input data. | |
| 403 | Forbidden. The endpoint enforces permissions. | |
| 405 | Method not allowed. | |
| 409 | Conflict with resource requested. | |
| 500 | Internal server error, check server logs. |
revokeUserApiKey
PUT
/model-monitor/v2/api/auth/user/revoke_api_key
Description
Revokes user's DMM API key.
Body Parameter
| Name | Description | Required |
|---|---|---|
UserDmmApiKeyRevokeRequest | UserDmmApiKeyRevokeRequest |
Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | User DMM API key revoked. | |
| 400 | Bad request input data. | |
| 403 | Forbidden. The endpoint enforces permissions. | |
| 405 | Method not allowed. | |
| 500 | Internal server error, check server logs. |
featureQuery
| Field Name | Required | Type | Description | Example |
|---|---|---|---|---|
| id | String | Identifier of the feature in a model | ||
| name | String | Name for the model feature | ||
| type | String | Type of the feature - feature, prediction, row identifier, timestamp | ||
| value | String | Type of the feature value - categorical or numerical | ||
| alertable | Boolean | Whether this feature is alertable for not | ||
| algorithm | String | Algorithm function used for the check query | ||
| condition | alertCondition |
driftAnalyzeRequest
| Field Name | Required | Type | Description | Example |
|---|---|---|---|---|
| modelId | String | |||
| startDate | Number | |||
| endDate | Number | |||
| searchQuery | String | |||
| config | List of featureQuery | |||
| pagination | pagination |
distribution
| Field Name | Required | Type | Description | Example |
|---|---|---|---|---|
| binValues | List of string | The "bin" for a statistical distribution. May be numerical or categorical. | ||
| counts | List of integer | An array of counts representing the bin distribution in the data. | ||
| normalizedValues | List of number | Normalized form, or proportional representation, of "counts" in the data |
driftCalculations
| Field Name | Required | Type | Description | Example |
|---|---|---|---|---|
| id | String | Feature's unique identifier | ||
| name | String | Column's name used during model registration. | ||
| importance | Number | Custom feature importance value used during the model registration. | ||
| drift | Number | Feature's calculated drift for the requested query. | ||
| pValue | Number | Feature's calculated p-value for the requested query. | ||
| drifted | Boolean | Boolean to suggest whether the feature has drifted for the input query. | ||
| alertable | Boolean | Boolean to suggest whether this feature is enabled for scheduled alerts. | ||
| columnType | String | Column type for column | prediction feature | |
| valueType | String | Algorithm function used for the check query | numerical categorical | |
| algorithm | String | Algorithm function used for the check query | ||
| driftTrends | List of array | Drift values for time periods representing the drift trend. | ||
| error | String | Error occurred during computing for a feature | ||
| training | distribution | |||
| prediction | distribution | |||
| condition | alertCondition |
driftAnalyzeResponse
| Field Name | Required | Type | Description | Example |
|---|---|---|---|---|
| totalCount | Number | |||
| calculatedOn | Number | Timestamp of time when the query was performed. | ||
| start | Number | Start time for the data used for the query. | ||
| end | Number | End time for the data used for the query. | ||
| records | Object | Number of records (rows) used for the query. | ||
| features | List of driftCalculations | Drift calculations for selected columns for the query. | ||
| pagination | pagination |
driftUserQuery
| Field Name | Required | Type | Description | Example |
|---|---|---|---|---|
| model_id | String | Unique identifier of the model for this query | ||
| user_id | String | User Id | ||
| features | List of featureQuery | Algorithm and alert condition for features for the model |
driftSchedulerQuery
| Field Name | Required | Type | Description | Example |
|---|---|---|---|---|
| model_id | String | Unique identifier of the model for this query | ||
| features | List of featureQuery | Algorithm and alert condition for features for the model |
featureQueryConfig
| Field Name | Required | Type | Description | Example |
|---|---|---|---|---|
| config | List of featureQuery |
columnDriftAndDistributionCalculation
| Field Name | Required | Type | Description | Example |
|---|---|---|---|---|
| id | String | |||
| columnName | String | |||
| columnType | String | |||
| valueType | String | |||
| featureImportance | Number | |||
| algorithm | String | |||
| modelColumnId | String | |||
| modelCalculationId | String | |||
| columnDriftStatus | Boolean | |||
| divergence | divergence | |||
| divergenceRule | divergenceRule | |||
| trainingDistribution | distribution | |||
| predictionDistribution | distribution |
driftHistoryData
| Field Name | Required | Type | Description | Example |
|---|---|---|---|---|
| pagination | pagination | |||
| totalCount | Integer | |||
| dataForCheck | Object | |||
| columnData | ||||
| searchQuery | String |
modelTraffic
| Field Name | Required | Type | Description | Example |
|---|---|---|---|---|
| traffic | List of dataTraffic | A list that contains the traffic data for model. | ||
| modelId | String | The model id. | 60116865cd9ab24dd866cfc6 |
jobDashboardFilter
| Field Name | Required | Type | Description | Example |
|---|---|---|---|---|
| status | List of string | Status of the dataset job | ||
| job_type | List of jobType | Type of the dataset job |
jobHistoryRequest
| Field Name | Required | Type | Description | Example |
|---|---|---|---|---|
| start | Integer | Start Date for the Dataset range | ||
| end | Integer | End Date for the Dataset range | ||
| pagination | jobPagination | |||
| search | String | Search key for dataset name | ||
| filters | jobDashboardFilter |
jobHistoryResponse
| Field Name | Required | Type | Description | Example |
|---|---|---|---|---|
| job_id | String | Unique Identifier of a dataset job | ||
| dataset_id | String | Unique Identifier of a dataset | ||
| feature_set_details | featureSetDetails | |||
| actionable_insights_details | actionableInsightsDetails | |||
| dataset_name | String | Name of the dataset associated with the job | ||
| datasource_name | String | Name of the datasource, the dataset belongs to | ||
| datasource_type | datasourceType | |||
| job_type | String | Type of the dataset job, such as training, prediction | training prediction ground_truth actionable_insights | |
| registered_on | Integer | The timestamp, when dataset was registered on | ||
| records | Integer | Number of records processed in the dataset job | ||
| status | String | Processing status of the dataset job | pending processing done failed skipped | |
| dataset_path | String | The path of the dataset | ||
| errors | List of string | list of errors encountered during the job processing | ||
| warnings | List of string | list of warnings encountered during the job processing | ||
| infos | List of string | list of infos encountered during the job processing |
listJobResponse
| Field Name | Required | Type | Description | Example |
|---|---|---|---|---|
| total | Integer | Total number of jobs qualified for the query sent, without pagination | ||
| jobs | List of jobHistoryResponse | List of jobs by pagination |
dataSourceResponseCommon
| Field Name | Required | Type | Description | Example |
|---|---|---|---|---|
| id | String | ID of the data source object. | ||
| name | String | Name of the data source. | ||
| type | String | Type of data source. | ||
| user_id | String | ID of the user who created the data source. | ||
| username | String | User who has created the data source. | ||
| created_at | Number | Created time of the data source. | ||
| updated_at | Number | Last updated time of the data source. |
azureDataLakeGen2Response
| Field Name | Required | Type | Description | Example |
|---|---|---|---|---|
| config | adls2ConfigResponse |
azureDataLakeGen1Response
| Field Name | Required | Type | Description | Example |
|---|---|---|---|---|
| config | adls1ConfigResponse |
azureDataLakeGen2Request
| Field Name | Required | Type | Description | Example |
|---|---|---|---|---|
| config | adls2ConfigRequest |
azureDataLakeGen1Request
| Field Name | Required | Type | Description | Example |
|---|---|---|---|---|
| config | adls1ConfigRequest |
metricQueryCommon
| Field Name | Required | Type | Description | Example |
|---|---|---|---|---|
| startTimestamp | Number | |||
| endTimestamp | Number | |||
| modelType | modelType |
metricCheckConfigCommon
| Field Name | Required | Type | Description | Example |
|---|---|---|---|---|
| alertsEnabled | Boolean | Whether this feature is alertable for not | ||
| threshold | metricCheckThreshold |
regressionCheckConfig
| Field Name | Required | Type | Description | Example |
|---|---|---|---|---|
| metricType | regressionMetrics |
modelQualityRegressionQuery
| Field Name | Required | Type | Description | Example |
|---|---|---|---|---|
| metricCheckConfigs | List of regressionCheckConfig |
classificationCheckConfig
| Field Name | Required | Type | Description | Example |
|---|---|---|---|---|
| metricType | classificationMetrics |
modelQualityClassificationQuery
| Field Name | Required | Type | Description | Example |
|---|---|---|---|---|
| metricCheckConfigs | List of classificationCheckConfig |
metricTestResultCommon
| Field Name | Required | Type | Description | Example |
|---|---|---|---|---|
| status | Boolean | Status of the check for the metric. | ||
| metricType | String | Metric name | ||
| value | Number | Metric computed value | ||
| numberOfRecords | Integer | Ground Truth matched records | ||
| threshold | metricCheckThreshold | |||
| alertsEnabled | Boolean | Boolean value to determine if Alerts are Enabled |
metricTestResult
| Field Name | Required | Type | Description | Example |
|---|---|---|---|---|
| trend | List of MetricTrend |
modelQualityAnalyzeCommonResponse
| Field Name | Required | Type | Description | Example |
|---|---|---|---|---|
| modelType | modelType | |||
| calculatedOn | Number | Timestamp of time when the query was performed. | ||
| startTimestamp | Number | Start time for the data used for the query. | ||
| endTimestamp | Number | End time for the data used for the query. | ||
| metricTestResults | List of metricTestResult | Metric Test Results for the queries. | ||
| matchedRowCount | Number | Number of matched Ground Truth and Prediction rows for this query. |
ClassificationReportMetrics
| Field Name | Required | Type | Description | Example |
|---|---|---|---|---|
| heading | String | Class label and Average type like "weighted avg" or "macro avg" | ||
| precision | Number | Classwise or Averaged Precision score | ||
| recall | Number | Classwise or Averaged Recall score | ||
| f1Score | Number | Classwise or Averaged F1 score | ||
| support | Integer | Classwise or overall Support |
classificationReport
| Field Name | Required | Type | Description | Example |
|---|---|---|---|---|
| labelsReport | List of ClassificationReportMetrics | List of Precision, Recall, F1Score, and Support per label | ||
| accuracyReport | AccuracyReport | |||
| averagesReport | List of ClassificationReportMetrics | Macro averaged and weighted averaged Precision, Recall, F1Score, and Support |
classificationModelQualityAnalyzeResponse
| Field Name | Required | Type | Description | Example |
|---|---|---|---|---|
| confusionMatrix | confusionMatrix | |||
| classificationReport | classificationReport |
scheduledCheckResult
| Field Name | Required | Type | Description | Example |
|---|---|---|---|---|
| calculatedOn | Number | Timestamp of the date when this check was executed. | ||
| scheduledCheckDataStartDate | Number | Start Timestamp of the data window of the check. | ||
| scheduledCheckDataEndDate | Number | End Timestamp of the data window of the check. | ||
| metricTestResults | List of metricTestResultCommon | Metric Test Results for the queries. | ||
| numberOfMatchedRows | Number | Number of matched Ground Truth and Prediction rows for this scheduled check. |
variableConfigRegistrationRequest
| Field Name | Required | Type | Description | Example |
|---|---|---|---|---|
| name | String | Name of the variable. | ||
| valueType | valueType | |||
| variableType | variableType | |||
| binsCategories | List of string | Bin categories to be used for a categorical typed variable. | ||
| binsEdges | List of number | Bin Edges to be used for a numerical typed variable. | ||
| binsNum | binCount | |||
| binsEstimatorMethod | binsEstimatorMethod | |||
| featureImportance | Number | Feature Importance for a feature variable. | ||
| precomputedBinCounts | List of integer | Precomputed counts for bins. | ||
| predictionProbabilityLabels | List of string | Labels for the prediction probabilities. | ||
| forPredictionOutput | String | Corresponding prediction variable name, for the given variable. |
datasetConfig
| Field Name | Required | Type | Description | Example |
|---|---|---|---|---|
| path | String | Path to the dataset in the datasource. | ||
| fileFormat | fileFormat |
datasetConfigRegistrationRequest
| Field Name | Required | Type | Description | Example |
|---|---|---|---|---|
| name | String | Name of the dataset. | ||
| datasetType | String | Type of the dataset. | file | |
| datasetConfig | datasetConfig | |||
| datasourceName | String | Name of the datasource to which the dataset belongs. | ||
| datasourceType | datasourceType | |||
| featureSetId | String | The version id for the current feature set version. | ||
| featureSetVersionId | String | The feature set id of the feature set to which the current feature set version belongs to. |
datasetRegistrationConfigRequest
| Field Name | Required | Type | Description | Example |
|---|---|---|---|---|
| variables | ||||
| datasetDetails | datasetConfigRegistrationRequest | |||
| run_cohort_analysis | Boolean |
model
| Field Name | Required | Type | Description | Example |
|---|---|---|---|---|
| name | String | Name of the Model. | ||
| modelType | String | Type of the Model. | classification regression | |
| version | String | Version of the Model. | ||
| description | String | Description for the Model. | ||
| author | String | Author of the Model. | ||
| dateCreated | Integer | The creation date of the model. | ||
| sourceType | sourceType | |||
| sourceDetails | workbenchModelDetails |
modelRegistrationConfigRequest
| Field Name | Required | Type | Description | Example |
|---|---|---|---|---|
| modelMetadata | model |
collaborator
| Field Name | Required | Type | Description | Example |
|---|---|---|---|---|
| userId | String | user id of the collaborator | ||
| collaboratorLevel | collaboratorLevel |
modelResponseCommon
| Field Name | Required | Type | Description | Example |
|---|---|---|---|---|
| id | String | Model Identifier. | ||
| createdAt | Integer | Creation timestamp of the Model. | ||
| updatedAt | Integer | Last update timestamp for the Model. | ||
| userId | String | Id of the model owner, who created the model. | ||
| ownerUsername | String | username of the model owner, who created the model. | ||
| ownerEmail | String | email of the model owner, who created the model. | ||
| ownerName | String | name of the model owner, who created the model. | ||
| tags | List of modelTag | List of tags associated with the model | ||
| ingestionStatus | String | Dataset Ingestion status for a model. | created training prediction ground_truth | |
| registrationStatus | String | Registration status of a model. | draft created deleted | |
| isDeleted | Boolean | Whether the model is deleted or not. | ||
| visibility | visibility | |||
| collaborators | List of collaborator |
modelPermissions
| Field Name | Required | Type | Description | Example |
|---|---|---|---|---|
| canRegisterDataset | Boolean | Whether the requesting user can register a dataset for the model | ||
| canUpdateMonitoringSettings | Boolean | Whether the requesting user can update monitoring settings for the model | ||
| canEditPermissions | Boolean | Whether the requesting user can edit permissions for the model |
modelResponse
| Field Name | Required | Type | Description | Example |
|---|---|---|---|---|
| permissions | modelPermissions |
dataDriftCheck
| Field Name | Required | Type | Description | Example |
|---|---|---|---|---|
| checkedOn | Integer | Schedule check run timestamp. | ||
| variablesDrifted | List of string | Name of variables, which were drifted. | ||
| numberOfPredictions | Integer | Number of Prediction records included in the check. | ||
| scheduledCheckId | String | Scheduled Check Identifier. | ||
| totalNumberOfVariables | Integer | Total number of variables considered for the check. |
modelDashboardItemResponse
| Field Name | Required | Type | Description | Example |
|---|---|---|---|---|
| id | String | Model's Unique Identifier. | ||
| name | String | Model's Name. | ||
| version | String | Model's Version. | ||
| modelType | String | Model's Type. | classification regression | |
| modelStatus | String | Model's Registration status. | draft created deleted | |
| createdAt | Integer | Creation timestamp of a Model. | ||
| isDataDriftCheckScheduled | Boolean | Is the Data Drift check for the model scheduled? | ||
| isModelQualityCheckScheduled | Boolean | Is the Model Quality check for the model scheduled? | ||
| dataDriftChecks | List of dataDriftCheck | Data Drift scheduled check runs. | ||
| modelQualityChecks | List of modelQualityCheck | Model Quality scheduled check runs. | ||
| sourceType | sourceType | |||
| permissions | modelDashboardItemPermissions | |||
| tags | List of modelTag | List of tags associated with the model |
listModelsResponse
| Field Name | Required | Type | Description | Example |
|---|---|---|---|---|
| classificationModelCount | Integer | Number of Classification Models. | ||
| regressionModelCount | Integer | Number of Regression Models. | ||
| filteredModelCount | Integer | Number of filtered Models. | ||
| tagsCount | List of modelTagWithCount | Number of models per tag. | ||
| pagination | pagination | |||
| searchQuery | String | Search query for the model names. | ||
| modelDashboardItems | List of modelDashboardItemResponse | Model Dashboard item set which was fetched. |
variableSummaryResponse
| Field Name | Required | Type | Description | Example |
|---|---|---|---|---|
| name | String | Model's Variable name | ||
| valueType | valueType | |||
| variableType | variableType |
collaboratorRequest
| Field Name | Required | Type | Description | Example |
|---|---|---|---|---|
| collaboratorId | String | |||
| collaboratorLevel | collaboratorLevel |
UserResponse
| Field Name | Required | Type | Description | Example |
|---|---|---|---|---|
| id | String | User Identifier | ||
| domino_id | String | Domino User Id | ||
| username | String | Username of the user | ||
| String | Email of the user | |||
| name | String | Name of the user | ||
| permissions | userPermissions |
ModelVersionSummary
| Field Name | Required | Type | Description | Example |
|---|---|---|---|---|
| workbenchModelVersionId | String | Workbench model version id | ||
| driftedVariablesCount | Integer | count of drifted variables for a model as per last drift scheduled check | ||
| failedMetricsCount | Integer | count of failed metrics for a model as per last quality scheduled check | ||
| predictionTrafficCount | Integer | count of prediction traffic for the model |
defaultSettingBase
| Field Name | Required | Type | Description | Example |
|---|---|---|---|---|
| id | String | Default Setting Identifier. | ||
| createdAt | Integer | Creation timestamp of the Default Setting. | ||
| updatedAt | Integer | Last update timestamp for the Default Setting. | ||
| name | String | Name of the default setting. | ||
| alertCondition | alertCondition |
defaultSettingUpdateRequestBodyItem
| Field Name | Required | Type | Description | Example |
|---|---|---|---|---|
| name | String | Name of the default setting. | ||
| alertCondition | alertCondition |
modelAlertConfig
| Field Name | Required | Type | Description | Example |
|---|---|---|---|---|
| id | String | Model's Alert Config identifier. | ||
| createdAt | Integer | Creation timestamp of the Alert Config for the model. | ||
| updatedAt | Integer | Last update timestamp for the Model's alert config. | ||
| modelId | String | Unique identifier of the model. | ||
| recipients | String | recipients for the model's alert. | ||
| useGlobalRecipients | Boolean | whether or not use the globally configured alert recipients. |
smtpChannelConfig
| Field Name | Required | Type | Description | Example |
|---|---|---|---|---|
| host | String | SMTP host. | ||
| port | Integer | SMTP port. | ||
| username | String | SMTP username. | ||
| password | String | SMTP password. | ||
| sender | String | mail address to be used to send mail notification alerts. | ||
| recipients | String | mail addresses of the recipients globally configured for mail notification alerts. | ||
| configType | String | Notification Config type | ||
| tlsEnabled | Boolean | SMTP TLS enabled. |