About Domino
Domino Data LabKnowledge BaseData Science BlogTraining

Model Monitoring APIs

The Model Monitoring API gives you programmatic access to the Model Monitor.

Note

Endpoints

getPing

GET

/v2/api/ping

Description

Health check endpoint.

Responses
CodeMessageDatatype

200

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

getMetrics

GET

/v2/metrics

Description

Prometheus metrics endpoint.

Responses
CodeMessageDatatype

200

Prometheus metrics endpoint.

400

Bad request input data.

500

Internal server error, check server logs.

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
NameDescriptionRequiredTypeInExample

model_id

Identifier for the model to be updated.

string

path

Body Parameter
NameDescriptionRequired

undefined

Responses
CodeMessageDatatype

200

The drift analyse query was done successfully.

204

Empty response.

400

Bad request input data.

403

Unauthorised. The endpoint enforces authorisation.

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
NameDescriptionRequiredTypeInExample

model_id

Identifier for the model to be updated.

string

path

Responses
CodeMessageDatatype

200

The drift scheduler query was generated successfully.

403

Unauthorised. The endpoint enforces authorisation.

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
NameDescriptionRequiredTypeInExample

model_id

Identifier for the model to be updated.

string

path

Responses
CodeMessageDatatype

200

The drift scheduler query was generated successfully.

403

Unauthorised. The endpoint enforces authorisation.

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
NameDescriptionRequiredTypeInExample

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
CodeMessageDatatype

200

The drift trend fetch query was done successfully.

400

Bad request input data.

403

Unauthorised. The endpoint enforces authorisation.

500

Internal server error, check server logs.

postSaveSchedulerQuery

POST

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

Description

Returns drift scheduler config for the model. The endpoint is behind the old backend's auth mechanism.

Parameters
NameDescriptionRequiredTypeInExample

model_id

Identifier for the model to be updated.

string

path

Body Parameter
NameDescriptionRequired

undefined

Responses
CodeMessageDatatype

200

The drift scheduler query was generated successfully.

403

Unauthorised. The endpoint enforces authorisation.

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
NameDescriptionRequiredTypeInExample

model_id

string

path

start_date

string

query

end_date

string

query

Responses
CodeMessageDatatype

200

Gets the model timeline data

400

Bad request input data.

403

Unauthorised. The endpoint enforces authorisation.

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
NameDescriptionRequiredTypeInExample

model_id

string

path

scheduler_id

string

path

sortOrder

string

query

sortOn

string

query

pageNumber

string

query

pageSize

string

query

searchQuery

string

query

Responses
CodeMessageDatatype

200

Gets the model timeline data

400

Bad request input data.

403

Unauthorised. The endpoint enforces authorisation.

500

Internal server error, check server logs.

getGetPredictionTraffic

GET

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

Description

Gets the model prediction traffic

Parameters
NameDescriptionRequiredTypeInExample

model_ids

string

query

start_date

number

query

end_date

number

query

Responses
CodeMessageDatatype

200

Gets the model prediction traffic

400

Bad request input data.

403

Unauthorised. The endpoint enforces authorisation.

500

Internal server error, check server logs.

getDatasetJobs

POST

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

Description

Get the list of jobs associated with a model

Parameters
NameDescriptionRequiredTypeInExample

model_id

Identifier of the model

string

path

Body Parameter
NameDescriptionRequired

undefined

Responses
CodeMessageDatatype

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
NameDescriptionRequiredTypeInExample

model_id

string

path

start_date

number

query

end_date

number

query

Responses
CodeMessageDatatype

200

Gets the dataset ingestion timeline

400

Bad request input data.

403

Unauthorised. The endpoint enforces authorisation.

500

Internal server error, check server logs.

getAllDataSources

GET

/v2/api/datasources

Description

Gets all Data sources.

Responses
CodeMessageDatatype

200

Gets all the registered data sources.

400

Bad request input data.

403

Unauthorised. The endpoint enforces authorisation.

405

Method not allowed.

500

Internal server error, check server logs.

createDataSource

PUT

/v2/api/datasource

Description

Delete a datasource.

Body Parameter
NameDescriptionRequired

undefined

Responses
CodeMessageDatatype

200

Data source added/updated successfully

400

Bad request input data.

