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
DataSource
ModelQuality
Model
Workbench
DefaultSetting
UserSettings
Notification
Other

Endpoints

DatasetJob

getDatasetJobs

POST

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

Description

Get the list of jobs associated with a model

Parameters

Name Description Required Type In Example

Name	Description	Required	Type	In	Example
`model_id`	Identifier of the model		string	path

model_id

Identifier of the model

string

path

Body Parameter

Name Description Required

Name	Description	Required
	undefined

undefined

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

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

Description

Gets the dataset ingestion timeline

Parameters

Name Description Required Type In Example

Name	Type	In
`model_id`	string	path
`start_date`	number	query
`end_date`	number	query

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	Unauthorized. The endpoint enforces authorization.
500	Internal server error, check server logs.

DataSource

getAllDataSources

GET

/v2/api/datasources

Description

Gets all Data sources.

Responses

Code	Message	Datatype
200	Gets all the registered data sources.
400	Bad request input data.
403	Unauthorized. The endpoint enforces authorization.
405	Method not allowed.
500	Internal server error, check server logs.

createDataSource

PUT

/v2/api/datasource

Description

Delete a datasource.

Body Parameter

Name Description Required

Name	Description	Required
	undefined

undefined

Responses

Code	Message	Datatype
200	Data source added/updated successfully
400	Bad request input data.
403	Unauthorized. The endpoint enforces authorization.
405	Method not allowed.
500	Internal server error, check server logs.

deleteDataSource

DELETE

/v2/api/datasource

Description

Delete a datasource.

Parameters

Name Description Required Type In Example

Name	Description	Required	Type	In	Example
`datasource_id`			string	query

datasource_id

string

query

Responses

Code	Message	Datatype
200	The data source object that was deleted.
400	Bad request input data.
403	Unauthorized. The endpoint enforces authorization.
405	Method not allowed.
500	Internal 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

Name Description Required Type In Example

Name	Description	Required	Type	In	Example
`model_id`	Identifier for the model to be updated.		string	path

model_id

Identifier for the model to be updated.

string

path

Body Parameter

Name Description Required

Name	Description	Required
	undefined

undefined

Responses

Code	Message	Datatype
200	The MQ analyze query was done successfully.
204	Empty response.
400	Bad request input data.
403	Unauthorized. The endpoint enforces authorization.
500	Internal 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

Name Description Required Type In Example

Name	Description	Required	Type	In	Example
`model_id`	Identifier for the model.		string	path

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	Unauthorized. The endpoint enforces authorization.
500	Internal 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

Name Description Required Type In Example

