Model Monitoring APIs

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 Model APIs 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.

Endpoints

DatasetJob

getDatasetJobs

POST

/v2/api/{model_id}/dataset-jobs

Description

Get the list of jobs associated with a model

Parameters
NameDescriptionRequiredTypeInExample
model_idIdentifier of the modelstringpath
Body Parameter
NameDescriptionRequired

Responses
CodeMessageDatatype
200Gets the list of jobs for the model
404Dataset not found for the given identifier.
500Internal server error, check server logs.

getDatasetTimeline

GET

/v2/api/model/{model_id}/dataset-timeline

Description

Gets the dataset ingestion timeline

Parameters
NameDescriptionRequiredTypeInExample
model_idstringpath
start_datenumberquery
end_datenumberquery
Responses
CodeMessageDatatype
200Gets the dataset ingestion timeline
400Bad request input data.
403Forbidden. The endpoint enforces permissions.
500Internal server error, check server logs.

DataSource

getAllDataSources

GET

/v2/api/datasources

Description

Gets all Data sources.

Responses
CodeMessageDatatype
200Gets all the registered data sources.
400Bad request input data.
403Forbidden. The endpoint enforces permissions.
405Method not allowed.
500Internal server error, check server logs.

createDataSource

PUT

/v2/api/datasource

Description

Create or delete a datasource.

Body Parameter
NameDescriptionRequired

Responses
CodeMessageDatatype
200Data source added/updated successfully
400Bad request input data.
403Forbidden. The endpoint enforces permissions.
405Method not allowed.
500Internal server error, check server logs.

deleteDataSource

DELETE

/v2/api/datasource

Description

Create or delete a datasource.

Parameters
NameDescriptionRequiredTypeInExample
datasource_idstringquery
Responses
CodeMessageDatatype
200The data source object that was deleted.
400Bad request input data.
403Forbidden. The endpoint enforces permissions.
405Method not allowed.
500Internal server error, check server logs.

Model

getPredictionTraffic

GET

/v2/api/model/get-prediction-traffic

Description

Gets the model prediction traffic

Parameters
NameDescriptionRequiredTypeInExample
model_idsstringquery
start_datenumberquery
end_datenumberquery
Responses
CodeMessageDatatype
200Gets the model prediction traffic
400Bad request input data.
403Forbidden. The endpoint enforces permissions.
500Internal server error, check server logs.

getGroundTruthTraffic

GET

/v2/api/model/{model_id}/traffic/ground-truth

Description

Gets the model's ground truth traffic for matched labels

Parameters
NameDescriptionRequiredTypeInExample
model_idstringpath
startTimestampnumberquery
endTimestampnumberquery
Responses
CodeMessageDatatype
200Gets the ground truth traffic based on number of ground truth labels that matched prediction data.
400Bad request input data.
403Forbidden. The endpoint enforces permissions.
404Model not found.
500Internal server error, check server logs.

registerDatasetConfig

PUT

/v2/api/model/{model_id}/register-dataset/{dataset_type}

Description

Dataset registration to a model.

Parameters
NameDescriptionRequiredTypeInExample
model_idstringpath
dataset_typestringpath
prediction
ground_truth
Body Parameter
NameDescriptionRequired

Responses
CodeMessageDatatype
200Successfully registered dataset to the Model.
400Bad request input data.
403Forbidden. The endpoint enforces permissions.
405Method not allowed.
500Internal server error, check server logs.

getModelById

GET

/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
NameDescriptionRequiredTypeInExample
model_idstringquery
workbench_model_version_idstringquery
Responses
CodeMessageDatatype
200Successfully fetched the Model.
400Bad request input data.
403Forbidden. The endpoint enforces permissions.
404Model not found.
405Method not allowed.
500Internal server error, check server logs.

updateModelById

PATCH

/v2/api/model

Description

Update one or more editable attributes of a DMM model.

Parameters
NameDescriptionRequiredTypeInExample
model_idstringquery
Body Parameter
NameDescriptionRequired

Responses
CodeMessageDatatype
200Successfully updated the model.
400Bad request input data.
403Forbidden. The endpoint enforces permissions.
404Model not found.
405Method not allowed.
500Internal server error, check server logs.

registerModelThroughConfig

PUT

/v2/api/model

Description

Model Operations.

Body Parameter
NameDescriptionRequired

