Model Monitoring APIs

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
Scheduler
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
`jobHistoryRequest`	jobHistoryRequest

jobHistoryRequest

jobHistoryRequest

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

createDataSource

PUT

/v2/api/datasource

Description

Create or delete a datasource.

Body Parameter

Name Description Required

Name	Description	Required
`dataSourceRequest`	dataSourceRequest

dataSourceRequest

dataSourceRequest

Responses

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

deleteDataSource

DELETE

/v2/api/datasource

Description

Create or 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	Forbidden. The endpoint enforces permissions.
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
`modelQualityQueryRequest`	modelQualityQueryRequest

modelQualityQueryRequest

modelQualityQueryRequest

Responses

Code	Message	Datatype
200	The MQ analyze query was done successfully.
204	Empty response.
400	Bad request input data.
403	Forbidden. The endpoint enforces permissions.
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	Forbidden. The endpoint enforces permissions.
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	Forbidden. The endpoint enforces permissions.
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	Forbidden. The endpoint enforces permissions.
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
`modelQualityQueryRequest`	modelQualityQueryRequest

modelQualityQueryRequest

modelQualityQueryRequest

Responses

Code	Message	Datatype
200	The model quality scheduler query was saved successfully.
400	Bad request input data.
403	Forbidden. The endpoint enforces permissions.
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	Forbidden. The endpoint enforces permissions.
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	Forbidden. The endpoint enforces permissions.
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	Forbidden. The endpoint enforces permissions.
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
`datasetRegistrationConfigRequest`	datasetRegistrationConfigRequest

datasetRegistrationConfigRequest

datasetRegistrationConfigRequest

Responses

Code	Message	Datatype
200	Successfully registered dataset to the Model.
400	Bad request input data.
403	Forbidden. The endpoint enforces permissions.
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	Forbidden. The endpoint enforces permissions.
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
`modelUpdateRequest`	modelUpdateRequest

modelUpdateRequest

modelUpdateRequest

Responses

Code	Message	Datatype
200	Successfully updated the model.
400	Bad request input data.
403	Forbidden. The endpoint enforces permissions.
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
`modelRegistrationConfigRequest`	modelRegistrationConfigRequest

modelRegistrationConfigRequest

modelRegistrationConfigRequest

Responses

Code	Message	Datatype
200	Successfully registered the Model.
400	Bad request input data.
403	Forbidden. The endpoint enforces permissions.
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	Forbidden. The endpoint enforces permissions.
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	Forbidden. The endpoint enforces permissions.
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	Forbidden. The endpoint enforces permissions.
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	Forbidden. The endpoint enforces permissions.
404	Model not found.
405	Method not allowed.
500	Internal server error, check server logs.

updateModelVisibility

PUT

/v2/api/model/{model_id}/visibility

Description

Updates the visibility of a standalone DMM model

Parameters

Name Description Required Type In Example

Name	Description	Required	Type	In	Example
`model_id`			string	path
`visibility`			Undefined	query

model_id

string

path

visibility

Undefined

query

Responses

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

getModelCollaborators

GET

/v2/api/model/{model_id}/collaborators

Description

Fetches all collaborators for a standalone DMM model

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's collaborators.
400	Bad request input data.
403	Forbidden. The endpoint enforces permissions.
404	Model not found.
405	Method not allowed.
500	Internal server error, check server logs.

addCollaborators

POST

/v2/api/model/{model_id}/collaborators

Description

Adds collaborators to a standalone DMM model

Parameters

Name Description Required Type In Example

model_id

string

path

Body Parameter

Name Description Required

collaboratorRequestArray

collaboratorRequestArray

Responses

Code	Message	Datatype
200	Successfully add a collaborator to model.
400	Bad request input data.
403	Forbidden. The endpoint enforces permissions.
404	Model not found.
405	Method not allowed.
500	Internal server error, check server logs.

updateCollaboratorRole

PUT

/v2/api/model/{model_id}/collaborators

Description

Updates an existing collaborator for a standalone DMM model

Parameters

Name Description Required Type In Example

model_id

string

path

Body Parameter

Name Description Required

collaboratorRequest

collaboratorRequest

Responses

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

deleteCollaborator

DELETE

/v2/api/model/{model_id}/collaborators

Description

Deletes an existing collaborator for a standalone DMM model

Parameters

Name Description Required Type In Example

model_id

string

path

collaborator_id

string

query

Responses

Code	Message	Datatype
200	Successfully removed a collaborator from a model.
400	Bad request input data.
403	Forbidden. The endpoint enforces permissions.
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

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	Forbidden. The endpoint enforces permissions.
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

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	Forbidden. The endpoint enforces permissions.
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

driftDefaultSettingUpdateRequestBodyItemArray

