Model Monitoring API reference

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.

DatasetJob

getDatasetJobs

getDatasetTimeline

DataSource

getAllDataSources

createDataSource

deleteDataSource

Model

getPredictionTraffic

getGroundTruthTraffic

registerDatasetConfig

getModelById

updateModelById

registerModelThroughConfig

deleteModelById

listModels

getModelSummary

getModelVariablesSummary

updateModelVisibility

getModelCollaborators

addCollaborators

updateCollaboratorRole

deleteCollaborator

listTags

addTags

removeTag

ModelTag

archiveTag

unarchiveTag

ModelDrift

analyzeDrift

getDriftUserQuery

getDriftSchedulerQuery

getModelColumnDriftTrend

saveSchedulerQuery

getDriftScheduleChecksHistory

getScheduledCheckDriftData

ModelQuality

analyzeModelQuality

getModelQualityUserQuery

getModelQualityTrend

getModelQualitySchedulerQuery

saveModelQualitySchedulerQuery

getModelQualityScheduledChecksTimeline

getModelQualityScheduledCheckData

Workbench

Get summary for workbench model versions

DefaultSettings

Get drift default settings

Update the drift default settings.

Get model quality metric default settings

Update the model quality metric default settings.

UserSettings

Get the existing user setting for the given user.

Update the existing user setting for the user.

Notification

Fetch alert config for the given model.

Create or Update the existing model alert config.

Fetch channel config for notifications in DMM.

Create or Update existing channel config for notifications in DMM.

Sends test mail

Other

ping

login

logout

getCurrentUser

getApiKeyReport

getOIDCDetails

generateUserApiKey

getUserApiKey

revokeUserApiKey

Scheduler

Pauses schedule job

Updates scheduler job of a model

Gets schedule check data by schedule job ID

Creates a schedule check for a model drift

Gets schedule check job for model drift.

Creates a schedule check for model quality.

Gets schedule check job for model quality

Models

pingPong

alertCondition

featureQuery

pagination

driftAnalyzeRequest

distribution

driftCalculations

driftAnalyzeResponse

driftUserQuery

driftSchedulerQuery

featureQueryConfig

driftHistoryTimeline

driftHistoryTimelineArray

divergence

divergenceRule

columnDriftAndDistributionCalculation

driftHistoryData

dataTraffic

modelTraffic

modelTrafficArray

jobPagination

jobType

jobDashboardFilter

jobHistoryRequest

featureSetDetails

actionableInsightsDetails

datasourceType

jobHistoryResponse

listJobResponse

datasetIngestTimeline

datasetIngestTimelineArray

dataSourceResponseCommon

s3Response

genericS3Response

azureBlobResponse

adls2CommonConfigResponse

adls2SharedKeyConfigResponse

adls2OAuth2ConfigResponse

adls2ConfigResponse

azureDataLakeGen2Response

googleCloudStorageResponse

adls1CommonConfigResponse

adls1ClientCredentialsConfigResponse

adls1ManagedIdentityConfigResponse

adls1ConfigResponse

azureDataLakeGen1Response

hdfsResponse

nfsResponse

snowflakeResponse

dataSourceResponse

dataSourceResponseArray

dataSourceRequestCommon

s3Request

genericS3Request

azureBlobRequest

adls2CommonConfigRequest

adls2SharedKeyConfigRequest

adls2ClientCredentialsConfigRequest

adls2UsernamePasswordConfigRequest

adls2RefreshTokenConfigRequest

adls2ManagedIdentityConfigRequest

adls2ConfigRequest

azureDataLakeGen2Request

googleCloudStorageRequest

adls1CommonConfigRequest

adls1ClientCredentialsConfigRequest

adls1ManagedIdentityConfigRequest

adls1ConfigRequest

azureDataLakeGen1Request

hdfsRequest

snowflakeRequest

dataSourceRequest

modelType

metricQueryCommon

metricCheckThreshold

metricCheckConfigCommon

regressionMetrics

regressionCheckConfig

modelQualityRegressionQuery

classificationMetrics

classificationCheckConfig

modelQualityClassificationQuery

modelQualityQueryRequest

metricTestResultCommon

MetricTrend

metricTestResult

modelQualityAnalyzeCommonResponse

confusionMatrix

ClassificationReportMetrics

AccuracyReport

classificationReport

classificationModelQualityAnalyzeResponse

regressionModelQualityAnalyzeResponse

modelQualityAnalyzeResponse

modelQualityUserQueryCommon

modelQualityRegressionUserQuery

modelQualityClassificationUserQuery

modelQualityUserQueryResponse

MetricTrendArray

modelQualitySchedulerQueryCommon

modelQualityRegressionSchedulerQuery

modelQualityClassificationSchedulerQuery

modelQualitySchedulerQueryResponse

modelQualityHistoryTimeline

modelQualityHistoryTimelineArray

scheduledCheckResult

valueType

variableType

binCount

binsEstimatorMethod

variableConfigRegistrationRequest

fileFormat

datasetConfig

datasetConfigRegistrationRequest

datasetRegistrationConfigRequest

sourceType

workbenchModelDetails

model

modelRegistrationConfigRequest

modelTag

visibility

collaboratorLevel

collaborator

modelResponseCommon

modelPermissions

modelResponse

editableModelAttributes

modelUpdateRequest

modelTagWithCount

dataDriftCheck

modelQualityCheck

modelDashboardItemPermissions

modelDashboardItemResponse

listModelsResponse

variableSummaryResponse

variableSummaryResponseArray

collaboratorResponse

collaboratorResponseArray

collaboratorRequest

collaboratorRequestArray

tagsRequest

userPermissions

UserResponse

OIDCDetails

UserApiKeyResponse

UserDmmApiKeyRevokeRequest

ModelVersionSummary

ModelVersionSummaryArray

globalSettings

globalSettingsResponse

userSetting

userSettingResponse

defaultSettingBase

driftSetting

driftSettingArray

defaultSettingUpdateRequestBodyItem

driftDefaultSettingUpdateRequestBodyItem

driftDefaultSettingUpdateRequestBodyItemArray

defaultSettingBaseArray

defaultSettingUpdateRequestBodyItemArray

modelAlertConfig

modelAlertConfigUpdateRequestBody

smtpChannelConfig

channelConfig

UpdateScheduleJobPayLoad

ScheduleJob

Scheduledjob

CreateScheduleJobPayLoad

TestEmailRequestBody