Responses
CodeMessageDatatype
200Successfully registered the Model.
400Bad request input data.
403Forbidden. The endpoint enforces permissions.
405Method not allowed.
500Internal server error, check server logs.

deleteModelById

DELETE

/v2/api/model

Description

Model Operations.

Parameters
NameDescriptionRequiredTypeInExample
model_idstringquery
Responses
CodeMessageDatatype
200Successfully deleted the Model.
400Bad request input data.
403Forbidden. The endpoint enforces permissions.
404Model not found.
405Method not allowed.
409Conflict with model requested.
500Internal server error, check server logs.

listModels

GET

/v2/api/models

Description

Parameters
NameDescriptionRequiredTypeInExample
pageNumberintegerquery
pageSizeintegerquery
numberOfLastChecksToFetchintegerquery
searchQuerystringquery
modelTypeUndefinedquery
Responses
CodeMessageDatatype
200Successfully fetched the Model.
400Bad request input data.
403Forbidden. The endpoint enforces permissions.
405Method not allowed.
500Internal server error, check server logs.

getModelSummary

GET

/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
NameDescriptionRequiredTypeInExample
model_idstringquery
workbench_model_version_idstringquery
Responses
CodeMessageDatatype
200Successfully fetched the Model summary.
400Bad request input data.
403Forbidden. The endpoint enforces permissions.
404Model not found.
405Method not allowed.
500Internal server error, check server logs.

getModelVariablesSummary

GET

/v2/api/model/{model_id}/variables/summary

Description

Get the model's variables summary list

Parameters
NameDescriptionRequiredTypeInExample
model_idstringpath
Responses
CodeMessageDatatype
200Successfully fetched the Model.
400Bad request input data.
403Forbidden. The endpoint enforces permissions.
404Model not found.
405Method not allowed.
500Internal server error, check server logs.

updateModelVisibility

PUT

/v2/api/model/{model_id}/visibility

Description

Updates the visibility of a standalone DMM model

Parameters
NameDescriptionRequiredTypeInExample
model_idstringpath
visibilityUndefinedquery
Responses
CodeMessageDatatype
200Successfully updated model visibility.
400Bad request input data.
403Forbidden. The endpoint enforces permissions.
404Model not found.
405Method not allowed.
500Internal server error, check server logs.

getModelCollaborators

GET

/v2/api/model/{model_id}/collaborators

Description

Fetches all collaborators for a standalone DMM model

Parameters
NameDescriptionRequiredTypeInExample
model_idstringpath
Responses
CodeMessageDatatype
200Successfully fetched the model's collaborators.
400Bad request input data.
403Forbidden. The endpoint enforces permissions.
404Model not found.
405Method not allowed.
500Internal server error, check server logs.

addCollaborators

POST

/v2/api/model/{model_id}/collaborators

Description

Adds collaborators to a standalone DMM model

Parameters
NameDescriptionRequiredTypeInExample
model_idstringpath
Body Parameter
NameDescriptionRequired

Responses
CodeMessageDatatype
200Successfully add a collaborator to model.
400Bad request input data.
403Forbidden. The endpoint enforces permissions.
404Model not found.
405Method not allowed.
500Internal server error, check server logs.

updateCollaboratorRole

PUT

/v2/api/model/{model_id}/collaborators

Description

Updates an existing collaborator for a standalone DMM model

Parameters
NameDescriptionRequiredTypeInExample
model_idstringpath
Body Parameter
NameDescriptionRequired

Responses
CodeMessageDatatype
200Successfully updated a model collaborator.
400Bad request input data.
403Forbidden. The endpoint enforces permissions.
404Model not found.
405Method not allowed.
500Internal server error, check server logs.

deleteCollaborator

DELETE

/v2/api/model/{model_id}/collaborators

Description

Deletes an existing collaborator for a standalone DMM model

Parameters
NameDescriptionRequiredTypeInExample
model_idstringpath
collaborator_idstringquery
Responses
CodeMessageDatatype
200Successfully removed a collaborator from a model.
400Bad request input data.
403Forbidden. The endpoint enforces permissions.
404Model not found.
405Method not allowed.
500Internal server error, check server logs.

ModelDrift

analyzeDrift

POST

/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
NameDescriptionRequiredTypeInExample
model_idIdentifier for the model to be updated.stringpath
Body Parameter
NameDescriptionRequired