driftDefaultSettingUpdateRequestBodyItemArray

Responses

Code	Message	Datatype
200	Drift Default settings updated successfully.
400	Bad request input data.
403	Forbidden. The endpoint enforces permissions.
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	Forbidden. The endpoint enforces permissions.
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

defaultSettingUpdateRequestBodyItemArray

defaultSettingUpdateRequestBodyItemArray

Responses

Code	Message	Datatype
200	Model Quality Metric Default settings updated successfully.
400	Bad request input data.
403	Forbidden. The endpoint enforces permissions.
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	Forbidden. The endpoint enforces permissions.
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

userSetting

userSetting

Responses

Code	Message	Datatype
200	User Settings updated successfully.
400	Bad request input data.
403	Forbidden. The endpoint enforces permissions.
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	Forbidden. The endpoint enforces permissions.
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

modelAlertConfigUpdateRequestBody

modelAlertConfigUpdateRequestBody

Responses

Code	Message	Datatype
200	Model Alert Config was updated successfully.
400	Bad request input data.
403	Forbidden. The endpoint enforces permissions.
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	Forbidden. The endpoint enforces permissions.
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

smtpChannelConfig

smtpChannelConfig

Responses

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

Sends test mail

POST

/scheduler/test_email

Description

Body Parameter

Name Description Required

Responses

Code

Message

Datatype

200

send test mail

Scheduler

Pauses schedule job

POST

/schedule/{schedulerJobId}/unschedule_scheduler_job

Description

Parameters

Name Description Required Type In Example

schedulerJobId

string

path

Responses

Code

Message

Datatype

200

Pauses schedule job returns true is done successfully

Updates scheduler job of a model

POST

/scheduler/update_scheduler_config

Description

Body Parameter

Name Description Required

Responses

Code

Message

Datatype

200

Updates scheduler job of a model

Gets schedule check data by schedule job ID

GET

/scheduler/{scheduleCheckId}/get_schedule_check_by_id

Description

Parameters

Name Description Required Type In Example

scheduleCheckId

string

path

Responses

Code

Message

Datatype

200

scheduled check data

Creates a schedule check for a model drift

POST

/scheduler/create_drift_schedule_check

Description

Body Parameter

Name Description Required

Responses

Code

Message

Datatype

200

Creates a schedule check for a model drift

Gets schedule check job of a model drift

GET

/scheduler/{modelId}/get_drift_schedule_check

Description

Parameters

Name Description Required Type In Example

modelId

string

path

Responses

Code

Message

Datatype

200

Gets schedule check job of a model drfit

Creates a schedule check for a model quality

POST

/scheduler/create_quality_schedule_check

Description

Body Parameter

Name Description Required

Responses

Code

Message

Datatype

200

Creates a schedule check for a model quality

Gets schedule check job of a model quality

GET

/scheduler/{modelId}/get_quality_schedule_check

Description

Parameters

Name Description Required Type In Example

modelId

string

path

Responses

Code

Message

Datatype

200

Gets schedule check job of a model quality

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

driftAnalyzeRequest

driftAnalyzeRequest

Responses

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

featureQueryConfig

featureQueryConfig

Responses

Code	Message	Datatype
200	The drift scheduler query was generated successfully.
403	Forbidden. The endpoint enforces permissions.
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	Forbidden. The endpoint enforces permissions.
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	Forbidden. The endpoint enforces permissions.
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	Forbidden. The endpoint enforces permissions.
500	Internal server error, check server logs.

Models

datasetType

Type

Description

Example

Format

string

prediction

ground_truth

pingPong

Field Name

Required

Type

Description

Example

ping

String

The ping keyword, doesn't represent anything really.

pong

alertCondition

Field Name

Required

Type

Description

Example

operator

String

The math operator for the condition, like < or <=.

lower

Number

The lower bound for the condition

upper

Number

The upper bound for the condition

featureQuery

Field Name

Required

Type

Description

Example

String

Identifier of the feature in a model

name

String

Name for the model feature

type

String

Type of the feature - feature, prediction, row identifier, timestamp

value

String

Type of the feature value - categorical or numerical

alertable

Boolean

Whether this feature is alertable for not

algorithm

String

Algorithm function used for the check query

condition

alertCondition

pagination

Field Name

Required

Type

Description

Example

pageSize

Integer

pageNumber

Integer

sortOrder

Integer

sortOn

String

column_name

divergence

model_column_id

feature_importance

created_on

created_at

driftAnalyzeRequest

Field Name

Required

Type

Description

Example

modelId

String

startDate

Number

endDate

Number

searchQuery

String

config

List of featureQuery

pagination

distribution

Field Name

Required

Type

Description

Example

binValues

List of string

The "bin" for a statistical distribution. May be numerical or categorical.

counts

