Skip to content

On-premise users: click in-app to access the full platform documentation for your version of DataRobot.

DataRobot API resources > API reference documentation > DataRobot REST API > Deployments > Metrics and history

Deployments

This page outlines the operations, endpoints, parameters, and example requests and responses for the Deployments.

GET /api/v2/deployments/{deploymentId}/accuracyMetrics/

Retrieve information about which accuracy metrics will be displayed and in what order.

Code samples

curl -X GET https://app.datarobot.com/api/v2/deployments/{deploymentId}/accuracyMetrics/ \
  -H "Accept: application/json" \
  -H "Authorization: Bearer {access-token}"

Parameters

Name In Type Required Description
deploymentId path string true Unique identifier of the deployment.

Example responses

200 Response

{
  "data": [
    "AUC"
  ]
}

Responses

Status Meaning Description Schema
200 OK Information on which accuracy metrics will be displayed and in what order. AccuracyMetricList
404 Not Found Deployment not found. None

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

PUT /api/v2/deployments/{deploymentId}/accuracyMetrics/

Update accuracy metrics being returned in accuracy endpoint.

Code samples

curl -X PUT https://app.datarobot.com/api/v2/deployments/{deploymentId}/accuracyMetrics/ \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -H "Authorization: Bearer {access-token}" \
  -d '{undefined}'

Body parameter

{
  "data": [
    "AUC"
  ]
}

Parameters

Name In Type Required Description
deploymentId path string true Unique identifier of the deployment.
body body AccuracyMetricUpdate false none

Example responses

200 Response

{
  "data": [
    "AUC"
  ]
}

Responses

Status Meaning Description Schema
200 OK The updated accuracy metrics list. AccuracyMetricList
404 Not Found Deployment not found. None

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

GET /api/v2/deployments/{deploymentId}/modelHistory/

Retrieve champion model history of deployment.

Code samples

curl -X GET https://app.datarobot.com/api/v2/deployments/{deploymentId}/modelHistory/ \
  -H "Accept: application/json" \
  -H "Authorization: Bearer {access-token}"

Parameters

Name In Type Required Description
offset query integer false This many results will be skipped.
limit query integer false At most this many results are returned.
deploymentId path string true Unique identifier of the deployment.

Example responses

200 Response

{
  "count": 0,
  "data": [
    {
      "customModelImage": {
        "customModelId": "string",
        "customModelName": "string",
        "customModelVersionId": "string",
        "customModelVersionLabel": "string",
        "executionEnvironmentId": "string",
        "executionEnvironmentName": "string",
        "executionEnvironmentVersionId": "string",
        "executionEnvironmentVersionLabel": "string"
      },
      "endDate": "2019-08-24T14:15:22Z",
      "forecastEndDate": "2019-08-24T14:15:22Z",
      "forecastStartDate": "2019-08-24T14:15:22Z",
      "modelPackage": {
        "id": "string",
        "modelId": "string",
        "name": "string",
        "predictionThreshold": 0,
        "projectId": "string",
        "registeredModelId": "string"
      },
      "predictionWarningBoundaries": {
        "lower": 0,
        "upper": 0
      },
      "replacementReason": "string",
      "startDate": "2019-08-24T14:15:22Z"
    }
  ],
  "next": "http://example.com",
  "previous": "http://example.com",
  "totalCount": 0
}

Responses

Status Meaning Description Schema
200 OK List of deployment model history. ModelHistoryListResponse

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

Schemas

AccuracyMetricList

{
  "data": [
    "AUC"
  ]
}

Properties

Name Type Required Restrictions Description
data [string] true maxItems: 15
 List of Accuracy Metrics.

AccuracyMetricUpdate

{
  "data": [
    "AUC"
  ]
}

Properties

Name Type Required Restrictions Description
data [string] true maxItems: 15
 List of Accuracy Metrics.

CustomModelImage

{
  "customModelId": "string",
  "customModelName": "string",
  "customModelVersionId": "string",
  "customModelVersionLabel": "string",
  "executionEnvironmentId": "string",
  "executionEnvironmentName": "string",
  "executionEnvironmentVersionId": "string",
  "executionEnvironmentVersionLabel": "string"
}

Contains information about the custom model image.

Properties