Responses
CodeMessageDatatype
200The drift analyze query was done successfully.
204Empty response.
400Bad request input data.
403Forbidden. The endpoint enforces permissions.
500Internal server error, check server logs.

getDriftUserQuery

GET

/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
NameDescriptionRequiredTypeInExample
model_idIdentifier for the model to be updated.stringpath
Responses
CodeMessageDatatype
200The drift scheduler query was generated successfully.
403Forbidden. The endpoint enforces permissions.
500Internal server error, check server logs.

getDriftSchedulerQuery

GET

/v2/api/model/{model_id}/drift-scheduler-query

Description

Returns drift scheduler config for the model.

Parameters
NameDescriptionRequiredTypeInExample
model_idIdentifier for the model to be updated.stringpath
Responses
CodeMessageDatatype
200The drift scheduler query was generated successfully.
403Forbidden. The endpoint enforces permissions.
500Internal server error, check server logs.

getModelColumnDriftTrend

GET

/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
NameDescriptionRequiredTypeInExample
model_idIdentifier for the model for the trendsstringpath
column_idIdentifier for the column.stringpath
startDateStart time for the data used for the query.numberquery
endDateEnd time for the data used for the query.numberquery
algorithmAlgorithm function used for the check querystringquery
Responses
CodeMessageDatatype
200The drift trend fetch query was done successfully.
400Bad request input data.
403Forbidden. The endpoint enforces permissions.
500Internal server error, check server logs.

saveSchedulerQuery

POST

/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
NameDescriptionRequiredTypeInExample
model_idIdentifier for the model to be updated.stringpath
Body Parameter
NameDescriptionRequired

Responses
CodeMessageDatatype
200The drift scheduler query was generated successfully.
403Forbidden. The endpoint enforces permissions.
500Internal server error, check server logs.

getDriftScheduleChecksHistory

GET

/v2/api/model/{model_id}/drift-schedule-checks-history

Description

Gets the model timeline data for drift schedule history page

Parameters
NameDescriptionRequiredTypeInExample
model_idstringpath
start_datestringquery
end_datestringquery
Responses
CodeMessageDatatype
200Gets the model timeline data
400Bad request input data.
403Forbidden. The endpoint enforces permissions.
500Internal server error, check server logs.

getScheduledCheckDriftData

GET

/v2/api/model/{model_id}/{scheduler_id}/scheduled-check-drift-data

Description

Get scheduled check drift data

Parameters
NameDescriptionRequiredTypeInExample
model_idstringpath
scheduler_idstringpath
sortOrderstringquery
sortOnstringquery
pageNumberstringquery
pageSizestringquery
searchQuerystringquery
Responses
CodeMessageDatatype
200Gets the model timeline data
400Bad request input data.
403Forbidden. The endpoint enforces permissions.
500Internal server error, check server logs.

ModelQuality

analyzeModelQuality

POST

/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
NameDescriptionRequiredTypeInExample
model_idIdentifier for the model to be updated.stringpath
Body Parameter
NameDescriptionRequired

Responses
CodeMessageDatatype
200The MQ analyze query was done successfully.
204Empty response.
400Bad request input data.
403Forbidden. The endpoint enforces permissions.
500Internal server error, check server logs.

getModelQualityUserQuery

GET

/v2/api/model/{model_id}/model-quality-user-query

Description

Returns model quality user config for the model.

Parameters
NameDescriptionRequiredTypeInExample
model_idIdentifier for the model.stringpath
Responses
CodeMessageDatatype
200The model quality user query was fetched successfully.
204The model quality user query does not exist for the user.
400Bad request input data.
403Forbidden. The endpoint enforces permissions.
500Internal server error, check server logs.

getModelQualityTrend

GET

/v2/api/model/{model_id}/model-quality-trend

Description

Returns model quality trend for the model for specific model quality metric.

Parameters
NameDescriptionRequiredTypeInExample
model_idIdentifier of the model.stringpath
startTimestampStart time for the data used for the query.numberquery
endTimestampEnd time for the data used for the query.numberquery
metricNameMetric used for the trend.stringquery
Responses
CodeMessageDatatype
200The model quality trend was fetched successfully.
400Bad request input data.
403Forbidden. The endpoint enforces permissions.
500Internal server error, check server logs.

