domino logo
Latest (5.7)
  • Get API Key
  • REST API Reference
  • Domino Data API
  • Custom Metrics SDK
  • Domino R Package
  • Python Wrapper for Domino API
  • The python-domino Library
  • Model Monitoring API Reference
domino logo
About Domino
Domino Data LabKnowledge BaseData Science BlogTraining
>
API Guide
>
Model Monitoring API Reference

Model Monitoring API Reference

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

Note

To invoke these APIs, you must pass the API token in the header. See API Token for more information.

  • 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
NameDescriptionRequiredTypeInExample

model_id

Identifier of the model

string

path

Body Parameter
NameDescriptionRequired

jobHistoryRequest

jobHistoryRequest

Responses
CodeMessageDatatype

200

Gets the list of jobs for the model

listJobResponse

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

datasetIngestTimelineArray

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
CodeMessageDatatype

200

Gets all the registered data sources.

dataSourceResponseArray

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
NameDescriptionRequired

dataSourceRequest

dataSourceRequest

Responses
CodeMessageDatatype

200

Data source added/updated successfully

dataSourceResponse

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
NameDescriptionRequiredTypeInExample

datasource_id

string

query

Responses
CodeMessageDatatype

200

The data source object that was deleted.

dataSourceResponse

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
NameDescriptionRequiredTypeInExample

model_id

Identifier for the model to be updated.

string

path

Body Parameter
NameDescriptionRequired

modelQualityQueryRequest

modelQualityQueryRequest

Responses
CodeMessageDatatype

200

The MQ analyze query was done successfully.

modelQualityAnalyzeResponse

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
NameDescriptionRequiredTypeInExample

model_id

Identifier for the model.

string

path

Responses
CodeMessageDatatype

200

The model quality user query was fetched successfully.

modelQualityUserQueryResponse

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
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.

MetricTrendArray

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
NameDescriptionRequiredTypeInExample

model_id

Identifier for the model.

string

path

Responses
CodeMessageDatatype

200

The model quality scheduler query was fetched successfully.

modelQualitySchedulerQueryResponse

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
NameDescriptionRequiredTypeInExample

model_id

Identifier for the model.

string

path

Body Parameter
NameDescriptionRequired

modelQualityQueryRequest

modelQualityQueryRequest

Responses
CodeMessageDatatype

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
NameDescriptionRequiredTypeInExample

model_id

string

path

start_date

string

query

end_date

string

query

Responses
CodeMessageDatatype

200

Gets the model timeline data

modelQualityHistoryTimelineArray

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
NameDescriptionRequiredTypeInExample

scheduled_check_id

string

path

Responses
CodeMessageDatatype

200

Gets the scheduled check data

scheduledCheckResult

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
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.

modelTraffic

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
NameDescriptionRequiredTypeInExample

model_id

string

path

dataset_type

string

path

prediction
ground_truth

Body Parameter
NameDescriptionRequired

datasetRegistrationConfigRequest

datasetRegistrationConfigRequest

Responses
CodeMessageDatatype

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
NameDescriptionRequiredTypeInExample

model_id

string

query

workbench_model_version_id

string

query

Responses
CodeMessageDatatype

200

Successfully fetched the Model.

modelResponse

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
NameDescriptionRequiredTypeInExample

model_id

string

query

Body Parameter
NameDescriptionRequired

modelUpdateRequest

modelUpdateRequest

Responses
CodeMessageDatatype

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
NameDescriptionRequired

modelRegistrationConfigRequest

modelRegistrationConfigRequest

Responses
CodeMessageDatatype

200

Successfully registered the Model.

modelResponse

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
NameDescriptionRequiredTypeInExample

model_id

string

query

Responses
CodeMessageDatatype

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
NameDescriptionRequiredTypeInExample

pageNumber

integer

query

pageSize

integer

query

numberOfLastChecksToFetch

integer

query

searchQuery

string

query

modelType

Undefined

query

Responses
CodeMessageDatatype

200

Successfully fetched the Model.

listModelsResponse

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
NameDescriptionRequiredTypeInExample

model_id

string

query

workbench_model_version_id

string

query

Responses
CodeMessageDatatype

200

Successfully fetched the Model summary.

modelDashboardItemResponse

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
NameDescriptionRequiredTypeInExample

model_id

string

path

Responses
CodeMessageDatatype

200

Successfully fetched the Model.

variableSummaryResponseArray

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
NameDescriptionRequiredTypeInExample

model_id

string

path

visibility

Undefined

query

Responses
CodeMessageDatatype

200

Successfully updated model visibility.

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
NameDescriptionRequiredTypeInExample

model_id

string

path

Responses
CodeMessageDatatype

200

Successfully fetched the model's collaborators.

collaboratorResponseArray

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
NameDescriptionRequiredTypeInExample

model_id

string

path

Body Parameter
NameDescriptionRequired

collaboratorRequestArray

collaboratorRequestArray

Responses
CodeMessageDatatype

200

Successfully add a collaborator to model.

collaboratorResponseArray

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
NameDescriptionRequiredTypeInExample

model_id

string

path

Body Parameter
NameDescriptionRequired

collaboratorRequest

collaboratorRequest

Responses
CodeMessageDatatype

200

Successfully updated a model collaborator.

collaboratorResponseArray

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
NameDescriptionRequiredTypeInExample

model_id

string

path

collaborator_id

string

query

Responses
CodeMessageDatatype

200

Successfully removed a collaborator from a model.

collaboratorResponseArray

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
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.

ModelVersionSummaryArray

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
NameDescriptionRequiredTypeInExample

is_active

Whether to fetch only the active drift default setting or not.

boolean

query

Responses
CodeMessageDatatype

200

Drift default settings fetched successfully.

