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.
DatasetJob
getDatasetJobs
/v2/api/{model_id}/dataset-jobs
Get the list of jobs associated with a model
| Name | Description | Required | Type | In | Example |
|---|---|---|---|---|---|
| Identifier of the model | string | path |
| Name | Description | Required |
|---|---|---|
|
| 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
/v2/api/model/{model_id}/dataset-timeline
Gets the dataset ingestion timeline
| Name | Description | Required | Type | In | Example |
|---|---|---|---|---|---|
| string | path | |||
| number | query | |||
| number | query |
| 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
/v2/api/datasource
Create or delete a datasource.
| Name | Description | Required |
|---|---|---|
|
| 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
/v2/api/datasource
Create or delete a datasource.
| Name | Description | Required | Type | In | Example |
|---|---|---|---|---|---|
| string | query |
| 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. |
ModelQuality
analyzeModelQuality
/v2/api/model/{model_id}/analyze-model-quality
Returns MQ analyze for the model based on the user's config (or model's default config).
| Name | Description | Required | Type | In | Example |
|---|---|---|---|---|---|
| Identifier for the model to be updated. | string | path |
| Name | Description | Required |
|---|---|---|
|
| 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
/v2/api/model/{model_id}/model-quality-user-query
Returns model quality user config for the model.
| Name | Description | Required | Type | In | Example |
|---|---|---|---|---|---|
| Identifier for the model. | string | path |
| 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
/v2/api/model/{model_id}/model-quality-trend
Returns model quality trend for the model for specific model quality metric.
| Name | Description | Required | Type | In | Example |
|---|---|---|---|---|---|
| Identifier of the model. | string | path | ||
| Start time for the data used for the query. | number | query | ||
| End time for the data used for the query. | number | query | ||
| Metric used for the trend. | string | query |
| 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
/v2/api/model/{model_id}/model-quality-scheduler-query
Returns model quality scheduler query for the model.
| Name | Description | Required | Type | In | Example |
|---|---|---|---|---|---|
| Identifier for the model. | string | path |
| 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
/v2/api/model/{model_id}/model-quality-scheduler-query
Returns model quality scheduler query for the model.
| Name | Description | Required | Type | In | Example |
|---|---|---|---|---|---|
| Identifier for the model. | string | path |
| Name | Description | Required |
|---|---|---|
|
| 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
/v2/api/model/{model_id}/model-quality-scheduled-checks-history
Gets the model timeline data for model quality schedule history page
| Name | Description | Required | Type | In | Example |
|---|---|---|---|---|---|
| string | path | |||
| string | query | |||
| string | query |
| 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
/v2/api/model/{scheduled_check_id}/model-quality-scheduled-check-data
Gets the model scheduled check data for MQ schedule history page for the passed scheduled check id
| Name | Description | Required | Type | In | Example |
|---|---|---|---|---|---|
| string | path |
| 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. |
getGroundTruthTraffic
/v2/api/model/{model_id}/traffic/ground-truth
Gets the model's ground truth traffic for matched labels
| Name | Description | Required | Type | In | Example |
|---|---|---|---|---|---|
| string | path | |||
| number | query | |||
| number | query |
| 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. |
Model
registerDatasetConfig
/v2/api/model/{model_id}/register-dataset/{dataset_type}
Dataset registration to a model.
| Name | Description | Required | Type | In | Example |
|---|---|---|---|---|---|
| string | path | |||
| string | path | prediction ground_truth |
| Name | Description | Required |
|---|---|---|
|
| 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
/v2/api/model
Gets a DMM model either via a unique model identifier or via a unique combination of workbench model id and workbench model version id
| Name | Description | Required | Type | In | Example |
|---|---|---|---|---|---|
| string | query | |||
| string | query |
| 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
/v2/api/model
Update one or more editable attributes of a DMM model.
| Name | Description | Required | Type | In | Example |
|---|---|---|---|---|---|
| string | query |
| Name | Description | Required |
|---|---|---|
|
| 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
/v2/api/model
Model Operations.
| Name | Description | Required |
|---|---|---|
|
| 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
/v2/api/model
Model Operations.
| Name | Description | Required | Type | In | Example |
|---|---|---|---|---|---|
| string | query |
| 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
/v2/api/models
| Name | Description | Required | Type | In | Example |
|---|---|---|---|---|---|
| integer | query | |||
| integer | query | |||
| integer | query | |||
| string | query | |||
| Undefined | query |
| 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
/v2/api/get_model_summary
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
| Name | Description | Required | Type | In | Example |
|---|---|---|---|---|---|
| string | query | |||
| string | query |
| 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
/v2/api/model/{model_id}/variables/summary
Get the model's variables summary list
| Name | Description | Required | Type | In | Example |
|---|---|---|---|---|---|
| string | path |
| 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
/v2/api/model/{model_id}/visibility
Updates the visibility of a standalone DMM model
| Name | Description | Required | Type | In | Example |
|---|---|---|---|---|---|
| string | path | |||
| Undefined | query |
| 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
/v2/api/model/{model_id}/collaborators
Fetches all collaborators for a standalone DMM model
| Name | Description | Required | Type | In | Example |
|---|---|---|---|---|---|
| string | path |
| 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
/v2/api/model/{model_id}/collaborators
Adds collaborators to a standalone DMM model
| Name | Description | Required | Type | In | Example |
|---|---|---|---|---|---|
| string | path |
| Name | Description | Required |
|---|---|---|
|
| 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
/v2/api/model/{model_id}/collaborators
Updates an existing collaborator for a standalone DMM model
| Name | Description | Required | Type | In | Example |
|---|---|---|---|---|---|
| string | path |
| Name | Description | Required |
|---|---|---|
|
| 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
/v2/api/model/{model_id}/collaborators
Deletes an existing collaborator for a standalone DMM model
| Name | Description | Required | Type | In | Example |
|---|---|---|---|---|---|
| string | path | |||
| string | query |
| 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. |
Workbench
Get summary for workbench model versions
/v2/api/workbench/model/version/summary
| Name | Description | Required | Type | In | Example |
|---|---|---|---|---|---|
| a string of comma separated workbench model version ids. | string | query | ||
| number | query | |||
| number | query |
| 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. |
DefaultSetting
Get drift default settings
/v2/api/setting/default/drift
| Name | Description | Required | Type | In | Example |
|---|---|---|---|---|---|
| Whether to fetch only the active drift default setting or not. | boolean | query |
| 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.
/v2/api/setting/default/drift
| Name | Description | Required |
|---|---|---|
|
| 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
/v2/api/setting/default/metric
| 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.
/v2/api/setting/default/metric
| Name | Description | Required |
|---|---|---|
|
| 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
Update the existing user setting for the user.
/v2/api/setting/user
| Name | Description | Required |
|---|---|---|
|
| 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.
/v2/api/notification/model-config/{model_id}
| Name | Description | Required | Type | In | Example |
|---|---|---|---|---|---|
| string | path |
| 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 exisiting model alert config.
/v2/api/notification/model-config/{model_id}
| Name | Description | Required | Type | In | Example |
|---|---|---|---|---|---|
| string | path |
| Name | Description | Required |
|---|---|---|
|
| 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.
/v2/api/notification/channel-config
| 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.
/v2/api/notification/channel-config
| Name | Description | Required |
|---|---|---|
|
| 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
postAnalyseDrift
/v2/api/model/{model_id}/analyse-drift
Returns drift analyse for the model based on the user's config (or model's scheduler config). The endpoint is behind the old backend's auth mechanism.
| Name | Description | Required | Type | In | Example |
|---|---|---|---|---|---|
| Identifier for the model to be updated. | string | path |
| Name | Description | Required |
|---|---|---|
|
| Code | Message | Datatype |
|---|---|---|
200 | The drift analyse 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
/v2/api/model/{model_id}/drift-user-query
Returns drift scheduler config for the model. The endpoint is behind the old backend's auth mechanism.
| Name | Description | Required | Type | In | Example |
|---|---|---|---|---|---|
| Identifier for the model to be updated. | string | path |
| 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
/v2/api/model/{model_id}/drift-scheduler-query
Returns drift scheduler config for the model. The endpoint is behind the old backend's auth mechanism.
| Name | Description | Required | Type | In | Example |
|---|---|---|---|---|---|
| Identifier for the model to be updated. | string | path |
| Code | Message | Datatype |
|---|---|---|
200 | The drift scheduler query was generated successfully. | |
403 | Forbidden. The endpoint enforces permissions. | |
500 | Internal server error, check server logs. |
getDriftTrend
/v2/api/model/{model_id}/{column_id}/drift-trend
Returns drift trend for the model's column. The endpoint is behind the old backend's auth mechanism.
| Name | Description | Required | Type | In | Example |
|---|---|---|---|---|---|
| Identifier for the model for the trends | string | path | ||
| Identifier for the column. | string | path | ||
| Start time for the data used for the query. | number | query | ||
| End time for the data used for the query. | number | query | ||
| Algorithm function used for the check query | string | query |
| 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. |
postSaveSchedulerQuery
/v2/api/model/{model_id}/save-scheduler-query
Saves drift scheduler config for the model. The endpoint is behind the old backend's auth mechanism.
| Name | Description | Required | Type | In | Example |
|---|---|---|---|---|---|
| Identifier for the model to be updated. | string | path |
| Name | Description | Required |
|---|---|---|
|
| 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
/v2/api/model/{model_id}/drift-schedule-checks-history
Gets the model timeline data for drift schedule history page
| Name | Description | Required | Type | In | Example |
|---|---|---|---|---|---|
| string | path | |||
| string | query | |||
| string | query |
| 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
/v2/api/model/{model_id}/{scheduler_id}/scheduled-check-drift-data
Get scheduled check drift data
| Name | Description | Required | Type | In | Example |
|---|---|---|---|---|---|
| string | path | |||
| string | path | |||
| string | query | |||
| string | query | |||
| string | query | |||
| string | query | |||
| string | query |
| 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. |
getGetPredictionTraffic
/v2/api/model/get-prediction-traffic
Gets the model prediction traffic
| Name | Description | Required | Type | In | Example |
|---|---|---|---|---|---|
| string | query | |||
| number | query | |||
| number | query |
| 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. |
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 |
driftAnalyzeRequest
| Field Name | Required | Type | Description | Example |
|---|---|---|---|---|
modelId | String | |||
startDate | Number | |||
endDate | Number | |||
searchQuery | String | |||
config | List of featureQuery | |||
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 | Normalised form, or propotional 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 occured during computing for a feature | ||
training | ||||
prediction | ||||
condition |
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 |
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 |