getModelQualitySchedulerQuery

GET

/v2/api/model/{model_id}/model-quality-scheduler-query

Description

Returns model quality scheduler query for the model.

Parameters
NameDescriptionRequiredTypeInExample
model_idIdentifier for the model.stringpath
Responses
CodeMessageDatatype
200The model quality scheduler query was fetched successfully.
400Bad request input data.
403Forbidden. The endpoint enforces permissions.
404Model Quality Scheduler Query not found.
500Internal server error, check server logs.

saveModelQualitySchedulerQuery

POST

/v2/api/model/{model_id}/model-quality-scheduler-query

Description

Returns model quality scheduler query for the model.

Parameters
NameDescriptionRequiredTypeInExample
model_idIdentifier for the model.stringpath
Body Parameter
NameDescriptionRequired

Responses
CodeMessageDatatype
200The model quality scheduler query was saved successfully.
400Bad request input data.
403Forbidden. The endpoint enforces permissions.
404Model Quality Scheduler Query not found.
500Internal server error, check server logs.

getModelQualityScheduledChecksTimeline

GET

/v2/api/model/{model_id}/model-quality-scheduled-checks-history

Description

Gets the model timeline data for model quality schedule history page

Parameters
NameDescriptionRequiredTypeInExample
model_idstringpath
start_datestringquery
end_datestringquery
Responses
CodeMessageDatatype
200Gets the model timeline data
400Bad request input data.
403Forbidden. The endpoint enforces permissions.
404Model not found or is deleted.
500Internal server error, check server logs.

getModelQualityScheduledCheckData

GET

/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
NameDescriptionRequiredTypeInExample
scheduled_check_idstringpath
Responses
CodeMessageDatatype
200Gets the scheduled check data
400Bad request input data.
403Forbidden. The endpoint enforces permissions.
404Data for passed Scheduled Check Id not found.
500Internal server error, check server logs.

Workbench

Get summary for workbench model versions

GET

/v2/api/workbench/model/version/summary

Description

Parameters
NameDescriptionRequiredTypeInExample
model_version_idsa string of comma separated workbench model version ids.stringquery
start_datenumberquery
end_datenumberquery
Responses
CodeMessageDatatype
200Model summaries were fetched successfully.
400Bad request input data.
403Forbidden. The endpoint enforces permissions.
405Method not allowed.
500Internal server error, check server logs.

DefaultSettings

Get drift default settings

GET

/v2/api/setting/default/drift

Description

Parameters
NameDescriptionRequiredTypeInExample
is_activeWhether to fetch only the active drift default setting or not.booleanquery
Responses
CodeMessageDatatype
200Drift default settings fetched successfully.
400Bad request input data.
403Forbidden. The endpoint enforces permissions.
405Method not allowed.
500Internal server error, check server logs.

Update the drift default settings.

PUT

/v2/api/setting/default/drift

Description

Body Parameter
NameDescriptionRequired

Responses
CodeMessageDatatype
200Drift Default settings updated successfully.
400Bad request input data.
403Forbidden. The endpoint enforces permissions.
405Method not allowed.
500Internal server error, check server logs.

Get model quality metric default settings

GET

/v2/api/setting/default/metric

Description

Responses
CodeMessageDatatype
200Model Quality Metric default settings fetched successfully.
400Bad request input data.
403Forbidden. The endpoint enforces permissions.
405Method not allowed.
500Internal server error, check server logs.

Update the model quality metric default settings.

PUT

/v2/api/setting/default/metric

Description

Body Parameter
NameDescriptionRequired

Responses
CodeMessageDatatype
200Model Quality Metric Default settings updated successfully.
400Bad request input data.
403Forbidden. The endpoint enforces permissions.
405Method not allowed.
500Internal server error, check server logs.

UserSettings

Get the existing user setting for the given user.

GET

/v2/api/setting/user

Description

Responses
CodeMessageDatatype
200User Settings fetched successfully.
400Bad request input data.
403Forbidden. The endpoint enforces permissions.
405Method not allowed.
500Internal server error, check server logs.

Update the existing user setting for the user.

POST

/v2/api/setting/user

Description

Body Parameter
NameDescriptionRequired

Responses
CodeMessageDatatype
200User Settings updated successfully.
400Bad request input data.
403Forbidden. The endpoint enforces permissions.
405Method not allowed.
500Internal server error, check server logs.