403

Unauthorised. The endpoint enforces authorisation.

405

Method not allowed.

500

Internal server error, check server logs.

deleteDataSource

DELETE

/v2/api/datasource

Description

Delete a datasource.

Parameters
NameDescriptionRequiredTypeInExample

datasource_id

string

query

Responses
CodeMessageDatatype

200

The data source object that was deleted.

400

Bad request input data.

403

Unauthorised. The endpoint enforces authorisation.

405

Method not allowed.

500

Internal server error, check server logs.

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_id

Identifier for the model to be updated.

string

path

Body Parameter
NameDescriptionRequired

undefined

Responses
CodeMessageDatatype

200

The MQ analyze query was done successfully.

204

Empty response.

400

Bad request input data.

403

Unauthorised. The endpoint enforces authorisation.

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
NameDescriptionRequiredTypeInExample

model_id

Identifier for the model.

string

path

Responses
CodeMessageDatatype

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

Unauthorised. The endpoint enforces authorisation.

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
NameDescriptionRequiredTypeInExample

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
CodeMessageDatatype

200

The model quality trend was fetched successfully.

400

Bad request input data.

403

Unauthorised. The endpoint enforces authorisation.

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
NameDescriptionRequiredTypeInExample

model_id

Identifier for the model.

string

path

Responses
CodeMessageDatatype

200

The model quality scheduler query was fetched successfully.

400

Bad request input data.

403

Unauthorised. The endpoint enforces authorisation.

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
NameDescriptionRequiredTypeInExample

model_id

Identifier for the model.

string

path

Body Parameter
NameDescriptionRequired

undefined

Responses
CodeMessageDatatype

200

The model quality scheduler query was saved successfully.

400

Bad request input data.

403

Unauthorised. The endpoint enforces authorisation.

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
NameDescriptionRequiredTypeInExample

model_id

string

path

start_date

string

query

end_date

string

query

Responses
CodeMessageDatatype

200

Gets the model timeline data

400

Bad request input data.

403

Unauthorised. The endpoint enforces authorisation.

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
NameDescriptionRequiredTypeInExample

scheduled_check_id

string

path

Responses
CodeMessageDatatype

200

Gets the scheduled check data

400

Bad request input data.

403

Unauthorised. The endpoint enforces authorisation.

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
NameDescriptionRequiredTypeInExample

model_id

string

path

startTimestamp

number

query

endTimestamp

number

query

Responses
CodeMessageDatatype

200

Gets the ground truth traffic based on number of ground truth labels that matched prediction data.

400

Bad request input data.

403

Unauthorised. The endpoint enforces authorisation.

404

Model not found.

500

Internal 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_id

string

path

dataset_type

string

path

Body Parameter
NameDescriptionRequired

undefined

Responses
CodeMessageDatatype

200

Successfully registered dataset to the Model.

400

Bad request input data.

403

Unauthorised. The endpoint enforces authorisation.

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
NameDescriptionRequiredTypeInExample

model_id

string

query

workbench_model_version_id

string

query

Responses
CodeMessageDatatype

200

Successfully fetched the Model.

400

Bad request input data.

403

Unauthorised. The endpoint enforces authorisation.

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
NameDescriptionRequired

undefined

Responses
CodeMessageDatatype

200

Successfully registered the Model.

400

Bad request input data.

403

Unauthorised. The endpoint enforces authorisation.

405

Method not allowed.

500

Internal server error, check server logs.

deleteModelById

DELETE

/v2/api/model

Description

Model Operations.

Parameters
NameDescriptionRequiredTypeInExample

model_id

string

query

Responses
CodeMessageDatatype

200

Successfully deleted the Model.

400

Bad request input data.

403

Unauthorised. The endpoint enforces authorisation.

404

Model not found.

405

Method not allowed.

500

Internal server error, check server logs.

listModels

GET

/v2/api/models

Description

Parameters
NameDescriptionRequiredTypeInExample

pageNumber

integer

query

pageSize

integer

query

numberOfLastChecksToFetch

integer

query

searchQuery

string

query

modelType

Undefined

query

Responses
CodeMessageDatatype

200

Successfully fetched the Model.

400

Bad request input data.

403

Unauthorised. The endpoint enforces authorisation.

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
NameDescriptionRequiredTypeInExample