List of integer

An array of counts representing the bin distribution in the data.

normalizedValues

List of number

Normalised form, or proportional representation, of "counts" in the data

driftCalculations

Field Name

Required

Type

Description

Example

String

Feature's unique identifier

name

String

Column's name used during model registration.

importance

Number

Custom feature importance value used during the model registration.

drift

Number

Feature's calculated drift for the requested query.

pValue

Number

Feature's calculated p-value for the requested query.

drifted

Boolean

Boolean to suggest whether the feature has drifted for the input query.

alertable

Boolean

Boolean to suggest whether this feature is enabled for scheduled alerts.

columnType

String

Column type for column

prediction

feature

valueType

String

Algorithm function used for the check query

numerical

categorical

algorithm

String

Algorithm function used for the check query

driftTrends

List of array

Drift values for time periods representing the drift trend.

error

String

Error occurred during computing for a feature

training

distribution

prediction

distribution

condition

alertCondition

driftAnalyzeResponse

Field Name

Required

Type

Description

Example

totalCount

Number

calculatedOn

Number

Timestamp of time when the query was performed.

start

Number

Start time for the data used for the query.

end

Number

End time for the data used for the query.

records

Object

Number of records (rows) used for the query.

features

List of driftCalculations

Drift calculations for selected columns for the query.

pagination

driftUserQuery

Field Name

Required

Type

Description

Example

model_id

String

Unique identifier of the model for this query

user_id

String

User Id

features

List of featureQuery

Algorithm and alert condition for features for the model

driftSchedulerQuery

Field Name

Required

Type

Description

Example

model_id

String

Unique identifier of the model for this query

features

List of featureQuery

Algorithm and alert condition for features for the model

featureQueryConfig

Field Name

Required

Type

Description

Example

config

List of featureQuery

driftHistoryTimeline

Field Name

Required

Type

Description

Example

String

time

Integer

columnsDrifted

Integer

columnsNotDrifted

Integer

driftHistoryTimelineArray

Type

Description

Example

Format

array

divergence

Field Name

Required

Type

Description

Example

divergence

Number

pValue

Number

divergenceRule

Field Name

Required

Type

Description

Example

operator

String

valuesToCheck

List of number

columnDriftAndDistributionCalculation

Field Name

Required

Type

Description

Example

String

columnName

String

columnType

String

valueType

String

featureImportance

Number

algorithm

String

modelColumnId

String

modelCalculationId

String

columnDriftStatus

Boolean

divergence

divergenceRule

trainingDistribution

distribution

predictionDistribution

distribution

driftHistoryData

Field Name

Required

Type

Description

Example

pagination

totalCount

Integer

dataForCheck

Object

columnData

List of columnDriftAndDistributionCalculation

searchQuery

String

dataTraffic

Field Name

Required

Type

Description

Example

queries

Number

date

Integer

modelTraffic

Field Name

Required

Type

Description

Example

traffic

List of dataTraffic

A list that contains the traffic data for model.

modelId

String

The model id.

60116865cd9ab24dd866cfc6

modelTrafficArray

Type

Description

Example

Format

array

jobPagination

Field Name

Required

Type

Description

Example

order

Integer

The sorting order, 1 for ascending and -1 for descending

-1

sort

String

The sorting key to be used

created_at

records

page

Integer

The page number for the data to be fetched

size

Integer

The page size to be used for fetching the data

jobType

Type

Description

Example

Format

string

Type of processing, can be training or prediction.

jobDashboardFilter

Field Name

Required

Type

Description

Example

status

List of string

Status of the dataset job

job_type

List of jobType

Type of the dataset job

jobHistoryRequest

Field Name

Required

Type

Description

Example

start

Integer

Start Date for the Dataset range

end

Integer

End Date for the Dataset range

pagination

jobPagination

String

Search key for dataset name

filters

jobDashboardFilter

featureSetDetails

Field Name

Required

Type

Description

Example

featureSetId

String

The version id for the current feature set version.

featureSetVersionId

String

The feature set id of the feature set to which the current feature set version belongs to.

actionableInsightsDetails

Field Name

Required

Type

Description

Example

domino_job_url

String

The URL of the Domino Job.

domino_results_url

String

URL at which the results can be accessed.

datasourceType

Type

Description

Example

Format

string

Type of the datasource to which the dataset belongs.

generic_s3

azure_blob

azure_data_lake_gen_2

google_cloud_storage

azure_data_lake_gen_1

hdfs

nfs

snowflake

jobHistoryResponse

Field Name

Required

Type

Description

Example

job_id

String

Unique Identifier of a dataset job

dataset_id

String

Unique Identifier of a dataset

feature_set_details

featureSetDetails

actionable_insights_details

actionableInsightsDetails

dataset_name

