domino logo
Tech Ecosystem
Get started with Python
Step 0: Orient yourself to DominoStep 1: Create a projectStep 2: Configure your projectStep 3: Start a workspaceStep 4: Get your files and dataStep 5: Develop your modelStep 6: Clean up WorkspacesStep 7: Deploy your model
Get started with R
Step 0: Orient yourself to Domino (R Tutorial)Step 1: Create a projectStep 2: Configure your projectStep 3: Start a workspaceStep 4: Get your files and dataStep 5: Develop your modelStep 6: Clean up WorkspacesStep 7: Deploy your model
Get Started with MATLAB
Step 1: Orient yourself to DominoStep 2: Create a Domino ProjectStep 3: Configure Your Domino ProjectStep 4: Start a MATLAB WorkspaceStep 5: Fetch and Save Your DataStep 6: Develop Your ModelStep 7: Clean Up Your Workspace
Step 8: Deploy Your Model
Scheduled JobsLaunchers
Step 9: Working with Domino Datasets
Domino Reference
Projects
Projects Overview
Revert Projects and Files
Revert a ProjectRevert a File
Projects PortfolioReference ProjectsProject Goals in Domino 4+
Git Integration
Git Repositories in DominoGit-based Projects with CodeSyncWorking from a Commit ID in Git
Jira Integration in DominoUpload Files to Domino using your BrowserFork and Merge ProjectsSearchSharing and CollaborationCommentsDomino Service FilesystemCompare File RevisionsArchive a Project
Advanced Project Settings
Project DependenciesProject TagsRename a ProjectSet up your Project to Ignore FilesUpload files larger than 550MBExporting Files as a Python or R PackageTransfer Project Ownership
Domino Runs
JobsDiagnostic Statistics with dominostats.jsonNotificationsResultsRun Comparison
Advanced Options for Domino Runs
Run StatesDomino Environment VariablesEnvironment Variables for Secure Credential StorageUse Apache Airflow with Domino
Scheduled Jobs
Domino Workspaces
WorkspacesUse Git in Your WorkspaceRecreate A Workspace From A Previous CommitUse Visual Studio Code in Domino WorkspacesPersist RStudio PreferencesAccess Multiple Hosted Applications in one Workspace Session
Spark on Domino
On-Demand Spark
On-Demand Spark OverviewValidated Spark VersionConfigure PrerequisitesWork with your ClusterManage DependenciesWork with Data
External Hadoop and Spark
Hadoop and Spark OverviewConnect to a Cloudera CDH5 cluster from DominoConnect to a Hortonworks cluster from DominoConnect to a MapR cluster from DominoConnect to an Amazon EMR cluster from DominoRun Local Spark on a Domino ExecutorUse PySpark in Jupyter WorkspacesKerberos Authentication
On-Demand Ray
On-Demand Ray OverviewValidated Ray VersionConfigure PrerequisitesWork with your ClusterManage DependenciesWork with Data
On-Demand Dask
On-Demand Dask OverviewValidated Dask VersionConfigure PrerequisitesWork with Your ClusterManage DependenciesWork with Data
Customize the Domino Software Environment
Environment ManagementDomino Standard EnvironmentsInstall Packages and DependenciesAdd Workspace IDEsAdding Jupyter Kernels
Partner Environments for Domino
Use MATLAB as a WorkspaceUse Stata as a WorkspaceUse SAS as a WorkspaceNVIDIA NGC Containers
Advanced Options for Domino Software Environment
Install Custom Packages in Domino with Git IntegrationAdd Custom DNS Servers to Your Domino EnvironmentConfigure a Compute Environment to User Private Cran/Conda/PyPi MirrorsUse TensorBoard in Jupyter Workspaces
Publish your Work
Publish a Model API
Model Publishing OverviewModel Invocation SettingsModel Access and CollaborationModel Deployment ConfigurationPromote Projects to ProductionExport Model Image
Publish a Web Application
App Publishing OverviewGet Started with DashGet Started with ShinyGet Started with FlaskContent Security Policies for Web Apps
Advanced Web Application Settings in Domino
App Scaling and PerformanceHost HTML Pages from DominoHow to Get the Domino Username of an App Viewer
Launchers
Launchers OverviewAdvanced Launcher Editor
Assets Portfolio Overview
Model Monitoring and Remediation
Monitor WorkflowsData Drift and Quality Monitoring
Set up Monitoring for Model APIs
Set up Prediction CaptureSet up Drift DetectionSet up Model Quality MonitoringSet up NotificationsSet Scheduled ChecksSet up Cohort Analysis
Set up Model Monitor
Connect a Data SourceRegister a ModelSet up Drift DetectionSet up Model Quality MonitoringSet up Cohort AnalysisSet up NotificationsSet Scheduled ChecksUnregister a Model
Use Monitoring
Access the Monitor DashboardAnalyze Data DriftAnalyze Model QualityExclude Features from Scheduled Checks
Remediation
Cohort Analysis
Review the Cohort Analysis
Remediate a Model API
Monitor Settings
API TokenHealth DashboardNotification ChannelsTest Defaults
Monitoring Config JSON
Supported Binning Methods
Model Monitoring APIsTroubleshoot the Model Monitor
Connect to your Data
Data in Domino
Datasets OverviewProject FilesDatasets Best Practices
Connect to Data Sources
External Data VolumesDomino Data Sources
Connect to External Data
Connect Domino to DataRobotConnect to Amazon S3 from DominoConnect to BigQuery from DominoConnect to Generic S3 from DominoConnect to IBM DB2 from DominoConnect to IBM Netezza from DominoConnect to Impala from DominoConnect to MSSQL from DominoConnect to MySQL from DominoConnect to Okera from DominoConnect to Oracle Database from DominoConnect to PostgreSQL from DominoConnect to Redshift from DominoConnect to Snowflake from DominoConnect to Teradata from Domino
Work with Data Best Practices
Work with Big Data in DominoWork with Lots of FilesMove Data Over a Network
Advanced User Configuration Settings
User API KeysDomino TokenOrganizations Overview
Use the Domino Command Line Interface (CLI)
Install the Domino Command Line (CLI)Domino CLI ReferenceDownload Files with the CLIForce-Restore a Local ProjectMove a Project Between Domino DeploymentsUse the Domino CLI Behind a Proxy
Browser Support
Get Help with Domino
Additional ResourcesGet Domino VersionContact Domino Technical SupportSupport Bundles
domino logo
About Domino
Domino Data LabKnowledge BaseData Science BlogTraining
User Guide
>
Domino Reference
>
Model Monitoring and Remediation
>
Model Monitoring APIs