model_id

string

query

workbench_model_version_id

string

query

Responses
CodeMessageDatatype

200

Successfully fetched the Model summary.

400

Bad request input data.

403

Unauthorised. The endpoint enforces authorisation.

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
NameDescriptionRequiredTypeInExample

model_id

string

path

Responses
CodeMessageDatatype

200

Successfully fetched the Model.

400

Bad request input data.

403

Unauthorised. The endpoint enforces authorisation.

404

Model not found.

405

Method not allowed.

500

Internal server error, check server logs.

getLogin

GET

/v2/api/auth/login

Description

Initiates login flow.

Responses
CodeMessageDatatype

302

Redirects to keycloak login flow.

400

Bad request input data.

403

Unauthorised. The endpoint enforces authorisation.

405

Method not allowed.

500

Internal server error, check server logs.

getCallback

GET

/v2/api/auth/callback

Description

Callback URL for OAuth login flow.

Parameters
NameDescriptionRequiredTypeInExample

session_state

string

query

code

string

query

state

string

query

Responses
CodeMessageDatatype

302

Redirects to keycloak login flow.

400

Bad request input data.

403

Unauthorised. The endpoint enforces authorisation.

405

Method not allowed.

500

Internal server error, check server logs.

getLogout

GET

/v2/api/auth/logout

Description

Initiates logout.

Responses
CodeMessageDatatype

302

Redirects to logout screen

400

Bad request input data.

403

Unauthorised. The endpoint enforces authorisation.

405

Method not allowed.

500

Internal server error, check server logs.

getCurrentUser

GET

/v2/api/auth/user/current

Description

Get current user Information.

Responses
CodeMessageDatatype

200

gets user data

400

Bad request input data.

403

Unauthorised. The endpoint enforces authorisation.

405

Method not allowed.

500

Internal server error, check server logs.

getOIDCDetails

GET

/v2/api/auth/get_oidc_details

Description

Get OIDC details.

Responses
CodeMessageDatatype

200

gets OIDC details

400

Bad request input data.

403

Unauthorised. The endpoint enforces authorisation.

405

Method not allowed.

500

Internal server error, check server logs.

getGenerateApiKey

GET

/v2/api/auth/user/generate_api_key

Description

Initiates API Key (Offline Token) login flow.

Responses
CodeMessageDatatype

302

Redirects to keycloak login flow for API Key (Offline Token) Generation.

400

Bad request input data.

403

Unauthorised. The endpoint enforces authorisation.

405

Method not allowed.

500

Internal server error, check server logs.

getGenerateApiKeyCallback

GET

/v2/api/auth/user/generate_api_key_callback

Description

Callback URL for OAuth login Offline Token flow.

Parameters
NameDescriptionRequiredTypeInExample

session_state

string

query

code

string

query

state

string

query

Responses
CodeMessageDatatype

302

Redirects to API Key Generation.

400

Bad request input data.

403

Unauthorised. The endpoint enforces authorisation.

405

Method not allowed.

500

Internal server error, check server logs.

getApiKey

GET

/v2/api/auth/user/api_key

Description

Gets current user key.

Responses
CodeMessageDatatype

200

gets user api key

400

Bad request input data.

403

Unauthorised. The endpoint enforces authorisation.

405

Method not allowed.

500

Internal server error, check server logs.

putRevokeApiKey

PUT

/v2/api/auth/user/revoke_api_key

Description

Revokes user's api key.

Responses
CodeMessageDatatype

200

revokes user api key

400

Bad request input data.

403

Unauthorised. The endpoint enforces authorisation.

405

Method not allowed.

500

Internal server error, check server logs.

Get summary for workbench model versions

GET

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

Description

Parameters
NameDescriptionRequiredTypeInExample

model_version_ids

a string of comma separated workbench model version ids.

string

query

start_date

number

query

end_date

number

query

Responses
CodeMessageDatatype

200

Model summaries were fetched successfully.

400

Bad request input data.

403

Unauthorised. The endpoint enforces authorisation.

405

Method not allowed.

500

Internal server error, check server logs.

Domino Data LabKnowledge BaseData Science BlogTraining
Copyright © 2022 Domino Data Lab. All rights reserved.