String

Name of the dataset associated with the job

datasource_name

String

Name of the datasource, the dataset belongs to

datasource_type

datasourceType

job_type

String

Type of the dataset job, such as training, prediction

training

prediction

ground_truth

actionable_insights

registered_on

Integer

The timestamp, when dataset was registered on

records

Integer

Number of records processed in the dataset job

status

String

Processing status of the dataset job

pending

processing

done

failed

skipped

dataset_path

String

The path of the dataset

errors

List of string

list of errors encountered during the job processing

warnings

List of string

list of warnings encountered during the job processing

infos

List of string

list of infos encountered during the job processing

listJobResponse

Field Name

Required

Type

Description

Example

total

Integer

Total number of jobs qualified for the query sent, without pagination

jobs

List of jobHistoryResponse

List of jobs by pagination

datasetIngestTimeline

Field Name

Required

Type

Description

Example

date

Integer

Epoch date value.

prediction

Integer

Prediction row count.

ground_truth

Integer

GT labels count.

datasetIngestTimelineArray

Type

Description

Example

Format

array

dataSourceResponseCommon

Field Name

Required

Type

Description

Example

String

ID of the data source object.

name

String

Name of the data source.

type

String

Type of data source.

user_id

String

ID of the user who created the data source.

username

String

User who has created the data source.

created_at

Number

Created time of the data source.

updated_at

Number

Last updated time of the data source.

s3Response

Field Name

Required

Type

Description

Example

config

Object

S3 Configuration options.

genericS3Response

Field Name

Required

Type

Description

Example

config

Object

Generic S3 Configuration options.

azureBlobResponse

Field Name

Required

Type

Description

Example

config

Object

Azure Blob Configuration options.

adls2CommonConfigResponse

Field Name

Required

Type

Description

Example

container

String

Azure Storage container.

account

String

Azure Storage Account.

auth

String

Azure Storage Auth Type.

adls2SharedKeyConfigResponse

Type

Description

Example

Format

Azure Data Lake Gen 2 Shared Key Config Response Object.

adls2OAuth2ConfigResponse

Field Name

Required

Type

Description

Example

o_auth2_config

Object

OAuth 2 config object.

adls2ConfigResponse

Type

Description

Example

Format

azureDataLakeGen2Response

Field Name

Required

Type

Description

Example

config

adls2ConfigResponse

googleCloudStorageResponse

Field Name

Required

Type

Description

Example

config

Object

Google Cloud Storage Configuration options.

adls1CommonConfigResponse

Field Name

Required

Type

Description

Example

container

String

Azure Storage container.

auth

String

Azure Storage Auth Type.

adls1ClientCredentialsConfigResponse

Field Name

Required

Type

Description

Example

token_endpoint

String

Endpoint to be used for authentication.

application_id

String

Application ID to be used for authentication.

secret_key

String

Secret Key to be used for authentication.

adls1ManagedIdentityConfigResponse

Field Name

Required

Type

Description

Example

port

Integer

Port to be used for authentication.

adls1ConfigResponse

Type

Description

Example

Format

azureDataLakeGen1Response

Field Name

Required

Type

Description

Example

config

adls1ConfigResponse

hdfsResponse

Field Name

Required

Type

Description

Example

config

Object

nfsResponse

Field Name

Required

Type

Description

Example

config

Object

snowflakeResponse

Field Name

Required

Type

Description

Example

config

Object

Snowflake Configuration options.

dataSourceResponse

Type

Description

Example

Format

dataSourceResponseArray

Type

Description

Example

Format

array

dataSourceRequestCommon

Field Name

Required

Type

Description

Example

name

String

Name of the data source.

type

String

Type of data source.

s3Request

Field Name

Required

Type

Description

Example

config

Object

S3 Configuration options.

genericS3Request

Field Name

Required

Type

Description

Example

config

Object

Generic S3 Configuration options.

azureBlobRequest

Field Name

Required

Type

Description

Example

config

Object

Azure Blob Configuration options. (Either Access Key or SAS Token must be specified.)

adls2CommonConfigRequest

Field Name

Required

Type

Description

Example

container

String

Azure Storage container.

account

String

Azure Storage Account.

auth

String

Azure Storage Auth Type.

adls2SharedKeyConfigRequest

Field Name

Required

Type

Description

Example

shared_key

String

Shared Key to be used for authentication.

adls2ClientCredentialsConfigRequest

Field Name

Required

Type

Description

Example

o_auth2_config

Object

OAuth 2 config object.

adls2UsernamePasswordConfigRequest

Field Name

Required

Type

Description

Example

o_auth2_config

Object

OAuth 2 config object.

adls2RefreshTokenConfigRequest

Field Name

Required

Type

Description

Example

o_auth2_config

Object

