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
curl --request GET \
--url https://mycluster.domino.tech/model-monitor/v2/api/get_model_summary \
--header 'X-Domino-Api-Key: <api-key>'import requests
url = "https://mycluster.domino.tech/model-monitor/v2/api/get_model_summary"
headers = {"X-Domino-Api-Key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'X-Domino-Api-Key': '<api-key>'}};
fetch('https://mycluster.domino.tech/model-monitor/v2/api/get_model_summary', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://mycluster.domino.tech/model-monitor/v2/api/get_model_summary",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"X-Domino-Api-Key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://mycluster.domino.tech/model-monitor/v2/api/get_model_summary"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-Domino-Api-Key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://mycluster.domino.tech/model-monitor/v2/api/get_model_summary")
.header("X-Domino-Api-Key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://mycluster.domino.tech/model-monitor/v2/api/get_model_summary")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["X-Domino-Api-Key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"id": "<string>",
"name": "<string>",
"version": "<string>",
"modelType": "classification",
"modelStatus": "draft",
"createdAt": 123,
"isDataDriftCheckScheduled": true,
"isModelQualityCheckScheduled": true,
"dataDriftChecks": [
{
"checkedOn": 123,
"variablesDrifted": [
"<string>"
],
"numberOfPredictions": 123,
"scheduledCheckId": "<string>",
"totalNumberOfVariables": 123
}
],
"modelQualityChecks": [
{
"checkedOn": 123,
"scheduledCheckId": "<string>",
"metrics": [
{
"name": "<string>",
"value": 123,
"isFailed": true
}
],
"matchedRowCount": 123
}
],
"sourceType": "domino_workbench",
"permissions": {
"canEditAttributes": true,
"canUnregisterMonitoring": true
},
"tags": [
{
"id": "<string>",
"tagName": "<string>"
}
]
}Authorizations
Response
Successfully fetched the Model summary.
Model Dashboard Item to be sent in the list models API response.
Model's Unique Identifier.
Model's Name.
Model's Version.
Model's Type.
classification, regression Model's Registration status.
draft, created, deleted Creation timestamp of a Model.
Is the Data Drift check for the model scheduled?
Is the Model Quality check for the model scheduled?
Data Drift scheduled check runs.
Show child attributes
Show child attributes
Model Quality scheduled check runs.
Show child attributes
Show child attributes
Source for the model registration.
domino_workbench, standalone Permission metadata required for a model dashbord item response
Show child attributes
Show child attributes
List of tags associated with the model
Show child attributes
Show child attributes
Was this page helpful?
curl --request GET \
--url https://mycluster.domino.tech/model-monitor/v2/api/get_model_summary \
--header 'X-Domino-Api-Key: <api-key>'import requests
url = "https://mycluster.domino.tech/model-monitor/v2/api/get_model_summary"
headers = {"X-Domino-Api-Key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'X-Domino-Api-Key': '<api-key>'}};
fetch('https://mycluster.domino.tech/model-monitor/v2/api/get_model_summary', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://mycluster.domino.tech/model-monitor/v2/api/get_model_summary",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"X-Domino-Api-Key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://mycluster.domino.tech/model-monitor/v2/api/get_model_summary"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-Domino-Api-Key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://mycluster.domino.tech/model-monitor/v2/api/get_model_summary")
.header("X-Domino-Api-Key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://mycluster.domino.tech/model-monitor/v2/api/get_model_summary")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["X-Domino-Api-Key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"id": "<string>",
"name": "<string>",
"version": "<string>",
"modelType": "classification",
"modelStatus": "draft",
"createdAt": 123,
"isDataDriftCheckScheduled": true,
"isModelQualityCheckScheduled": true,
"dataDriftChecks": [
{
"checkedOn": 123,
"variablesDrifted": [
"<string>"
],
"numberOfPredictions": 123,
"scheduledCheckId": "<string>",
"totalNumberOfVariables": 123
}
],
"modelQualityChecks": [
{
"checkedOn": 123,
"scheduledCheckId": "<string>",
"metrics": [
{
"name": "<string>",
"value": 123,
"isFailed": true
}
],
"matchedRowCount": 123
}
],
"sourceType": "domino_workbench",
"permissions": {
"canEditAttributes": true,
"canUnregisterMonitoring": true
},
"tags": [
{
"id": "<string>",
"tagName": "<string>"
}
]
}