/v2/api/model/{model_id}/analyse-drift
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.
Code | Message | Datatype |
---|---|---|
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. |
/v2/api/model/{model_id}/drift-user-query
Returns drift scheduler config for the model. The endpoint is behind the old backend's auth mechanism.
Name | Description | Required | Type | In | Example |
---|---|---|---|---|---|
model_id | Identifier for the model to be updated. | string | path |
Code | Message | Datatype |
---|---|---|
200 | The drift scheduler query was generated successfully. | |
403 | Unauthorised. The endpoint enforces authorisation. | |
500 | Internal server error, check server logs. |
/v2/api/model/{model_id}/drift-scheduler-query
Returns drift scheduler config for the model. The endpoint is behind the old backend's auth mechanism.
Name | Description | Required | Type | In | Example |
---|---|---|---|---|---|
model_id | Identifier for the model to be updated. | string | path |
Code | Message | Datatype |
---|---|---|
200 | The drift scheduler query was generated successfully. | |
403 | Unauthorised. The endpoint enforces authorisation. | |
500 | Internal server error, check server logs. |
/v2/api/model/{model_id}/{column_id}/drift-trend
Returns drift trend for the model's column. The endpoint is behind the old backend's auth mechanism.
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 |
Code | Message | Datatype |
---|---|---|
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. |
/v2/api/model/{model_id}/save-scheduler-query
Returns drift scheduler config for the model. The endpoint is behind the old backend's auth mechanism.
Code | Message | Datatype |
---|---|---|
200 | The drift scheduler query was generated successfully. | |
403 | Unauthorised. The endpoint enforces authorisation. | |
500 | Internal server error, check server logs. |
/v2/api/model/{model_id}/drift-schedule-checks-history
Gets the model timeline data for drift schedule history page
Name | Description | Required | Type | In | Example |
---|---|---|---|---|---|
model_id | string | path | |||
start_date | string | query | |||
end_date | string | query |
Code | Message | Datatype |
---|---|---|
200 | Gets the model timeline data | |
400 | Bad request input data. | |
403 | Unauthorised. The endpoint enforces authorisation. | |
500 | Internal server error, check server logs. |
/v2/api/model/{model_id}/{scheduler_id}/scheduled-check-drift-data
Get scheduled check drift data
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 |
Code | Message | Datatype |
---|---|---|
200 | Gets the model timeline data | |
400 | Bad request input data. | |
403 | Unauthorised. The endpoint enforces authorisation. | |
500 | Internal server error, check server logs. |
/v2/api/model/get-prediction-traffic
Gets the model prediction traffic
Name | Description | Required | Type | In | Example |
---|---|---|---|---|---|
model_ids | string | query | |||
start_date | number | query | |||
end_date | number | query |
Code | Message | Datatype |
---|---|---|
200 | Gets the model prediction traffic | |
400 | Bad request input data. | |
403 | Unauthorised. The endpoint enforces authorisation. | |
500 | Internal server error, check server logs. |
/v2/api/model/{model_id}/dataset-timeline
Gets the dataset ingestion timeline
Name | Description | Required | Type | In | Example |
---|---|---|---|---|---|
model_id | string | path | |||
start_date | number | query | |||
end_date | number | query |
Code | Message | Datatype |
---|---|---|
200 | Gets the dataset ingestion timeline | |
400 | Bad request input data. | |
403 | Unauthorised. The endpoint enforces authorisation. | |
500 | Internal server error, check server logs. |
/v2/api/datasource
Delete a datasource.
Name | Description | Required | Type | In | Example |
---|---|---|---|---|---|
datasource_id | string | query |
Code | Message | Datatype |
---|---|---|
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. |
/v2/api/model/{model_id}/analyze-model-quality
Returns MQ analyze for the model based on the user's config (or model's default config).
Code | Message | Datatype |
---|---|---|
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. |
/v2/api/model/{model_id}/model-quality-user-query
Returns model quality user config for the model.
Name | Description | Required | Type | In | Example |
---|---|---|---|---|---|
model_id | Identifier for the model. | string | path |
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 | Unauthorised. The endpoint enforces authorisation. | |
500 | Internal server error, check server logs. |
/v2/api/model/{model_id}/model-quality-trend
Returns model quality trend for the model for specific model quality metric.
Name | Description | Required | Type | In | Example |
---|---|---|---|---|---|
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 |
Code | Message | Datatype |
---|---|---|
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. |
/v2/api/model/{model_id}/model-quality-scheduler-query
Returns model quality scheduler query for the model.
Name | Description | Required | Type | In | Example |
---|---|---|---|---|---|
model_id | Identifier for the model. | string | path |
Code | Message | Datatype |
---|---|---|
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. |
/v2/api/model/{model_id}/model-quality-scheduler-query
Returns model quality scheduler query for the model.
Code | Message | Datatype |
---|---|---|
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. |
/v2/api/model/{model_id}/model-quality-scheduled-checks-history
Gets the model timeline data for model quality schedule history page
Name | Description | Required | Type | In | Example |
---|---|---|---|---|---|
model_id | string | path | |||
start_date | string | query | |||
end_date | string | query |
Code | Message | Datatype |
---|---|---|
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. |
/v2/api/model/{scheduled_check_id}/model-quality-scheduled-check-data
Gets the model scheduled check data for MQ schedule history page for the passed scheduled check id
Name | Description | Required | Type | In | Example |
---|---|---|---|---|---|
scheduled_check_id | string | path |
Code | Message | Datatype |
---|---|---|
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. |
/v2/api/model/{model_id}/traffic/ground-truth
Gets the model's ground truth traffic for matched labels
Name | Description | Required | Type | In | Example |
---|---|---|---|---|---|
model_id | string | path | |||
startTimestamp | number | query | |||
endTimestamp | number | query |
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 | Unauthorised. The endpoint enforces authorisation. | |
404 | Model not found. | |
500 | Internal server error, check server logs. |
/v2/api/model/{model_id}/register-dataset/{dataset_type}
Dataset registration to a model.
Code | Message | Datatype |
---|---|---|
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. |
/v2/api/model
Gets a DMM model either via a unique model identifier or via a unique combination of workbench model id and workbench model version id
Name | Description | Required | Type | In | Example |
---|---|---|---|---|---|
model_id | string | query | |||
workbench_model_version_id | string | query |
Code | Message | Datatype |
---|---|---|
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. |
/v2/api/model
Model Operations.
Name | Description | Required | Type | In | Example |
---|---|---|---|---|---|
model_id | string | query |
Code | Message | Datatype |
---|---|---|
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. |
/v2/api/models
Name | Description | Required | Type | In | Example |
---|---|---|---|---|---|
pageNumber | integer | query | |||
pageSize | integer | query | |||
numberOfLastChecksToFetch | integer | query | |||
searchQuery | string | query | |||
modelType | Undefined | query |
Code | Message | Datatype |
---|---|---|
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. |
/v2/api/get_model_summary
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
Name | Description | Required | Type | In | Example |
---|---|---|---|---|---|
model_id | string | query | |||
workbench_model_version_id | string | query |
Code | Message | Datatype |
---|---|---|
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. |
/v2/api/model/{model_id}/variables/summary
Get the model's variables summary list
Name | Description | Required | Type | In | Example |
---|---|---|---|---|---|
model_id | string | path |
Code | Message | Datatype |
---|---|---|
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. |
/v2/api/auth/callback
Callback URL for OAuth login flow.
Name | Description | Required | Type | In | Example |
---|---|---|---|---|---|
session_state | string | query | |||
code | string | query | |||
state | string | query |
Code | Message | Datatype |
---|---|---|
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. |
/v2/api/auth/user/generate_api_key
Initiates API Key (Offline Token) login flow.
Code | Message | Datatype |
---|---|---|
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. |
/v2/api/auth/user/generate_api_key_callback
Callback URL for OAuth login Offline Token flow.
Name | Description | Required | Type | In | Example |
---|---|---|---|---|---|
session_state | string | query | |||
code | string | query | |||
state | string | query |
Code | Message | Datatype |
---|---|---|
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. |
/v2/api/workbench/model/version/summary
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 |
Code | Message | Datatype |
---|---|---|
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. |