OAuth 2 config object.

adls2ManagedIdentityConfigRequest

Field Name

Required

Type

Description

Example

o_auth2_config

Object

OAuth 2 config object.

adls2ConfigRequest

Type

Description

Example

Format

azureDataLakeGen2Request

Field Name

Required

Type

Description

Example

config

adls2ConfigRequest

googleCloudStorageRequest

Field Name

Required

Type

Description

Example

config

Object

Google Cloud Storage Configuration options.

adls1CommonConfigRequest

Field Name

Required

Type

Description

Example

container

String

Azure Storage container.

auth

String

Azure Storage Auth Type.

adls1ClientCredentialsConfigRequest

Field Name

Required

Type

Description

Example

token_endpoint

String

Endpoint to be used for authentication.

application_id

String

Application ID to be used for authentication.

secret_key

String

Secret Key to be used for authentication.

adls1ManagedIdentityConfigRequest

Field Name

Required

Type

Description

Example

port

Integer

Optional Port to be used for authentication.

adls1ConfigRequest

Type

Description

Example

Format

azureDataLakeGen1Request

Field Name

Required

Type

Description

Example

config

adls1ConfigRequest

hdfsRequest

Field Name

Required

Type

Description

Example

config

Object

snowflakeRequest

Field Name

Required

Type

Description

Example

config

Object

Snowflake Configuration options.

dataSourceRequest

Type

Description

Example

Format

modelType

Type

Description

Example

Format

string

Type of the model

metricQueryCommon

Field Name

Required

Type

Description

Example

startTimestamp

Number

endTimestamp

Number

modelType

metricCheckThreshold

Field Name

Required

Type

Description

Example

operator

String

The math operator for the condition, like < or <=.

lowerThreshold

Number

The lower bound for the metric check

upperThreshold

Number

The upper bound for the metric check

metricCheckConfigCommon

Field Name

Required

Type

Description

Example

alertsEnabled

Boolean

Whether this feature is alertable for not

threshold

metricCheckThreshold

regressionMetrics

Type

Description

Example

Format

string

A Regression Metric Name

mse

mae

mape

regression_normalized_weighted_gini

regressionCheckConfig

Field Name

Required

Type

Description

Example

metricType

regressionMetrics

modelQualityRegressionQuery

Field Name

Required

Type

Description

Example

metricCheckConfigs

List of regressionCheckConfig

classificationMetrics

Type

Description

Example

Format

string

A Classification Metric Name

accuracy

precision

recall

auc_roc

log_loss

classification_normalized_weighted_gini

classificationCheckConfig

Field Name

Required

Type

Description

Example

metricType

classificationMetrics

modelQualityClassificationQuery

Field Name

Required

Type

Description

Example

metricCheckConfigs

List of classificationCheckConfig

modelQualityQueryRequest

Type

Description

Example

Format

metricTestResultCommon

Field Name

Required

Type

Description

Example

status

Boolean

Status of the check for the metric.

metricType

String

Metric name

value

Number

Metric computed value

numberOfRecords

Integer

Ground Truth matched records

threshold

metricCheckThreshold

alertsEnabled

Boolean

Boolean value to determine if Alerts are Enabled

MetricTrend

Field Name

Required

Type

Description

Example

timestamp

Number

Timestamp of the date for which this trend point exists.

value

Number

Value of the trend point.

numberOfRows

Number

Number of rows for this trend point.

metricTestResult

Field Name

Required

Type

Description

Example

trend

List of MetricTrend

modelQualityAnalyzeCommonResponse

Field Name

Required

Type

Description

Example

modelType

calculatedOn

Number

Timestamp of time when the query was performed.

startTimestamp

Number

Start time for the data used for the query.

endTimestamp

Number

End time for the data used for the query.

metricTestResults

List of metricTestResult

Metric Test Results for the queries.

matchedRowCount

Number

Number of matched Ground Truth and Prediction rows for this query.

confusionMatrix

Field Name

Required

Type

Description

Example

matrix

List of array

labels

List of string

ClassificationReportMetrics

Field Name

Required

Type

Description

Example

heading

String

Class label and Average type like "weighted avg" or "macro avg"

precision

Number

Classwise or Averaged Precision score

recall

Number

Classwise or Averaged Recall score

f1Score

Number

Classwise or Averaged F1 score

support

Integer

Classwise or overall Support

AccuracyReport

Field Name

Required

Type

Description

Example

value

Number

Micro Accuracy

support

Integer

Overall Support, in this case would be the sum of the confusion matrix

classificationReport

Field Name

Required

Type

Description

Example

labelsReport

List of ClassificationReportMetrics

List of Precision, Recall, F1Score, and Support per label

accuracyReport

AccuracyReport

averagesReport

List of ClassificationReportMetrics