Notification

Fetch alert config for the given model.

GET

/v2/api/notification/model-config/{model_id}

Description

Parameters
NameDescriptionRequiredTypeInExample
model_idstringpath
Responses
CodeMessageDatatype
200Model Alert Config was fetched successfully.
400Bad request input data.
403Forbidden. The endpoint enforces permissions.
404Model Alert Config not found for the given model id.
405Method not allowed.
500Internal server error, check server logs.

Create or Update the existing model alert config.

POST

/v2/api/notification/model-config/{model_id}

Description

Parameters
NameDescriptionRequiredTypeInExample
model_idstringpath
Body Parameter
NameDescriptionRequired

Responses
CodeMessageDatatype
200Model Alert Config was updated successfully.
400Bad request input data.
403Forbidden. The endpoint enforces permissions.
405Method not allowed.
500Internal server error, check server logs.

Fetch channel config for notifications in DMM.

GET

/v2/api/notification/channel-config

Description

Responses
CodeMessageDatatype
200Channel config fetched successfully.
400Bad request input data.
403Forbidden. The endpoint enforces permissions.
404Notification Channel config not found.
405Method not allowed.
500Internal server error, check server logs.

Create or Update existing channel config for notifications in DMM.

POST

/v2/api/notification/channel-config

Description

Body Parameter
NameDescriptionRequired

Responses
CodeMessageDatatype
200Notification Channel Config was updated successfully.
400Bad request input data.
403Forbidden. The endpoint enforces permissions.
405Method not allowed.
500Internal server error, check server logs.

Other

ping

GET

/v2/api/ping

Description

Health check endpoint.

Responses
CodeMessageDatatype
200A no non-sense static body for full cycle web server health

login

GET

/v2/api/auth/login

Description

Initiates login flow.

Responses
CodeMessageDatatype
302Redirects to keycloak login flow.
400Bad request input data.
403Forbidden. The endpoint enforces permissions.
405Method not allowed.
410No longer supported.
500Internal server error, check server logs.

logout

GET

/v2/api/auth/logout

Description

Initiates logout.

Responses
CodeMessageDatatype
302Redirects to logout screen
400Bad request input data.
403Forbidden. The endpoint enforces permissions.
405Method not allowed.
410No longer supported.
500Internal server error, check server logs.

getCurrentUser

GET

/v2/api/auth/user/current

Description

Get current user Information.

Responses
CodeMessageDatatype
200Successfully returned user information.
400Bad request input data.
401Unauthorized. The endpoint requires authentication.
403Forbidden. The endpoint enforces authorization.
405Method not allowed.
500Internal server error, check server logs.

getApiKeyReport

GET

/v2/api/auth/api_key_report

Description

Get CSV report of active API keys with their corresponding users.

Responses
CodeMessageDatatype
200Successfully returned an API key report in CSV format.
400Bad request input data.
403Forbidden. The endpoint enforces permissions.
405Method not allowed.
500Internal server error, check server logs.

getOIDCDetails

GET

/v2/api/auth/get_oidc_details

Description

Get OIDC details.

Responses
CodeMessageDatatype
200OIDC details.
400Bad request input data.
403Forbidden. The endpoint enforces permissions.
404Not found.
405Method not allowed.
410No longer supported.
500Internal server error, check server logs.

generateUserApiKey

GET

/v2/api/auth/user/generate_api_key

Description

Initiates API Key (Offline Token) login flow.

Responses
CodeMessageDatatype
403Forbidden. The endpoint enforces permissions.
410No longer supported.
500Internal server error, check server logs.

getUserApiKey

GET

/v2/api/auth/user/api_key

Description

Gets current user's DMM API key.

Responses
CodeMessageDatatype
200Gets user DMM API key.
400Bad request input data.
403Forbidden. The endpoint enforces permissions.
405Method not allowed.
409Conflict with resource requested.
500Internal server error, check server logs.

revokeUserApiKey

PUT

/v2/api/auth/user/revoke_api_key

Description

Revokes user's DMM API key.

Body Parameter
NameDescriptionRequired

Responses
CodeMessageDatatype
200User DMM API key revoked.
400Bad request input data.
403Forbidden. The endpoint enforces permissions.
405Method not allowed.
500Internal server error, check server logs.