Note
API ReferenceDomino Model Monitor APIResponsesResponsesResponsesResponsesResponsesResponsesResponsesResponsesResponsesResponsesResponsesResponsesResponsesResponsesResponsesResponsesResponsesResponsesResponsesResponsesResponsesResponsesGets a DMM model either via a unique model identifier or via a unique combination of workbench model id and workbench model version idResponsesResponsesResponsesGets a DMM model summary either via a unique model identifier or via a unique combination of workbench model id and workbench model version idResponsesResponsesResponsesResponsesResponsesResponsesResponsesResponsesResponsesResponsesResponsesResponsesResponsesResponsesResponsesResponsesResponsesResponsesResponses
The API for Domino Model Monitor suite of applications.- V-0.1.0
/v2/api/ping
GET
()Code200
DescriptionA no non-sense static body for full cycle web server health
/v2/metrics
GET
()Code200
DescriptionPrometheus metrics endpoint.
Code400
DescriptionBad request input data.
Code500
DescriptionInternal server error, check server logs.
/v2/api/model/{model_id}/analyse-drift
POST
()Code200
DescriptionThe drift analyse query was done successfully.
Code204
DescriptionEmpty response.
Code400
DescriptionBad request input data.
Code403
DescriptionUnauthorised. The endpoint enforces authorisation.
Code500
DescriptionInternal server error, check server logs.
/v2/api/model/{model_id}/drift-user-query
GET
()Code200
DescriptionThe drift scheduler query was generated successfully.
Code403
DescriptionUnauthorised. The endpoint enforces authorisation.
Code500
DescriptionInternal server error, check server logs.
/v2/api/model/{model_id}/drift-scheduler-query
GET
()Code200
DescriptionThe drift scheduler query was generated successfully.
Code403
DescriptionUnauthorised. The endpoint enforces authorisation.
Code500
DescriptionInternal server error, check server logs.
/v2/api/model/{model_id}/{column_id}/drift-trend
GET
()Code200
DescriptionThe drift trend fetch query was done successfully.
Code400
DescriptionBad request input data.
Code403
DescriptionUnauthorised. The endpoint enforces authorisation.
Code500
DescriptionInternal server error, check server logs.
/v2/api/model/{model_id}/save-scheduler-query
POST
()Code200
DescriptionThe drift scheduler query was generated successfully.
Code403
DescriptionUnauthorised. The endpoint enforces authorisation.
Code500
DescriptionInternal server error, check server logs.
/v2/api/model/{model_id}/drift-schedule-checks-history
GET
()Code200
DescriptionGets the model timeline data
Code400
DescriptionBad request input data.
Code403
DescriptionUnauthorised. The endpoint enforces authorisation.
Code500
DescriptionInternal server error, check server logs.
/v2/api/model/{model_id}/{scheduler_id}/scheduled-check-drift-data
GET
()Code200
DescriptionGets the model timeline data
Code400
DescriptionBad request input data.
Code403
DescriptionUnauthorised. The endpoint enforces authorisation.
Code500
DescriptionInternal server error, check server logs.
/v2/api/model/get-prediction-traffic
GET
()Code200
DescriptionGets the model prediction traffic
Code400
DescriptionBad request input data.
Code403
DescriptionUnauthorised. The endpoint enforces authorisation.
Code500
DescriptionInternal server error, check server logs.
/v2/api/{model_id}/dataset-jobs
POST
(getDatasetJobs)Code200
DescriptionGets the list of jobs for the model
Code404
DescriptionDataset not found for the given identifier.
Code500
DescriptionInternal server error, check server logs.
/v2/api/model/{model_id}/dataset-timeline
GET
(getDatasetTimeline)Code200
DescriptionGets the dataset ingestion timeline
Code400
DescriptionBad request input data.
Code403
DescriptionUnauthorised. The endpoint enforces authorisation.
Code500
DescriptionInternal server error, check server logs.
/v2/api/datasources
GET
(getAllDataSources)Code200
DescriptionGets all the registered data sources.
Code400
DescriptionBad request input data.
Code403
DescriptionUnauthorised. The endpoint enforces authorisation.
Code405
DescriptionMethod not allowed.
Code500
DescriptionInternal server error, check server logs.
/v2/api/datasource
DELETE
(deleteDataSource)Parameters
NameRequiredDescriptionInTypeEnums
datasource_idquerystringUndefined
Code200
DescriptionThe data source object that was deleted.
Code400
DescriptionBad request input data.
Code403
DescriptionUnauthorised. The endpoint enforces authorisation.
Code405
DescriptionMethod not allowed.
Code500
DescriptionInternal server error, check server logs.
/v2/api/model/{model_id}/analyze-model-quality
POST
(analyzeModelQuality)Code200
DescriptionThe MQ analyze query was done successfully.
Code204
DescriptionEmpty response.
Code400
DescriptionBad request input data.
Code403
DescriptionUnauthorised. The endpoint enforces authorisation.
Code500
DescriptionInternal server error, check server logs.
/v2/api/model/{model_id}/model-quality-user-query
GET
(getModelQualityUserQuery)Code200
DescriptionThe model quality user query was fetched successfully.
Code204
DescriptionThe model quality user query does not exist for the user.
Code400
DescriptionBad request input data.
Code403
DescriptionUnauthorised. The endpoint enforces authorisation.
Code500
DescriptionInternal server error, check server logs.
/v2/api/model/{model_id}/model-quality-trend
GET
(getModelQualityTrend)Code200
DescriptionThe model quality trend was fetched successfully.
Code400
DescriptionBad request input data.
Code403
DescriptionUnauthorised. The endpoint enforces authorisation.
Code500
DescriptionInternal server error, check server logs.
/v2/api/model/{model_id}/model-quality-scheduler-query
GET
(getModelQualitySchedulerQuery)Code200
DescriptionThe model quality scheduler query was fetched successfully.
Code400
DescriptionBad request input data.
Code403
DescriptionUnauthorised. The endpoint enforces authorisation.
Code404
DescriptionModel Quality Scheduler Query not found.
Code500
DescriptionInternal server error, check server logs.
POST
(saveModelQualitySchedulerQuery)Code200
DescriptionThe model quality scheduler query was saved successfully.
Code400
DescriptionBad request input data.
Code403
DescriptionUnauthorised. The endpoint enforces authorisation.
Code404
DescriptionModel Quality Scheduler Query not found.
Code500
DescriptionInternal server error, check server logs.
/v2/api/model/{model_id}/model-quality-scheduled-checks-history
GET
(getModelQualityScheduledChecksTimeline)Code200
DescriptionGets the model timeline data
Code400
DescriptionBad request input data.
Code403
DescriptionUnauthorised. The endpoint enforces authorisation.
Code404
DescriptionModel not found or is deleted.
Code500
DescriptionInternal server error, check server logs.
/v2/api/model/{scheduled_check_id}/model-quality-scheduled-check-data
GET
(getModelQualityScheduledCheckData)Code200
DescriptionGets the scheduled check data
Code400
DescriptionBad request input data.
Code403
DescriptionUnauthorised. The endpoint enforces authorisation.
Code404
DescriptionData for passed Scheduled Check Id not found.
Code500
DescriptionInternal server error, check server logs.
/v2/api/model/{model_id}/traffic/ground-truth
GET
(getGroundTruthTraffic)Code200
DescriptionGets the ground truth traffic based on number of ground truth labels that matched prediction data.
Code400
DescriptionBad request input data.
Code403
DescriptionUnauthorised. The endpoint enforces authorisation.
Code404
DescriptionModel not found.
Code500
DescriptionInternal server error, check server logs.
/v2/api/model/{model_id}/register-dataset/{dataset_type}
/v2/api/model
GET
(getModelById)Parameters
NameRequiredDescriptionInTypeEnums
model_idquerystringUndefined
workbench_model_version_idquerystringUndefined
Code200
DescriptionSuccessfully fetched the Model.
Code400
DescriptionBad request input data.
Code403
DescriptionUnauthorised. The endpoint enforces authorisation.
Code404
DescriptionModel not found.
Code405
DescriptionMethod not allowed.
Code500
DescriptionInternal server error, check server logs.
DELETE
(deleteModelById)Parameters
NameRequiredDescriptionInTypeEnums
model_idquerystringUndefined
Code200
DescriptionSuccessfully deleted the Model.
Code400
DescriptionBad request input data.
Code403
DescriptionUnauthorised. The endpoint enforces authorisation.
Code404
DescriptionModel not found.
Code405
DescriptionMethod not allowed.
Code500
DescriptionInternal server error, check server logs.
/v2/api/models
GET
(listModels)Parameters
NameRequiredDescriptionInTypeEnums
pageNumberqueryintegerUndefined
pageSizequeryintegerUndefined
numberOfLastChecksToFetchqueryintegerUndefined
searchQueryquerystringUndefined
modelTypequeryUndefinedUndefined
Code200
DescriptionSuccessfully fetched the Model.
Code400
DescriptionBad request input data.
Code403
DescriptionUnauthorised. The endpoint enforces authorisation.
Code405
DescriptionMethod not allowed.
Code500
DescriptionInternal server error, check server logs.
/v2/api/get_model_summary
GET
(getModelSummary)Parameters
NameRequiredDescriptionInTypeEnums
model_idquerystringUndefined
workbench_model_version_idquerystringUndefined
Code200
DescriptionSuccessfully fetched the Model summary.
Code400
DescriptionBad request input data.
Code403
DescriptionUnauthorised. The endpoint enforces authorisation.
Code404
DescriptionModel not found.
Code405
DescriptionMethod not allowed.
Code500
DescriptionInternal server error, check server logs.
/v2/api/model/{model_id}/variables/summary
GET
(getModelVariablesSummary)Parameters
NameRequiredDescriptionInTypeEnums
model_idpathstringUndefined
Code200
DescriptionSuccessfully fetched the Model.
Code400
DescriptionBad request input data.
Code403
DescriptionUnauthorised. The endpoint enforces authorisation.
Code404
DescriptionModel not found.
Code405
DescriptionMethod not allowed.
Code500
DescriptionInternal server error, check server logs.
/v2/api/auth/login
GET
()Code302
DescriptionRedirects to keycloak login flow.
Code400
DescriptionBad request input data.
Code403
DescriptionUnauthorised. The endpoint enforces authorisation.
Code405
DescriptionMethod not allowed.
Code500
DescriptionInternal server error, check server logs.
/v2/api/auth/callback
GET
()Code302
DescriptionRedirects to keycloak login flow.
Code400
DescriptionBad request input data.
Code403
DescriptionUnauthorised. The endpoint enforces authorisation.
Code405
DescriptionMethod not allowed.
Code500
DescriptionInternal server error, check server logs.
/v2/api/auth/logout
GET
()Code302
DescriptionRedirects to logout screen
Code400
DescriptionBad request input data.
Code403
DescriptionUnauthorised. The endpoint enforces authorisation.
Code405
DescriptionMethod not allowed.
Code500
DescriptionInternal server error, check server logs.
/v2/api/auth/user/current
GET
(getCurrentUser)Code200
Descriptiongets user data
Code400
DescriptionBad request input data.
Code403
DescriptionUnauthorised. The endpoint enforces authorisation.
Code405
DescriptionMethod not allowed.
Code500
DescriptionInternal server error, check server logs.
/v2/api/auth/get_oidc_details
GET
(getOIDCDetails)Code200
Descriptiongets OIDC details
Code400
DescriptionBad request input data.
Code403
DescriptionUnauthorised. The endpoint enforces authorisation.
Code405
DescriptionMethod not allowed.
Code500
DescriptionInternal server error, check server logs.
/v2/api/auth/user/generate_api_key
GET
()Code302
DescriptionRedirects to keycloak login flow for API Key (Offline Token) Generation.
Code400
DescriptionBad request input data.
Code403
DescriptionUnauthorised. The endpoint enforces authorisation.
Code405
DescriptionMethod not allowed.
Code500
DescriptionInternal server error, check server logs.
/v2/api/auth/user/generate_api_key_callback
GET
()Code302
DescriptionRedirects to API Key Generation.
Code400
DescriptionBad request input data.
Code403
DescriptionUnauthorised. The endpoint enforces authorisation.
Code405
DescriptionMethod not allowed.
Code500
DescriptionInternal server error, check server logs.
/v2/api/auth/user/api_key
GET
()Code200
Descriptiongets user api key
Code400
DescriptionBad request input data.
Code403
DescriptionUnauthorised. The endpoint enforces authorisation.
Code405
DescriptionMethod not allowed.
Code500
DescriptionInternal server error, check server logs.
/v2/api/auth/user/revoke_api_key
/v2/api/workbench/model/version/summary
GET
Get summary for workbench model versions (getModelVersionSummary)Parameters
NameRequiredDescriptionInTypeEnums
model_version_idsa string of comma separated workbench model version ids.querystringUndefined
start_datequerynumberUndefined
end_datequerynumberUndefined
Code200
DescriptionModel summaries were fetched successfully.
Code400
DescriptionBad request input data.
Code403
DescriptionUnauthorised. The endpoint enforces authorisation.
Code405
DescriptionMethod not allowed.
Code500
DescriptionInternal server error, check server logs.
/v2/api/setting/user
GET
Get the existing user setting for the given user. (getUserSetting)Code200
DescriptionUser Settings fetched successfully.
Code400
DescriptionBad request input data.
Code403
DescriptionUnauthorised. The endpoint enforces authorisation.
Code405
DescriptionMethod not allowed.
Code500
DescriptionInternal server error, check server logs.
POST
Update the existing user setting for the user. (updateUserSetting)Code200
DescriptionUser Settings updated successfully.
Code400
DescriptionBad request input data.
Code403
DescriptionUnauthorised. The endpoint enforces authorisation.
Code405
DescriptionMethod not allowed.
Code500
DescriptionInternal server error, check server logs.
/v2/api/setting/default/drift
GET
Get drift default settings (getDriftDefaultSettings)Parameters
NameRequiredDescriptionInTypeEnums
is_activeWhether to fetch only the active drift default setting or not.querybooleanUndefined
Code200
DescriptionDrift default settings fetched successfully.
Code400
DescriptionBad request input data.
Code403
DescriptionUnauthorised. The endpoint enforces authorisation.
Code405
DescriptionMethod not allowed.
Code500
DescriptionInternal server error, check server logs.
/v2/api/setting/default/metric
GET
Get model quality metric default settings (getMetricDefaultSettings)Code200
DescriptionModel Quality Metric default settings fetched successfully.
Code400
DescriptionBad request input data.
Code403
DescriptionUnauthorised. The endpoint enforces authorisation.
Code405
DescriptionMethod not allowed.
Code500
DescriptionInternal server error, check server logs.
/v2/api/notification/model-config/{model_id}
GET
Fetch alert config for the given model. (getAlertConfigForModel)Code200
DescriptionModel Alert Config was fetched successfully.
Code400
DescriptionBad request input data.
Code403
DescriptionUnauthorised. The endpoint enforces authorisation.
Code404
DescriptionModel Alert Config not found for the given model id.
Code405
DescriptionMethod not allowed.
Code500
DescriptionInternal server error, check server logs.
POST
Create or Update the exisiting model alert config. (createOrUpdateModelAlertConfig)Code200
DescriptionModel Alert Config was updated successfully.
Code400
DescriptionBad request input data.
Code403
DescriptionUnauthorised. The endpoint enforces authorisation.
Code405
DescriptionMethod not allowed.
Code500
DescriptionInternal server error, check server logs.
/v2/api/notification/channel-config
GET
Fetch channel config for notifications in DMM. (getChannelConfig)Code200
DescriptionChannel config fetched successfully.
Code400
DescriptionBad request input data.
Code403
DescriptionUnauthorised. The endpoint enforces authorisation.
Code404
DescriptionNotification Channel config not found.
Code405
DescriptionMethod not allowed.
Code500
DescriptionInternal server error, check server logs.
POST
Create or Update existing channel config for notifications in DMM. (createOrUpdateChannelConfig)Code200
DescriptionNotification Channel Config was updated successfully.
Code400
DescriptionBad request input data.
Code403
DescriptionUnauthorised. The endpoint enforces authorisation.
Code405
DescriptionMethod not allowed.
Code500
DescriptionInternal server error, check server logs.