Macro averaged and weighted averaged Precision, Recall, F1Score, and Support

classificationModelQualityAnalyzeResponse

Field Name

Required

Type

Description

Example

confusionMatrix

classificationReport

regressionModelQualityAnalyzeResponse

Type

Description

Example

Format

modelQualityAnalyzeResponse

Type

Description

Example

Format

modelQualityUserQueryCommon

Field Name

Required

Type

Description

Example

modelId

String

Unique identifier of the model.

userId

String

Unique identifier of the user.

modelQualityRegressionUserQuery

Type

Description

Example

Format

modelQualityClassificationUserQuery

Type

Description

Example

Format

modelQualityUserQueryResponse

Type

Description

Example

Format

The model quality query for a model of a user to get the model quality analyze results.

MetricTrendArray

Type

Description

Example

Format

array

modelQualitySchedulerQueryCommon

Field Name

Required

Type

Description

Example

modelId

String

Unique identifier of the model.

modelQualityRegressionSchedulerQuery

Type

Description

Example

Format

modelQualityClassificationSchedulerQuery

Type

Description

Example

Format

modelQualitySchedulerQueryResponse

Type

Description

Example

Format

The model quality query for a model to trigger the model quality scheduled analyze.

modelQualityHistoryTimeline

Field Name

Required

Type

Description

Example

scheduledCheckId

String

scheduledCheckRanAt

Integer

numMetricsPassed

Integer

numMetricsFailed

Integer

modelQualityHistoryTimelineArray

Type

Description

Example

Format

array

scheduledCheckResult

Field Name

Required

Type

Description

Example

calculatedOn

Number

Timestamp of the date when this check was executed.

scheduledCheckDataStartDate

Number

Start Timestamp of the data window of the check.

scheduledCheckDataEndDate

Number

End Timestamp of the data window of the check.

metricTestResults

List of metricTestResultCommon

Metric Test Results for the queries.

numberOfMatchedRows

Number

Number of matched Ground Truth and Prediction rows for this scheduled check.

valueType

Type

Description

Example

Format

string

Type of data the variable has.

categorical

numerical

string

datetime

variableType

Type

Description

Example

Format

string

Variable type.

feature

prediction

row_identifier

timestamp

ground_truth

sample_weight

prediction_probability

binCount

Type

Description

Example

Format

integer

Number of bins to be determined (for training datasets)

binsEstimatorMethod

Type

Description

Example

Format

string

Estimator method to be used to determine the number of bins.

auto

doane

rice

scott

sqrt

sturges

variableConfigRegistrationRequest

Field Name

Required

Type

Description

Example

name

String

Name of the variable.

valueType

variableType

binsCategories

List of string

Bin categories to be used for a categorical typed variable.

binsEdges

List of number

Bin Edges to be used for a numerical typed variable.

binsNum

binCount

binsEstimatorMethod

featureImportance

Number

Feature Importance for a feature variable.

precomputedBinCounts

List of integer

Precomputed counts for bins.

predictionProbabilityLabels

List of string

Labels for the prediction probabilities.

forPredictionOutput

String

Corresponding prediction variable name, for the given variable.

fileFormat

Type

Description

Example

Format

string

Format of the file.

csv

parquet

snowflake

datasetConfig

Field Name

Required

Type

Description

Example

path

String

Path to the dataset in the datasource.

fileFormat

datasetConfigRegistrationRequest

Field Name

Required

Type

Description

Example

name

String

Name of the dataset.

datasetType

String

Type of the dataset.

file

datasetConfig

datasourceName

String

Name of the datasource to which the dataset belongs.

datasourceType

featureSetId

String

The version id for the current feature set version.

featureSetVersionId

String

The feature set id of the feature set to which the current feature set version belongs to.

datasetRegistrationConfigRequest

Field Name

Required

Type

Description

Example

variables

List of variableConfigRegistrationRequest

datasetDetails

datasetConfigRegistrationRequest

run_cohort_analysis

Boolean

sourceType

Type

Description

Example

Format

string

Source for the model registration.

domino_workbench

standalone

workbenchModelDetails

Field Name

Required

Type

Description

Example

workbenchModelId

String

Workbench's Model id

workbenchModelVersionId

String

Workbench Model's version id to be monitored in DMM

model

Field Name

Required

Type

Description

Example

name

String

Name of the Model.

modelType

String

Type of the Model.

classification

regression

version

String

Version of the Model.

description

String

Description for the Model.

author

String

Author of the Model.

dateCreated

Integer

The creation date of the model.

sourceType

sourceDetails

workbenchModelDetails

modelRegistrationConfigRequest

Field Name

Required

Type

Description

Example

modelMetadata

model

visibility

Type

Description

Example

Format

string

Model visibility