driftSettingArray

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
NameDescriptionRequired

driftDefaultSettingUpdateRequestBodyItemArray

driftDefaultSettingUpdateRequestBodyItemArray

Responses
CodeMessageDatatype

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
CodeMessageDatatype

200

Model Quality Metric default settings fetched successfully.

defaultSettingBaseArray

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
NameDescriptionRequired

defaultSettingUpdateRequestBodyItemArray

defaultSettingUpdateRequestBodyItemArray

Responses
CodeMessageDatatype

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
CodeMessageDatatype

200

User Settings fetched successfully.

userSettingResponse

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
NameDescriptionRequired

userSetting

userSetting

Responses
CodeMessageDatatype

200

User Settings updated successfully.

userSettingResponse

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
NameDescriptionRequiredTypeInExample

model_id

string

path

Responses
CodeMessageDatatype

200

Model Alert Config was fetched successfully.

modelAlertConfig

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 exisiting model alert config.

POST

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

Description

Parameters
NameDescriptionRequiredTypeInExample

model_id

string

path

Body Parameter
NameDescriptionRequired

modelAlertConfigUpdateRequestBody

modelAlertConfigUpdateRequestBody

Responses
CodeMessageDatatype

200

Model Alert Config was updated successfully.

modelAlertConfig

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
CodeMessageDatatype

200

Channel config fetched successfully.

channelConfig

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
NameDescriptionRequired

smtpChannelConfig

smtpChannelConfig

Responses
CodeMessageDatatype

200

Notification Channel Config was updated successfully.

channelConfig

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
NameDescriptionRequired

Responses
CodeMessageDatatype

200

send test mail

Scheduler

Pauses schedule job

POST

/schedule/{schedulerJobId}/unschedule_scheduler_job

Description

Parameters
NameDescriptionRequiredTypeInExample

schedulerJobId

string

path

Responses
CodeMessageDatatype

200

Pauses schedule job returns true is done successfully

Updates scheduler job of a model

POST

/scheduler/update_scheduler_config

Description

Body Parameter
NameDescriptionRequired

Responses
CodeMessageDatatype

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
NameDescriptionRequiredTypeInExample

scheduleCheckId

string

path

Responses
CodeMessageDatatype

200

scheduled check data

Creates a schedule check for a model drift

POST

/scheduler/create_drift_schedule_check

Description

Body Parameter
NameDescriptionRequired

Responses
CodeMessageDatatype

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
NameDescriptionRequiredTypeInExample

modelId

string

path

Responses
CodeMessageDatatype

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
NameDescriptionRequired

Responses
CodeMessageDatatype

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
NameDescriptionRequiredTypeInExample

modelId

string

path

Responses
CodeMessageDatatype

200

Gets schedule check job of a model quality

Other

getPing

GET

/v2/api/ping

Description

Health check endpoint.

Responses
CodeMessageDatatype

200

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

pingPong

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

driftAnalyzeRequest

driftAnalyzeRequest

Responses
CodeMessageDatatype

200

The drift analyse query was done successfully.

driftAnalyzeResponse

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
NameDescriptionRequiredTypeInExample

model_id

Identifier for the model to be updated.

string

path

Responses
CodeMessageDatatype

200

The drift scheduler query was generated successfully.

driftUserQuery

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
NameDescriptionRequiredTypeInExample

model_id

Identifier for the model to be updated.

string

path

Responses
CodeMessageDatatype

200

The drift scheduler query was generated successfully.

driftSchedulerQuery

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

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
NameDescriptionRequiredTypeInExample

model_id

Identifier for the model to be updated.

string

path

Body Parameter
NameDescriptionRequired

featureQueryConfig

featureQueryConfig

Responses
CodeMessageDatatype

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
NameDescriptionRequiredTypeInExample

model_id

string

path

start_date

string

query

end_date

string

query

Responses
CodeMessageDatatype

200

Gets the model timeline data

driftHistoryTimelineArray

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

driftHistoryData

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
NameDescriptionRequiredTypeInExample

model_ids

string

query

start_date

number

query

end_date

number

query

Responses
CodeMessageDatatype

200

Gets the model prediction traffic

modelTrafficArray

400

Bad request input data.

403

Forbidden. The endpoint enforces permissions.

500

Internal server error, check server logs.

Models

datasetType

TypeDescriptionExampleFormat

string

prediction
ground_truth

pingPong

Field NameRequiredTypeDescriptionExample

ping

String

The ping keyword, doesn't represent anything really.

pong

alertCondition

Field NameRequiredTypeDescriptionExample

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 NameRequiredTypeDescriptionExample

id

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 NameRequiredTypeDescriptionExample

pageSize

Integer

pageNumber

Integer

sortOrder

Integer

sortOn

String

column_name
divergence
model_column_id
feature_importance
created_on
created_at

driftAnalyzeRequest

Field NameRequiredTypeDescriptionExample

modelId

String

startDate

Number

endDate

Number

searchQuery

String

config

List of featureQuery

pagination

pagination

distribution

Field NameRequiredTypeDescriptionExample

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 propotional representation, of "counts" in the data

driftCalculations

Field NameRequiredTypeDescriptionExample

id

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 occured during computing for a feature

training

distribution

prediction

distribution

condition

alertCondition

driftAnalyzeResponse

Field NameRequiredTypeDescriptionExample

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

pagination

driftUserQuery

Field NameRequiredTypeDescriptionExample

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 NameRequiredTypeDescriptionExample

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 NameRequiredTypeDescriptionExample

config

List of featureQuery

driftHistoryTimeline

Field NameRequiredTypeDescriptionExample

id

String

time

Integer

columnsDrifted

Integer

columnsNotDrifted

Integer