Name Type Required Restrictions Description
customModelId string,null true ID of the custom model.
customModelName string,null true Name of the custom model.
customModelVersionId string,null true ID of the custom model version.
customModelVersionLabel string,null true Label of the custom model version.
executionEnvironmentId string,null true ID of the execution environment.
executionEnvironmentName string,null true Name of the execution environment.
executionEnvironmentVersionId string,null true ID of the execution environment version.
executionEnvironmentVersionLabel string,null true Label of the execution environment version.

ModelHistoryListResponse

{
  "count": 0,
  "data": [
    {
      "customModelImage": {
        "customModelId": "string",
        "customModelName": "string",
        "customModelVersionId": "string",
        "customModelVersionLabel": "string",
        "executionEnvironmentId": "string",
        "executionEnvironmentName": "string",
        "executionEnvironmentVersionId": "string",
        "executionEnvironmentVersionLabel": "string"
      },
      "endDate": "2019-08-24T14:15:22Z",
      "forecastEndDate": "2019-08-24T14:15:22Z",
      "forecastStartDate": "2019-08-24T14:15:22Z",
      "modelPackage": {
        "id": "string",
        "modelId": "string",
        "name": "string",
        "predictionThreshold": 0,
        "projectId": "string",
        "registeredModelId": "string"
      },
      "predictionWarningBoundaries": {
        "lower": 0,
        "upper": 0
      },
      "replacementReason": "string",
      "startDate": "2019-08-24T14:15:22Z"
    }
  ],
  "next": "http://example.com",
  "previous": "http://example.com",
  "totalCount": 0
}

Properties

Name Type Required Restrictions Description
count integer false Number of items returned on this page.
data [ModelHistoryResponse] true maxItems: 100
 History of deployment's champion models, including the current champion model.
next string,null(uri) true URL pointing to the next page (if null, there is no next page).
previous string,null(uri) true URL pointing to the previous page (if null, there is no previous page).
totalCount integer true The total number of items across all pages.

ModelHistoryResponse

{
  "customModelImage": {
    "customModelId": "string",
    "customModelName": "string",
    "customModelVersionId": "string",
    "customModelVersionLabel": "string",
    "executionEnvironmentId": "string",
    "executionEnvironmentName": "string",
    "executionEnvironmentVersionId": "string",
    "executionEnvironmentVersionLabel": "string"
  },
  "endDate": "2019-08-24T14:15:22Z",
  "forecastEndDate": "2019-08-24T14:15:22Z",
  "forecastStartDate": "2019-08-24T14:15:22Z",
  "modelPackage": {
    "id": "string",
    "modelId": "string",
    "name": "string",
    "predictionThreshold": 0,
    "projectId": "string",
    "registeredModelId": "string"
  },
  "predictionWarningBoundaries": {
    "lower": 0,
    "upper": 0
  },
  "replacementReason": "string",
  "startDate": "2019-08-24T14:15:22Z"
}

Properties

Name Type Required Restrictions Description
customModelImage CustomModelImage false Contains information about the custom model image.
endDate string,null(date-time) true The timestamp when the model is replaced by another model.
forecastEndDate string,null(date-time) true The max timestamp of all predictions made when the model is or was champion of the deployment, if predictions by forecast date is enabled.
forecastStartDate string,null(date-time) true The min timestamp of all predictions made when the model is or was champion of the deployment, if predictions by forecast date is enabled.
modelPackage ModelPackageObject true Contains information about the model package.
predictionWarningBoundaries ModelPackagePredictionThresholdWarning false Lower and upper boundaries for outlier detection.
replacementReason string,null true Reason for model replacement.
startDate string(date-time) true The timestamp when the model becomes champion of the deployment.

ModelPackageObject

{
  "id": "string",
  "modelId": "string",
  "name": "string",
  "predictionThreshold": 0,
  "projectId": "string",
  "registeredModelId": "string"
}

Contains information about the model package.

Properties

Name Type Required Restrictions Description
id string,null true ID of the model package.
modelId string true ID of the model.
name string,null true Name of the model package.
predictionThreshold number,null true The threshold value used for binary classification prediction.
projectId string false ID of the project.
registeredModelId string,null true ID of the associated registered model.

ModelPackagePredictionThresholdWarning

{
  "lower": 0,
  "upper": 0
}

Lower and upper boundaries for outlier detection.

Properties

Name Type Required Restrictions Description
lower number true Lower boundary for outlier detection.
upper number true Upper boundary for outlier detection.
Updated March 12, 2025