public

private

collaboratorLevel

Type

Description

Example

Format

string

type of collaborator

editor

viewer

collaborator

Field Name

Required

Type

Description

Example

userId

String

user id of the collaborator

collaboratorLevel

modelPermissions

Field Name

Required

Type

Description

Example

canRegisterDataset

Boolean

Whether the requesting user can register a dataset for the model

canUpdateMonitoringSettings

Boolean

Whether the requesting user can update monitoring settings for the model

canEditPermissions

Boolean

Whether the requesting user can edit permissions for the model

modelResponse

Field Name

Required

Type

Description

Example

String

Model Identifier.

createdAt

Integer

Creation timestamp of the Model.

updatedAt

Integer

Last update timestamp for the Model.

userId

String

Id of the model owner, who created the model.

ownerUsername

String

username of the model owner, who created the model.

ownerEmail

String

email of the model owner, who created the model.

ownerName

String

name of the model owner, who created the model.

ingestionStatus

String

Dataset Ingestion status for a model.

created

training

prediction

ground_truth

registrationStatus

String

Registration status of a model.

draft

created

deleted

isDeleted

Boolean

Whether the model is deleted or not.

visibility

collaborators

List of collaborator

permissions

modelPermissions

editableModelAttributes

Field Name

Required

Type

Description

Example

name

String

Name of the model.

version

String

Version of the model.

description

String

Description for the model.

author

String

Author of the model.

modelUpdateRequest

Type

Description

Example

Format

object

Attributes of the model to update.

dataDriftCheck

Field Name

Required

Type

Description

Example

checkedOn

Integer

Schedule check run timestamp.

variablesDrifted

List of string

Name of variables, which were drifted.

numberOfPredictions

Integer

Number of Prediction records included in the check.

scheduledCheckId

String

Scheduled Check Identifier.

totalNumberOfVariables

Integer

Total number of variables considered for the check.

modelQualityCheck

Field Name

Required

Type

Description

Example

checkedOn

Integer

Schedule check run timestamp.

scheduledCheckId

String

Scheduled Check Identifier.

metrics

List of object

Model Quality Metric results.

matchedRowCount

Number

Number of predictions that matched ground truth.

modelDashboardItemPermissions

Field Name

Required

Type

Description

Example

canEditAttributes

Boolean

Whether the requesting user can edit attributes of the model

canUnregisterMonitoring

Boolean

Whether the requesting user can unregister monitoring for the model

modelDashboardItemResponse

Field Name

Required

Type

Description

Example

String

Model's Unique Identifier.

name

String

Model's Name.

version

String

Model's Version.

modelType

String

Model's Type.

classification

regression

modelStatus

String

Model's Registration status.

draft

created

deleted

createdAt

Integer

Creation timestamp of a Model.

isDataDriftCheckScheduled

Boolean

Is the Data Drift check for the model scheduled?

isModelQualityCheckScheduled

Boolean

Is the Model Quality check for the model scheduled?

dataDriftChecks

List of dataDriftCheck

Data Drift scheduled check runs.

modelQualityChecks

List of modelQualityCheck

Model Quality scheduled check runs.

sourceType

permissions

modelDashboardItemPermissions

listModelsResponse

Field Name

Required

Type

Description

Example

classificationModelCount

Integer

Number of Classification Models.

regressionModelCount

Integer

Number of Regression Models.

filteredModelCount

Integer

Number of filtered Models.

pagination

searchQuery

String

Search query for the model names.

modelDashboardItems

List of modelDashboardItemResponse

Model Dashboard item set which was fetched.

variableSummaryResponse

Field Name

Required

Type

Description

Example

name

String

Model's Variable name

valueType

variableType

variableSummaryResponseArray

Type

Description

Example

Format

array

collaboratorResponse

Field Name

Required

Type

Description

Example

username

String

Username of the user

String

Email of the user

name

String

Name of the user

collaboratorResponseArray

Type

Description

Example

Format

array

collaboratorRequest

Field Name

Required

Type

Description

Example

collaboratorId

String

collaboratorLevel

collaboratorRequestArray

Type

Description

Example

Format

array

userPermissions

Field Name

Required

Type

Description

Example

canRegisterStandaloneModel

Boolean

Whether the user can register standalone models

canEditGlobalMonitoringSettings

Boolean

Whether the user can edit global monitoring settings

UserResponse

Field Name

Required

Type

Description

Example

String

User Identifier

domino_id

String

Domino User Id

username

String

Username of the user

String

Email of the user

name

String

Name of the user

permissions

userPermissions

OIDCDetails

Field Name

Required

Type

Description

Example

client_id

String

keycloak client id

server_session_state_cookie_name

String

session state key

logout_delay

Integer

No of milliseconds to delay logout

