Skip to main content
GET
/
model-monitor
/
v2
/
api
/
models
List models
curl --request GET \
  --url https://api.example.com/model-monitor/v2/api/models \
  --header 'X-Domino-Api-Key: <api-key>'
{
  "classificationModelCount": 123,
  "regressionModelCount": 123,
  "filteredModelCount": 123,
  "pagination": {
    "pageSize": 123,
    "pageNumber": 123,
    "sortOrder": 123
  },
  "modelDashboardItems": [
    {
      "id": "<string>",
      "name": "<string>",
      "version": "<string>",
      "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
        }
      ],
      "permissions": {
        "canEditAttributes": true,
        "canUnregisterMonitoring": true
      },
      "tags": [
        {
          "id": "<string>",
          "tagName": "<string>"
        }
      ]
    }
  ],
  "tagsCount": [
    {
      "id": "<string>",
      "tagName": "<string>",
      "count": 123
    }
  ],
  "searchQuery": "<string>"
}

Authorizations

X-Domino-Api-Key
string
header
required

Query Parameters

pageNumber
integer
required
pageSize
integer
required
numberOfLastChecksToFetch
integer
required
searchQuery
string
tagsQuery
string

comma-separated values of tag ids to filter by

sortOn
enum<string>
Available options:
created_at,
updated_at
sortOrder
enum<integer>

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

Available options:
1,
-1
modelType
string

Type of the model

Response

Successfully fetched the Model.

List models by pagination.

classificationModelCount
integer
required

Number of Classification Models.

regressionModelCount
integer
required

Number of Regression Models.

filteredModelCount
integer
required

Number of filtered Models.

pagination
object
required
modelDashboardItems
Model Dashboard Item. · object[]
required

Model Dashboard item set which was fetched.

tagsCount
Model Tag with Count · object[]

Number of models per tag.

searchQuery
string

Search query for the model names.