Model Monitoring APIs

Note
API ReferenceDomino Model Monitor API

The API for Domino Model Monitor suite of applications.- V-0.1.0

/v2/api/ping

GET
()
Responses
Code200
DescriptionA no non-sense static body for full cycle web server health

/v2/metrics

GET
()
Responses
Code200
DescriptionPrometheus metrics endpoint.
Code400
DescriptionBad request input data.
Code500
DescriptionInternal server error, check server logs.

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

POST
()
Responses
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
()
Responses
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
()
Responses
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
()
Responses
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
()
Responses
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
()
Responses
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
()
Responses
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
()
Responses
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)
Responses
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)
Responses
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)
Responses
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
Responses
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)
Responses
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)
Responses
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)
Responses
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)
Responses
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)
Responses
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)
Responses
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)
Responses
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)
Responses
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)
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
NameRequiredDescriptionInTypeEnums
model_idquerystringUndefined
workbench_model_version_idquerystringUndefined
Responses
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
Responses
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
Responses
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)
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
NameRequiredDescriptionInTypeEnums
model_idquerystringUndefined
workbench_model_version_idquerystringUndefined
Responses
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
Responses
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
()
Responses
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
()
Responses
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
()
Responses
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)
Responses
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)
Responses
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
()
Responses
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
()
Responses
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
()
Responses
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
Responses
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.
Domino Data LabKnowledge BaseData Science BlogTraining
Copyright © 2022 Domino Data Lab. All rights reserved.