check_interval

Integer

The interval time to check the keycloak session state change.

UserApiKeyResponse

Field Name

Required

Type

Description

Example

user_id

String

User Identifier

api_key

String

DMM API Key

ModelVersionSummary

Field Name

Required

Type

Description

Example

workbenchModelVersionId

String

Workbench model version id

driftedVariablesCount

Integer

count of drifted variables for a model as per last drift scheduled check

failedMetricsCount

Integer

count of failed metrics for a model as per last quality scheduled check

predictionTrafficCount

Integer

count of prediction traffic for the model

ModelVersionSummaryArray

Type

Description

Example

Format

array

globalSettings

Field Name

Required

Type

Description

Example

disableDmmApiKeys

Boolean

Disables all DMM API keys

globalSettingsResponse

Field Name

Required

Type

Description

Example

String

Global Settings Identifier.

createdAt

Integer

Creation timestamp of the Global Settings.

updatedAt

Integer

Last updated timestamp for the Global Settings.

userSetting

Field Name

Required

Type

Description

Example

numOfLastChecks

Integer

Number of last checks to fetch for a model while listing models.

numOfPredictionTrafficDays

Integer

Number of days worth prediction traffic to fetch while listing models.

userSettingResponse

Field Name

Required

Type

Description

Example

String

User Setting Identifier.

createdAt

Integer

Creation timestamp of the User Setting.

updatedAt

Integer

Last update timestamp for the User Setting.

userId

String

User Identifier.

defaultSettingBase

Field Name

Required

Type

Description

Example

String

Default Setting Identifier.

createdAt

Integer

Creation timestamp of the Default Setting.

updatedAt

Integer

Last update timestamp for the Default Setting.

name

String

Name of the default setting.

alertCondition

driftSetting

Field Name

Required

Type

Description

Example

isActive

Boolean

Whether the drift setting is the active drift default setting.

driftSettingArray

Type

Description

Example

Format

array

defaultSettingUpdateRequestBodyItem

Field Name

Required

Type

Description

Example

name

String

Name of the default setting.

alertCondition

driftDefaultSettingUpdateRequestBodyItem

Field Name

Required

Type

Description

Example

isActive

Boolean

Whether the drift setting is the active drift default setting.

driftDefaultSettingUpdateRequestBodyItemArray

Type

Description

Example

Format

array

defaultSettingBaseArray

Type

Description

Example

Format

array

defaultSettingUpdateRequestBodyItemArray

Type

Description

Example

Format

array

modelAlertConfig

Field Name

Required

Type

Description

Example

String

Model's Alert Config identifier.

createdAt

Integer

Creation timestamp of the Alert Config for the model.

updatedAt

Integer

Last update timestamp for the Model's alert config.

modelId

String

Unique identifier of the model.

recipients

String

recipients for the model's alert.

useGlobalRecipients

Boolean

whether or not use the globally configured alert recipients.

modelAlertConfigUpdateRequestBody

Field Name

Required

Type

Description

Example

recipients

String

Alert recipients for the model.

useGlobalRecipients

Boolean

Whether or not to use the global recipients for sending notifications.

smtpChannelConfig

Field Name

Required

Type

Description

Example

host

String

SMTP host.

port

Integer

SMTP port.

username

String

SMTP username.

password

String

SMTP password.

sender

String

mail address to be used to send mail notification alerts.

recipients

String

mail address of the recipients globally configured for mail notification alerts.

configType

String

Notification Config type

tlsEnabled

Boolean

SMTP TLS enabled.

channelConfig

Field Name

Required

Type

Description

Example

String

Channel Config's Unique identifier.

createdAt

Integer

Creation timestamp of the Channel Config in Domino Model Monitor.

updatedAt

Integer

Last update timestamp for the Channel Config in Domino Model Monitor.

UpdateScheduleJobPayLoad

Field Name

Required

Type

Description

Example

schedulerJobId

String

name

String

cronExpression

String

timezone

String

dataSinceLastCheck

Boolean

dataSince

Integer

calendarType

String

ScheduleJob

Field Name

Required

Type

Description

Example

String

name

String

modelId

String

datasetId

String

cronExpression

String

timezone

String

isPaused

Boolean

dataSinceLastCheck

Boolean

dataSince

Integer

calendarType

String

Scheduledjob

Field Name

Required

Type

Description

Example

jobId

String

schedulerId

String

modelId

String

startedAt

Number

finishedAt

Number

CreateScheduleJobPayLoad

Field Name

Required

Type

Description

Example

name

String

modelId

String

datasetId

String

cronExpression

String

dataSinceLastCheck

Boolean

dataSince

Integer

calendarType

String

timezone

String

TestEmailRequestBody

Field Name

Required

Type

Description

Example

modelId

String