Name	Description	Type	In
`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

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	Unauthorized. The endpoint enforces authorization.
500	Internal 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

Name Description Required Type In Example

Name	Description	Required	Type	In	Example
`model_id`	Identifier for the model.		string	path

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	Unauthorized. The endpoint enforces authorization.
404	Model Quality Scheduler Query not found.
500	Internal 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

Name Description Required Type In Example

Name	Description	Required	Type	In	Example
`model_id`	Identifier for the model.		string	path

model_id

Identifier for the model.

string

path

Body Parameter

Name Description Required

Name	Description	Required
	undefined

undefined

Responses

Code	Message	Datatype
200	The model quality scheduler query was saved successfully.
400	Bad request input data.
403	Unauthorized. The endpoint enforces authorization.
404	Model Quality Scheduler Query not found.
500	Internal 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

Name Description Required Type In Example

Name	Type	In
`model_id`	string	path
`start_date`	string	query
`end_date`	string	query

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	Unauthorized. The endpoint enforces authorization.
404	Model not found or is deleted.
500	Internal 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

Name Description Required Type In Example

Name	Description	Required	Type	In	Example
`scheduled_check_id`			string	path

scheduled_check_id

string

path

Responses

Code	Message	Datatype
200	Gets the scheduled check data
400	Bad request input data.
403	Unauthorized. The endpoint enforces authorization.
404	Data for passed Scheduled Check Id not found.
500	Internal 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

Name Description Required Type In Example

Name	Type	In
`model_id`	string	path
`startTimestamp`	number	query
`endTimestamp`	number	query

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	Unauthorized. The endpoint enforces authorization.
404	Model not found.
500	Internal server error, check server logs.

Model

registerDatasetConfig

PUT

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

Description

Dataset registration to a model.

Parameters

Name Description Required Type In Example

Name	Description	Required	Type	In	Example
`model_id`			string	path
`dataset_type`			string	path	prediction ground_truth

model_id

string

path

dataset_type

string

path

prediction

ground_truth

Body Parameter

Name Description Required

Name	Description	Required
	undefined

undefined

Responses

Code	Message	Datatype
200	Successfully registered dataset to the Model.
400	Bad request input data.
403	Unauthorized. The endpoint enforces authorization.
405	Method not allowed.
500	Internal 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

Name Description Required Type In Example

Name	Description	Required	Type	In	Example
`model_id`			string	query
`workbench_model_version_id`			string	query

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	Unauthorized. The endpoint enforces authorization.
404	Model not found.
405	Method not allowed.
500	Internal server error, check server logs.

updateModelById

PATCH

/v2/api/model

Description

Update one or more editable attributes of a DMM model.

Parameters

Name Description Required Type In Example

Name	Description	Required	Type	In	Example
`model_id`			string	query

model_id

string

query

Body Parameter

Name Description Required

Name	Description	Required
	undefined

undefined

Responses

Code	Message	Datatype
200	Successfully updated the model.
400	Bad request input data.
403	Unauthorized. The endpoint enforces authorization.
404	Model not found.
405	Method not allowed.
500	Internal server error, check server logs.

registerModelThroughConfig

PUT

/v2/api/model

Description

Model Operations.

Body Parameter

Name Description Required

Name	Description	Required
	undefined

undefined

Responses

Code	Message	Datatype
200	Successfully registered the Model.
400	Bad request input data.
403	Unauthorized. The endpoint enforces authorization.
405	Method not allowed.
500	Internal server error, check server logs.

deleteModelById

DELETE

/v2/api/model

Description

Model Operations.

Parameters

Name Description Required Type In Example

Name	Description	Required	Type	In	Example
`model_id`			string	query

model_id

string

query

Responses

Code	Message	Datatype
200	Successfully deleted the Model.
400	Bad request input data.
403	Unauthorized. The endpoint enforces authorization.
404	Model not found.
405	Method not allowed.
409	Conflict with model requested.
500	Internal server error, check server logs.

listModels

GET

/v2/api/models

Description

Parameters

Name Description Required Type In Example

Name	Type	In
`pageNumber`	integer	query
`pageSize`	integer	query
`numberOfLastChecksToFetch`	integer	query
`searchQuery`	string	query
`modelType`	Undefined	query

pageNumber

integer

query

pageSize

integer

query

numberOfLastChecksToFetch

integer

query

searchQuery

string

query

modelType

Undefined

query

Responses

Code	Message	Datatype
200	Successfully fetched the Model.
400	Bad request input data.
403	Unauthorized. The endpoint enforces authorization.
405	Method not allowed.
500	Internal 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

Name Description Required Type In Example

Name	Description	Required	Type	In	Example
`model_id`			string	query
`workbench_model_version_id`			string	query

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	Unauthorized. The endpoint enforces authorization.
404	Model not found.
405	Method not allowed.
500	Internal server error, check server logs.

getModelVariablesSummary

GET

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

Description

Get the model's variables summary list

Parameters

Name Description Required Type In Example

Name	Description	Required	Type	In	Example
`model_id`			string	path

model_id

string

path

Responses

Code	Message	Datatype
200	Successfully fetched the Model.
400	Bad request input data.
403	Unauthorized. The endpoint enforces authorization.
404	Model not found.
405	Method not allowed.
500	Internal server error, check server logs.

Workbench

Get summary for workbench model versions

GET

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

Description

Parameters

Name Description Required Type In Example

Name	Description	Type	In
`model_version_ids`	a string of comma separated workbench model version ids.	string	query
`start_date`		number	query
`end_date`		number	query

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	Unauthorized. The endpoint enforces authorization.
405	Method not allowed.
500	Internal server error, check server logs.

DefaultSetting

Get drift default settings

GET

/v2/api/setting/default/drift

Description

Parameters

Name Description Required Type In Example

Name	Description	Required	Type	In	Example
`is_active`	Whether to fetch only the active drift default setting or not.		boolean	query

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	Unauthorized. The endpoint enforces authorization.
405	Method not allowed.
500	Internal server error, check server logs.

Update the drift default settings.

PUT

/v2/api/setting/default/drift

Description

Body Parameter

Name Description Required

undefined

Responses

Code	Message	Datatype
200	Drift Default settings updated successfully.
400	Bad request input data.
403	Unauthorized. The endpoint enforces authorization.
405	Method not allowed.
500	Internal server error, check server logs.

Get model quality metric default settings

GET

/v2/api/setting/default/metric

Description

Responses

Code	Message	Datatype
200	Model Quality Metric default settings fetched successfully.
400	Bad request input data.
403	Unauthorized. The endpoint enforces authorization.
405	Method not allowed.
500	Internal server error, check server logs.

Update the model quality metric default settings.

PUT

/v2/api/setting/default/metric

Description

Body Parameter

Name Description Required

undefined

Responses

Code	Message	Datatype
200	Model Quality Metric Default settings updated successfully.
400	Bad request input data.
403	Unauthorized. The endpoint enforces authorization.
405	Method not allowed.
500	Internal server error, check server logs.

UserSettings

Get the existing user setting for the given user.

GET

/v2/api/setting/user

Description

Responses

Code	Message	Datatype
200	User Settings fetched successfully.
400	Bad request input data.
403	Unauthorized. The endpoint enforces authorization.
405	Method not allowed.
500	Internal server error, check server logs.

Update the existing user setting for the user.

POST

/v2/api/setting/user

Description

Body Parameter

Name Description Required

undefined

Responses

Code	Message	Datatype
200	User Settings updated successfully.
400	Bad request input data.
403	Unauthorized. The endpoint enforces authorization.
405	Method not allowed.
500	Internal server error, check server logs.

Notification

Fetch alert config for the given model.

GET

/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	Unauthorized. The endpoint enforces authorization.
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

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

Description

Parameters

Name Description Required Type In Example

model_id

string

path

Body Parameter

Name Description Required

undefined

Responses

Code	Message	Datatype
200	Model Alert Config was updated successfully.
400	Bad request input data.
403	Unauthorized. The endpoint enforces authorization.
405	Method not allowed.
500	Internal server error, check server logs.

Fetch channel config for notifications in DMM.

GET

/v2/api/notification/channel-config

Description

Responses

Code	Message	Datatype
200	Channel config fetched successfully.
400	Bad request input data.
403	Unauthorized. The endpoint enforces authorization.
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

/v2/api/notification/channel-config

Description

Body Parameter

Name Description Required

undefined

Responses

Code	Message	Datatype
200	Notification Channel Config was updated successfully.
400	Bad request input data.
403	Unauthorized. The endpoint enforces authorization.
405	Method not allowed.
500	Internal server error, check server logs.

Other

getPing

GET

/v2/api/ping

Description

Health check endpoint.

Responses

Code

Message

Datatype

200

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

postAnalyseDrift

POST

/v2/api/model/{model_id}/analyse-drift

Description

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.

Parameters

Name Description Required Type In Example

model_id

Identifier for the model to be updated.

string

path

Body Parameter

Name Description Required

undefined

Responses

Code	Message	Datatype
200	The drift analyse query was done successfully.
204	Empty response.
400	Bad request input data.
403	Unauthorized. The endpoint enforces authorization.
500	Internal 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

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	Unauthorized. The endpoint enforces authorization.
500	Internal server error, check server logs.

getDriftSchedulerQuery

GET

/v2/api/model/{model_id}/drift-scheduler-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	Unauthorized. The endpoint enforces authorization.
500	Internal server error, check server logs.

getDriftTrend

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

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	Unauthorized. The endpoint enforces authorization.
500	Internal server error, check server logs.

postSaveSchedulerQuery

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

Name Description Required Type In Example

model_id

Identifier for the model to be updated.

string

path

Body Parameter

Name Description Required

undefined

Responses

Code	Message	Datatype
200	The drift scheduler query was generated successfully.
403	Unauthorized. The endpoint enforces authorization.
500	Internal 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

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	Unauthorized. The endpoint enforces authorization.
500	Internal 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

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	Unauthorized. The endpoint enforces authorization.
500	Internal server error, check server logs.

getGetPredictionTraffic

GET

/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	Unauthorized. The endpoint enforces authorization.
500	Internal server error, check server logs.