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

Value Tracker

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

GET /api/v2/valueTrackerValueTemplates/

List available value trackers templates.

Code samples

# You can also use wget
curl -X GET https://app.datarobot.com/api/v2/valueTrackerValueTemplates/ \
  -H "Accept: application/json" \
  -H "Authorization: Bearer {access-token}"

Example responses

200 Response

[
  {
    "description": "string",
    "schema": [
      {
        "parameterName": "string",
        "schema": {
          "elementType": "integer",
          "label": "string",
          "maximum": 0,
          "minimum": 0,
          "placeholder": "string",
          "unit": "string"
        }
      }
    ],
    "templateType": "classification",
    "title": "string"
  }
]

Responses

Status Meaning Description Schema
200 OK none Inline

Response Schema

Status Code 200

Name Type Required Restrictions Description
anonymous [ValueTrackerValueTemplateResponse] false none
» description string true Description of Value Template
» schema [ValueTrackerValueTemplateParameterWithSchema] true Schema definition of all template parameters
»» parameterName string true Name of the parameter
»» schema ValueTrackerValueTemplateSchema true Schema entry defining the type and limits of a template parameter
»»» elementType string true Possible types used for template variables
»»» label string true Label describing the represented value
»»» maximum integer¦null true Sets Maximum value if given
»»» minimum integer¦null true Sets Minimum value if given
»»» placeholder string true Text that can be used to prefill an input filed for the value
»»» unit string¦null true Unit type. e.g. %
» templateType string true The name of the class ValueTracker value template to be retrieved
» title string true Title of Value Template

Enumerated Values

Property Value
elementType [integer, float, number]
templateType [classification, regression]

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

BearerAuth

GET /api/v2/valueTrackerValueTemplates/{templateType}/

Get an individual value tracker value template by its name.

Code samples

# You can also use wget
curl -X GET https://app.datarobot.com/api/v2/valueTrackerValueTemplates/{templateType}/ \
  -H "Accept: application/json" \
  -H "Authorization: Bearer {access-token}"

Parameters

Name In Type Required Description
templateType path string true The name of the class ValueTracker value template to be retrieved

Enumerated Values

Parameter Value
templateType [classification, regression]

Example responses

200 Response

{
  "description": "string",
  "schema": [
    {
      "parameterName": "string",
      "schema": {
        "elementType": "integer",
        "label": "string",
        "maximum": 0,
        "minimum": 0,
        "placeholder": "string",
        "unit": "string"
      }
    }
  ],
  "templateType": "classification",
  "title": "string"
}

Responses

Status Meaning Description Schema
200 OK none ValueTrackerValueTemplateResponse
400 Bad Request Bad request None

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

BearerAuth

GET /api/v2/valueTrackerValueTemplates/{templateType}/calculation/

Calculate value of template with given template parameters.

Code samples

# You can also use wget
curl -X GET https://app.datarobot.com/api/v2/valueTrackerValueTemplates/{templateType}/calculation/?accuracyImprovement=0&decisionsCount=0 \
  -H "Accept: application/json" \
  -H "Authorization: Bearer {access-token}"

Parameters

Name In Type Required Description
accuracyImprovement query number true Accuracy improvement
decisionsCount query integer true Estimated number of decisions per year
incorrectDecisionsCount query integer false Estimated number of incorrect decisions per year. Required for templateType CLASSIFICATION
incorrectDecisionCost query number false Estimated cost of an individual incorrect decision. Required for templateType CLASSIFICATION
targetValue query number false Target value. Required for templateType REGRESSION
templateType path string true The name of the class ValueTracker value template to be retrieved

Enumerated Values

Parameter Value
templateType [classification, regression]

Example responses

200 Response

{
  "averageValuePerDecision": 0,
  "savedAnnually": 0,
  "template": {
    "data": {
      "accuracyImprovement": 0,
      "decisionsCount": 0,
      "incorrectDecisionCost": 0,
      "incorrectDecisionsCount": 0
    },
    "templateType": "classification"
  }
}

Responses

Status Meaning Description Schema
200 OK none ValueTrackerValueTemplateCalculateResponse
400 Bad Request Bad request None

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

BearerAuth

GET /api/v2/valueTrackers/

List value trackers the requesting user has access to.

Code samples

# You can also use wget
curl -X GET https://app.datarobot.com/api/v2/valueTrackers/ \
  -H "Accept: application/json" \
  -H "Authorization: Bearer {access-token}"

Parameters

Name In Type Required Description
offset query integer false The number of records to skip over. Default 0.
limit query integer false The number of records to return in the range from 1 to 100. Default 100.
orderBy query string false Sort the class ValueTrackers by a field of the class ValueTracker.
namePart query string false Only return class ValueTrackers with names that match the given string.
stage query string false Filter results by the current stage of the class ValueTrackers.

Enumerated Values

Parameter Value
orderBy [businessImpact, -businessImpact, potentialValue, -potentialValue, realizedValue, -realizedValue, feasibility, -feasibility, stage, -stage]
stage [ideation, queued, dataPrepAndModeling, validatingAndDeploying, inProduction, retired, onHold]

Example responses

200 Response

{
  "count": 0,
  "data": [
    {
      "accuracyHealth": "string",
      "businessImpact": 1,
      "commentId": "string",
      "content": "string",
      "description": "string",
      "feasibility": 1,
      "id": "string",
      "inProductionWarning": "string",
      "mentions": [
        {
          "firstName": "string",
          "id": "string",
          "lastName": "string",
          "username": "string"
        }
      ],
      "modelHealth": "string",
      "name": "string",
      "notes": "string",
      "owner": {
        "firstName": "string",
        "id": "string",
        "lastName": "string",
        "username": "string"
      },
      "permissions": [
        "string"
      ],
      "potentialValue": {
        "currency": "BRL",
        "details": "string",
        "value": 0
      },
      "potentialValueTemplate": {
        "data": {
          "accuracyImprovement": 0,
          "decisionsCount": 0,
          "incorrectDecisionCost": 0,
          "incorrectDecisionsCount": 0
        },
        "templateType": "classification"
      },
      "predictionTargets": [
        "string"
      ],
      "predictionsCount": "string",
      "realizedValue": "string",
      "serviceHealth": "string",
      "stage": "ideation",
      "targetDates": [
        {
          "date": "2019-08-24T14:15:22Z",
          "stage": "ideation"
        }
      ]
    }
  ],
  "next": "http://example.com",
  "previous": "http://example.com",
  "totalCount": 0
}

Responses

Status Meaning Description Schema
200 OK none ValueTrackerListResponse

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

BearerAuth

POST /api/v2/valueTrackers/

Create a new value tracker.

Code samples

# You can also use wget
curl -X POST https://app.datarobot.com/api/v2/valueTrackers/ \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -H "Authorization: Bearer {access-token}" \
  -d '{ValueTracker}'

Body parameter

{
  "businessImpact": 1,
  "commentId": "string",
  "content": "string",
  "description": "string",
  "feasibility": 1,
  "id": "string",
  "mentions": [
    {
      "firstName": "string",
      "id": "string",
      "lastName": "string",
      "username": "string"
    }
  ],
  "name": "string",
  "notes": "string",
  "owner": {
    "firstName": "string",
    "id": "string",
    "lastName": "string",
    "username": "string"
  },
  "permissions": [
    "string"
  ],
  "potentialValue": {
    "currency": "BRL",
    "details": "string",
    "value": 0
  },
  "potentialValueTemplate": {
    "data": {
      "accuracyImprovement": 0,
      "decisionsCount": 0,
      "incorrectDecisionCost": 0,
      "incorrectDecisionsCount": 0
    },
    "templateType": "classification"
  },
  "predictionTargets": [
    "string"
  ],
  "realizedValue": "string",
  "stage": "ideation",
  "targetDates": [
    {
      "date": "2019-08-24T14:15:22Z",
      "stage": "ideation"
    }
  ]
}

Parameters

Name In Type Required Description
body body ValueTracker false none

Example responses

200 Response

{
  "accuracyHealth": "string",
  "businessImpact": 1,
  "commentId": "string",
  "content": "string",
  "description": "string",
  "feasibility": 1,
  "id": "string",
  "inProductionWarning": "string",
  "mentions": [
    {
      "firstName": "string",
      "id": "string",
      "lastName": "string",
      "username": "string"
    }
  ],
  "modelHealth": "string",
  "name": "string",
  "notes": "string",
  "owner": {
    "firstName": "string",
    "id": "string",
    "lastName": "string",
    "username": "string"
  },
  "permissions": [
    "string"
  ],
  "potentialValue": {
    "currency": "BRL",
    "details": "string",
    "value": 0
  },
  "potentialValueTemplate": {
    "data": {
      "accuracyImprovement": 0,
      "decisionsCount": 0,
      "incorrectDecisionCost": 0,
      "incorrectDecisionsCount": 0
    },
    "templateType": "classification"
  },
  "predictionTargets": [
    "string"
  ],
  "predictionsCount": "string",
  "realizedValue": "string",
  "serviceHealth": "string",
  "stage": "ideation",
  "targetDates": [
    {
      "date": "2019-08-24T14:15:22Z",
      "stage": "ideation"
    }
  ]
}

Responses

Status Meaning Description Schema
200 OK none ValueTrackerCreateResponse

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

BearerAuth

DELETE /api/v2/valueTrackers/{valueTrackerId}/

Delete a value tracker

Code samples

# You can also use wget
curl -X DELETE https://app.datarobot.com/api/v2/valueTrackers/{valueTrackerId}/ \
  -H "Authorization: Bearer {access-token}"

Parameters

Name In Type Required Description
valueTrackerId path string true The id of the class ValueTracker

Responses

Status Meaning Description Schema
200 OK none None
204 No Content The value tracker was deleted None

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

BearerAuth

GET /api/v2/valueTrackers/{valueTrackerId}/

Retrieve a value tracker.

Code samples

# You can also use wget
curl -X GET https://app.datarobot.com/api/v2/valueTrackers/{valueTrackerId}/ \
  -H "Accept: application/json" \
  -H "Authorization: Bearer {access-token}"

Parameters

Name In Type Required Description
valueTrackerId path string true The id of the class ValueTracker

Example responses

200 Response

{
  "accuracyHealth": "string",
  "businessImpact": 1,
  "commentId": "string",
  "content": "string",
  "description": "string",
  "feasibility": 1,
  "id": "string",
  "inProductionWarning": "string",
  "mentions": [
    {
      "firstName": "string",
      "id": "string",
      "lastName": "string",
      "username": "string"
    }
  ],
  "modelHealth": "string",
  "name": "string",
  "notes": "string",
  "owner": {
    "firstName": "string",
    "id": "string",
    "lastName": "string",
    "username": "string"
  },
  "permissions": [
    "string"
  ],
  "potentialValue": {
    "currency": "BRL",
    "details": "string",
    "value": 0
  },
  "potentialValueTemplate": {
    "data": {
      "accuracyImprovement": 0,
      "decisionsCount": 0,
      "incorrectDecisionCost": 0,
      "incorrectDecisionsCount": 0
    },
    "templateType": "classification"
  },
  "predictionTargets": [
    "string"
  ],
  "predictionsCount": "string",
  "realizedValue": "string",
  "serviceHealth": "string",
  "stage": "ideation",
  "targetDates": [
    {
      "date": "2019-08-24T14:15:22Z",
      "stage": "ideation"
    }
  ]
}

Responses

Status Meaning Description Schema
200 OK none ValueTrackerResponse

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

BearerAuth

PATCH /api/v2/valueTrackers/{valueTrackerId}/

Update a value tracker.

Code samples

# You can also use wget
curl -X PATCH https://app.datarobot.com/api/v2/valueTrackers/{valueTrackerId}/ \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -H "Authorization: Bearer {access-token}" \
  -d '{undefined}'

Body parameter

{
  "businessImpact": 1,
  "description": "string",
  "feasibility": 1,
  "name": "string",
  "notes": "string",
  "owner": {
    "firstName": "string",
    "id": "string",
    "lastName": "string",
    "username": "string"
  },
  "potentialValue": {
    "currency": "BRL",
    "details": "string",
    "value": 0
  },
  "potentialValueTemplate": {
    "data": {
      "accuracyImprovement": 0,
      "decisionsCount": 0,
      "incorrectDecisionCost": 0,
      "incorrectDecisionsCount": 0
    },
    "templateType": "classification"
  },
  "predictionTargets": [
    "string"
  ],
  "realizedValue": {
    "currency": "BRL",
    "details": "string",
    "value": 0
  },
  "stage": "ideation",
  "targetDates": [
    {
      "date": "2019-08-24T14:15:22Z",
      "stage": "ideation"
    }
  ]
}

Parameters

Name In Type Required Description
valueTrackerId path string true The id of the class ValueTracker
body body ValueTrackerUpdate false none

Example responses

200 Response

{
  "accuracyHealth": "string",
  "businessImpact": 1,
  "commentId": "string",
  "content": "string",
  "description": "string",
  "feasibility": 1,
  "id": "string",
  "inProductionWarning": "string",
  "mentions": [
    {
      "firstName": "string",
      "id": "string",
      "lastName": "string",
      "username": "string"
    }
  ],
  "modelHealth": "string",
  "name": "string",
  "notes": "string",
  "owner": {
    "firstName": "string",
    "id": "string",
    "lastName": "string",
    "username": "string"
  },
  "permissions": [
    "string"
  ],
  "potentialValue": {
    "currency": "BRL",
    "details": "string",
    "value": 0
  },
  "potentialValueTemplate": {
    "data": {
      "accuracyImprovement": 0,
      "decisionsCount": 0,
      "incorrectDecisionCost": 0,
      "incorrectDecisionsCount": 0
    },
    "templateType": "classification"
  },
  "predictionTargets": [
    "string"
  ],
  "predictionsCount": "string",
  "realizedValue": "string",
  "serviceHealth": "string",
  "stage": "ideation",
  "targetDates": [
    {
      "date": "2019-08-24T14:15:22Z",
      "stage": "ideation"
    }
  ]
}

Responses

Status Meaning Description Schema
200 OK none ValueTrackerResponse

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

BearerAuth

GET /api/v2/valueTrackers/{valueTrackerId}/activities/

Retrieve the activities of a value tracker.

Code samples

# You can also use wget
curl -X GET https://app.datarobot.com/api/v2/valueTrackers/{valueTrackerId}/activities/ \
  -H "Accept: application/json" \
  -H "Authorization: Bearer {access-token}"

Parameters

Name In Type Required Description
offset query integer false The number of records to skip over. Default 0.
limit query integer false The number of records to return in the range from 1 to 100. Default 100.
valueTrackerId path string true The id of the class ValueTracker

Example responses

200 Response

{
  "count": 0,
  "data": [
    {
      "eventDescription": {
        "businessImpact": 1,
        "commentId": "string",
        "content": "string",
        "description": "string",
        "feasibility": 1,
        "id": "string",
        "mentions": [
          {
            "firstName": "string",
            "id": "string",
            "lastName": "string",
            "username": "string"
          }
        ],
        "name": "string",
        "notes": "string",
        "owner": {
          "firstName": "string",
          "id": "string",
          "lastName": "string",
          "username": "string"
        },
        "permissions": [
          "string"
        ],
        "potentialValue": {
          "currency": "BRL",
          "details": "string",
          "value": 0
        },
        "potentialValueTemplate": {
          "data": {
            "accuracyImprovement": 0,
            "decisionsCount": 0,
            "incorrectDecisionCost": 0,
            "incorrectDecisionsCount": 0
          },
          "templateType": "classification"
        },
        "predictionTargets": [
          "string"
        ],
        "realizedValue": "string",
        "stage": "ideation",
        "targetDates": [
          {
            "date": "2019-08-24T14:15:22Z",
            "stage": "ideation"
          }
        ]
      },
      "eventType": "string",
      "firstName": "string",
      "id": "string",
      "lastName": "string",
      "timestamp": "2019-08-24T14:15:22Z",
      "user": {
        "firstName": "string",
        "id": "string",
        "lastName": "string",
        "username": "string"
      },
      "username": "string"
    }
  ],
  "next": "http://example.com",
  "previous": "http://example.com",
  "totalCount": 0
}

Responses

Status Meaning Description Schema
200 OK none ValueTrackerActivityListResponse

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

BearerAuth

GET /api/v2/valueTrackers/{valueTrackerId}/attachments/

Get a list of resources attached to this value tracker.

Code samples

# You can also use wget
curl -X GET https://app.datarobot.com/api/v2/valueTrackers/{valueTrackerId}/attachments/ \
  -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 This many results are returned
type query string false class ValueTracker attachment type
valueTrackerId path string true The id of the class ValueTracker

Enumerated Values

Parameter Value
type [dataset, modelingProject, deployment, customModel, modelPackage, application]

Example responses

200 Response

{
  "count": 0,
  "data": [
    {
      "attachedObjectId": "string",
      "canView": true,
      "id": "string",
      "isAccessRequested": true,
      "overview": {
        "accuracyHealth": {
          "endDate": "2019-08-24T14:15:22Z",
          "message": "string",
          "startDate": "2019-08-24T14:15:22Z",
          "status": "string"
        },
        "modelHealth": {
          "endDate": "2019-08-24T14:15:22Z",
          "message": "string",
          "startDate": "2019-08-24T14:15:22Z",
          "status": "string"
        },
        "name": "string",
        "predictionServer": "string",
        "predictionUsage": {
          "dailyRates": [
            0
          ],
          "lastTimestamp": "2019-08-24T14:15:22Z"
        },
        "serviceHealth": {
          "endDate": "2019-08-24T14:15:22Z",
          "message": "string",
          "startDate": "2019-08-24T14:15:22Z",
          "status": "string"
        }
      },
      "type": "dataset",
      "useCaseId": "string"
    }
  ],
  "next": "string",
  "previous": "string",
  "totalCount": 0
}

Responses

Status Meaning Description Schema
200 OK none ValueTrackerAttachmentListResponse
404 Not Found Either the value tracker does not exist or the user does not have permissions to view this value tracker. None

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

BearerAuth

POST /api/v2/valueTrackers/{valueTrackerId}/attachments/

Attach a list of resources to this value tracker.

Code samples

# You can also use wget
curl -X POST https://app.datarobot.com/api/v2/valueTrackers/{valueTrackerId}/attachments/ \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -H "Authorization: Bearer {access-token}" \
  -d '{undefined}'

Body parameter

{
  "attachedObjects": [
    {
      "attachedObjectId": "string",
      "type": "dataset"
    }
  ]
}

Parameters

Name In Type Required Description
valueTrackerId path string true The id of the class ValueTracker
body body CreateValueTrackerAttachment false none

Example responses

201 Response

[
  {
    "attachedObjectId": "string",
    "type": "dataset"
  }
]

Responses

Status Meaning Description Schema
201 Created none Inline
404 Not Found Use case or object not found or value tracker not writable or object not readable. None
422 Unprocessable Entity The request was formatted improperly None

Response Schema

Status Code 201

Name Type Required Restrictions Description
anonymous [ValueTrackerAttachment] false none
» attachedObjectId string true The id of the attached object
» type string true class ValueTracker attachment type

Enumerated Values

Property Value
type [dataset, modelingProject, deployment, customModel, modelPackage, application]

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

BearerAuth

DELETE /api/v2/valueTrackers/{valueTrackerId}/attachments/{attachmentId}/

Removes a resource from a value tracker.

Code samples

# You can also use wget
curl -X DELETE https://app.datarobot.com/api/v2/valueTrackers/{valueTrackerId}/attachments/{attachmentId}/ \
  -H "Authorization: Bearer {access-token}"

Parameters

Name In Type Required Description
valueTrackerId path string true The id of the class ValueTracker
attachmentId path string true The id of the attachment

Responses

Status Meaning Description Schema
204 No Content none None
403 Forbidden The user does not have permission to remove objects from this value tracker None
404 Not Found Either the value tracker does not exist or the user does not have permissions to view this value tracker. None
422 Unprocessable Entity The request was formatted improperly, or the requested object to delete was not found None

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

BearerAuth

GET /api/v2/valueTrackers/{valueTrackerId}/attachments/{attachmentId}/

Get a resource that is attached to a value tracker.

Code samples

# You can also use wget
curl -X GET https://app.datarobot.com/api/v2/valueTrackers/{valueTrackerId}/attachments/{attachmentId}/ \
  -H "Accept: application/json" \
  -H "Authorization: Bearer {access-token}"

Parameters

Name In Type Required Description
valueTrackerId path string true The id of the class ValueTracker
attachmentId path string true The id of the attachment

Example responses

200 Response

{
  "attachedObjectId": "string",
  "canView": true,
  "id": "string",
  "isAccessRequested": true,
  "overview": {
    "accuracyHealth": {
      "endDate": "2019-08-24T14:15:22Z",
      "message": "string",
      "startDate": "2019-08-24T14:15:22Z",
      "status": "string"
    },
    "modelHealth": {
      "endDate": "2019-08-24T14:15:22Z",
      "message": "string",
      "startDate": "2019-08-24T14:15:22Z",
      "status": "string"
    },
    "name": "string",
    "predictionServer": "string",
    "predictionUsage": {
      "dailyRates": [
        0
      ],
      "lastTimestamp": "2019-08-24T14:15:22Z"
    },
    "serviceHealth": {
      "endDate": "2019-08-24T14:15:22Z",
      "message": "string",
      "startDate": "2019-08-24T14:15:22Z",
      "status": "string"
    }
  },
  "type": "dataset",
  "useCaseId": "string"
}

Responses

Status Meaning Description Schema
200 OK none ValueTrackerAttachmentResponse
403 Forbidden The user does not have permission to attach objects to this value tracker None
404 Not Found Either the value tracker does not exist or the user does not have permissions to view this value tracker. None
422 Unprocessable Entity The request was formatted improperly, or the requested object to attach was not found None

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

BearerAuth

GET /api/v2/valueTrackers/{valueTrackerId}/realizedValueOverTime/

Retrieve realized value information for a given value tracker over a period of time

Code samples

# You can also use wget
curl -X GET https://app.datarobot.com/api/v2/valueTrackers/{valueTrackerId}/realizedValueOverTime/ \
  -H "Accept: application/json" \
  -H "Authorization: Bearer {access-token}"

Parameters

Name In Type Required Description
start query string(date-time) false Start of the period to retrieve monitoring data, defaults to 7 days ago from the end of the period. Note: this field only accepts top of the hour RFC3339 datetime strings, for example: 2019-08-01T00:00:00Z.
end query string(date-time) false End of the period to retrieve monitoring data, defaults to the next top of the hour. Note: this field only accepts top of the hour RFC3339 datetime strings, for example: 2019-08-01T00:00:00Z.
bucketSize query string(duration) false The time duration of a bucket. Needs to be multiple of one hour. Can not be longer than the total length of the period. If not set, a default value will be calculated based on the start and end time.
valueTrackerId path string true The ID of the class ValueTracker

Example responses

200 Response

{
  "buckets": [
    {
      "period": {
        "end": "2019-08-24T14:15:22Z",
        "start": "2019-08-24T14:15:22Z"
      },
      "predictionsCount": 0,
      "realizedValue": 0
    }
  ],
  "previousTimeRangeSummary": {
    "averagePredictionsCount": 0,
    "averageRealizedValue": 0,
    "period": {
      "end": "2019-08-24T14:15:22Z",
      "start": "2019-08-24T14:15:22Z"
    },
    "totalPredictionsCount": 0,
    "totalRealizedValue": 0
  },
  "summary": {
    "averagePredictionsCount": 0,
    "averageRealizedValue": 0,
    "period": {
      "end": "2019-08-24T14:15:22Z",
      "start": "2019-08-24T14:15:22Z"
    },
    "totalPredictionsCount": 0,
    "totalRealizedValue": 0
  }
}

Responses

Status Meaning Description Schema
200 OK none ValueTrackerRealizedValuesOverTimeResponse

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

BearerAuth

GET /api/v2/valueTrackers/{valueTrackerId}/sharedRoles/

Get a list of users, groups and organizations that have an access to this value tracker

Code samples

# You can also use wget
curl -X GET https://app.datarobot.com/api/v2/valueTrackers/{valueTrackerId}/sharedRoles/?offset=0&limit=10 \
  -H "Accept: application/json" \
  -H "Authorization: Bearer {access-token}"

Parameters

Name In Type Required Description
id query string false Only return roles for a user, group or organization with this identifier.
offset query integer true This many results will be skipped
limit query integer true At most this many results are returned
name query string false Only return roles for a user, group or organization with this name.
shareRecipientType query string false List access controls for recipients with this type.
valueTrackerId path string true The ID of the class ValueTracker

Enumerated Values

Parameter Value
shareRecipientType [user, group, organization]

Example responses

200 Response

{
  "count": 0,
  "data": [
    {
      "id": "string",
      "name": "string",
      "role": "OWNER",
      "shareRecipientType": "user"
    }
  ],
  "next": "http://example.com",
  "previous": "http://example.com",
  "totalCount": 0
}

Responses

Status Meaning Description Schema
200 OK none ValueTrackerSharingListResponse

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

BearerAuth

PATCH /api/v2/valueTrackers/{valueTrackerId}/sharedRoles/

Share a value tracker with a user, group or organization.

Code samples

# You can also use wget
curl -X PATCH https://app.datarobot.com/api/v2/valueTrackers/{valueTrackerId}/sharedRoles/ \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer {access-token}" \
  -d '{undefined}'

Body parameter

{
  "operation": "updateRoles",
  "roles": [
    {
      "id": "string",
      "role": "OWNER",
      "shareRecipientType": "user",
      "username": "string"
    }
  ]
}

Parameters

Name In Type Required Description
valueTrackerId path string true The ID of the class ValueTracker
body body ValueTrackerSharingUpdate false none

Responses

Status Meaning Description Schema
200 OK none None
204 No Content The roles updated successfully None
422 Unprocessable Entity The request was formatted improperly None

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

BearerAuth

Schemas

CreateValueTrackerAttachment

{
  "attachedObjects": [
    {
      "attachedObjectId": "string",
      "type": "dataset"
    }
  ]
}

Properties

Name Type Required Restrictions Description
attachedObjects [ValueTrackerAttachment] true An array of attachment objects

UseCaseInfo

{
  "id": "string",
  "name": "string"
}

Information about the Use Case that this modeling project is attached to

Properties

Name Type Required Restrictions Description
id string true ID of the Use Case this modeling project is attached to
name string true Name of the Use Case this modeling project is attached to

ValueTracker

{
  "businessImpact": 1,
  "commentId": "string",
  "content": "string",
  "description": "string",
  "feasibility": 1,
  "id": "string",
  "mentions": [
    {
      "firstName": "string",
      "id": "string",
      "lastName": "string",
      "username": "string"
    }
  ],
  "name": "string",
  "notes": "string",
  "owner": {
    "firstName": "string",
    "id": "string",
    "lastName": "string",
    "username": "string"
  },
  "permissions": [
    "string"
  ],
  "potentialValue": {
    "currency": "BRL",
    "details": "string",
    "value": 0
  },
  "potentialValueTemplate": {
    "data": {
      "accuracyImprovement": 0,
      "decisionsCount": 0,
      "incorrectDecisionCost": 0,
      "incorrectDecisionsCount": 0
    },
    "templateType": "classification"
  },
  "predictionTargets": [
    "string"
  ],
  "realizedValue": "string",
  "stage": "ideation",
  "targetDates": [
    {
      "date": "2019-08-24T14:15:22Z",
      "stage": "ideation"
    }
  ]
}

Properties

Name Type Required Restrictions Description
businessImpact integer¦null false maximum: 5
minimum: 1
 Expected effects on overall business operations
commentId string false The id for this comment
content string false A string
description string false maxLength: 1024
 class ValueTracker description
feasibility integer¦null false maximum: 5
minimum: 1
 Assessment of how the class ValueTracker can be accomplished across multiple dimensions
id string¦null false The id of this description item
mentions [ValueTrackerDrUserId] false A list of user objects
name string true maxLength: 512
 Name of the class ValueTracker
notes string¦null false User notes
owner ValueTrackerDrUserId false none
permissions [string]¦null false Permissions of current user
potentialValue ValueTrackerMonetaryValue false Optional, Contains MonetaryValue objects
potentialValueTemplate any false Optional, Contains Template type and parameter information

anyOf

Name Type Required Restrictions Description
» anonymous ValueTrackerValueTemplateClassification false none

or

Name Type Required Restrictions Description
» anonymous ValueTrackerValueTemplateRegression false none

continued

Name Type Required Restrictions Description
predictionTargets [string] false An array of strings prediction target names
realizedValue any false Optional, Contains MonetaryValue objects

anyOf

Name Type Required Restrictions Description
» anonymous string false none

or

Name Type Required Restrictions Description
» anonymous ValueTrackerMonetaryValue false Optional, Contains MonetaryValue objects

continued

Name Type Required Restrictions Description
stage string false Current stage of class ValueTracker
targetDates [ValueTrackerTargetDate] false Array of TargetDate objects

Enumerated Values

Property Value
stage [ideation, queued, dataPrepAndModeling, validatingAndDeploying, inProduction, retired, onHold]

ValueTrackerActivity

{
  "eventDescription": {
    "businessImpact": 1,
    "commentId": "string",
    "content": "string",
    "description": "string",
    "feasibility": 1,
    "id": "string",
    "mentions": [
      {
        "firstName": "string",
        "id": "string",
        "lastName": "string",
        "username": "string"
      }
    ],
    "name": "string",
    "notes": "string",
    "owner": {
      "firstName": "string",
      "id": "string",
      "lastName": "string",
      "username": "string"
    },
    "permissions": [
      "string"
    ],
    "potentialValue": {
      "currency": "BRL",
      "details": "string",
      "value": 0
    },
    "potentialValueTemplate": {
      "data": {
        "accuracyImprovement": 0,
        "decisionsCount": 0,
        "incorrectDecisionCost": 0,
        "incorrectDecisionsCount": 0
      },
      "templateType": "classification"
    },
    "predictionTargets": [
      "string"
    ],
    "realizedValue": "string",
    "stage": "ideation",
    "targetDates": [
      {
        "date": "2019-08-24T14:15:22Z",
        "stage": "ideation"
      }
    ]
  },
  "eventType": "string",
  "firstName": "string",
  "id": "string",
  "lastName": "string",
  "timestamp": "2019-08-24T14:15:22Z",
  "user": {
    "firstName": "string",
    "id": "string",
    "lastName": "string",
    "username": "string"
  },
  "username": "string"
}

Properties

Name Type Required Restrictions Description
eventDescription ValueTrackerEventDescriptions true Details of the activity, content depends on activity type
eventType string¦null true The type of activity
firstName string¦null false First name of class ValueTracker owner
id string false The id of the class ValueTracker activity
lastName string¦null false Last of class ValueTracker owner
timestamp string(date-time) true The timestamp of the activity
user ValueTrackerDrUserId true none
username string false Username of class ValueTracker owner

ValueTrackerActivityListResponse

{
  "count": 0,
  "data": [
    {
      "eventDescription": {
        "businessImpact": 1,
        "commentId": "string",
        "content": "string",
        "description": "string",
        "feasibility": 1,
        "id": "string",
        "mentions": [
          {
            "firstName": "string",
            "id": "string",
            "lastName": "string",
            "username": "string"
          }
        ],
        "name": "string",
        "notes": "string",
        "owner": {
          "firstName": "string",
          "id": "string",
          "lastName": "string",
          "username": "string"
        },
        "permissions": [
          "string"
        ],
        "potentialValue": {
          "currency": "BRL",
          "details": "string",
          "value": 0
        },
        "potentialValueTemplate": {
          "data": {
            "accuracyImprovement": 0,
            "decisionsCount": 0,
            "incorrectDecisionCost": 0,
            "incorrectDecisionsCount": 0
          },
          "templateType": "classification"
        },
        "predictionTargets": [
          "string"
        ],
        "realizedValue": "string",
        "stage": "ideation",
        "targetDates": [
          {
            "date": "2019-08-24T14:15:22Z",
            "stage": "ideation"
          }
        ]
      },
      "eventType": "string",
      "firstName": "string",
      "id": "string",
      "lastName": "string",
      "timestamp": "2019-08-24T14:15:22Z",
      "user": {
        "firstName": "string",
        "id": "string",
        "lastName": "string",
        "username": "string"
      },
      "username": "string"
    }
  ],
  "next": "http://example.com",
  "previous": "http://example.com",
  "totalCount": 0
}

Properties

Name Type Required Restrictions Description
count integer true The number of items returned on this page
data [ValueTrackerActivity] true The activities of a class ValueTracker
next string(uri)¦null true URL pointing to the next page (if null, there is no next page)
previous string(uri)¦null true URL pointing to the previous page (if null, there is no previous page)
totalCount integer true The number of items matching the query condition

ValueTrackerAttachment

{
  "attachedObjectId": "string",
  "type": "dataset"
}

Properties

Name Type Required Restrictions Description
attachedObjectId string true The id of the attached object
type string true class ValueTracker attachment type

Enumerated Values

Property Value
type [dataset, modelingProject, deployment, customModel, modelPackage, application]

ValueTrackerAttachmentApplicationOverview

{
  "appType": "string",
  "createdAt": "2019-08-24T14:15:22Z",
  "lastModifiedAt": "2019-08-24T14:15:22Z",
  "name": "string",
  "version": "string"
}

Properties

Name Type Required Restrictions Description
appType string true Type of the application
createdAt string(date-time) true Time when application was created
lastModifiedAt string(date-time) true Time of the last modification
name string true Name of the application
version string true Version string of the app

ValueTrackerAttachmentCustomModelOverview

{
  "createdAt": "2019-08-24T14:15:22Z",
  "modifiedAt": "2019-08-24T14:15:22Z",
  "name": "string",
  "owner": "string"
}

Properties

Name Type Required Restrictions Description
createdAt string(date-time) true Time when custom model was created
modifiedAt string(date-time) true Time of the last modification
name string true Name of the custom model
owner string true Name of the custom model owner

ValueTrackerAttachmentDatasetOverview

{
  "createdAt": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "lastModifiedAt": "2019-08-24T14:15:22Z",
  "lastModifiedBy": "string",
  "name": "string"
}

Properties

Name Type Required Restrictions Description
createdAt string(date-time) true Time when dataset was created
createdBy string true Name of user who created the dataset
lastModifiedAt string(date-time) true Time of the last modification
lastModifiedBy string true Name of user who did last modification
name string true Name of the dataset

ValueTrackerAttachmentDeploymentHealth

{
  "endDate": "2019-08-24T14:15:22Z",
  "message": "string",
  "startDate": "2019-08-24T14:15:22Z",
  "status": "string"
}

Accuracy related health status

Properties

Name Type Required Restrictions Description
endDate string(date-time) true End date of health status
message string true Health status related information
startDate string(date-time) true Start date of health status
status string true Health status

ValueTrackerAttachmentDeploymentOverview

{
  "accuracyHealth": {
    "endDate": "2019-08-24T14:15:22Z",
    "message": "string",
    "startDate": "2019-08-24T14:15:22Z",
    "status": "string"
  },
  "modelHealth": {
    "endDate": "2019-08-24T14:15:22Z",
    "message": "string",
    "startDate": "2019-08-24T14:15:22Z",
    "status": "string"
  },
  "name": "string",
  "predictionServer": "string",
  "predictionUsage": {
    "dailyRates": [
      0
    ],
    "lastTimestamp": "2019-08-24T14:15:22Z"
  },
  "serviceHealth": {
    "endDate": "2019-08-24T14:15:22Z",
    "message": "string",
    "startDate": "2019-08-24T14:15:22Z",
    "status": "string"
  }
}

Properties

Name Type Required Restrictions Description
accuracyHealth ValueTrackerAttachmentDeploymentHealth true Accuracy related health status
modelHealth ValueTrackerAttachmentDeploymentHealth true Accuracy related health status
name string true Name of the deployment
predictionServer string true Name of prediction server
predictionUsage ValueTrackerAttachmentDeploymentPredictionUsage true class ValueTracker attachment detail for Deployment usage
serviceHealth ValueTrackerAttachmentDeploymentHealth true Accuracy related health status

ValueTrackerAttachmentDeploymentPredictionUsage

{
  "dailyRates": [
    0
  ],
  "lastTimestamp": "2019-08-24T14:15:22Z"
}

class ValueTracker attachment detail for Deployment usage

Properties

Name Type Required Restrictions Description
dailyRates [integer] true List of daily request counts
lastTimestamp string(date-time) true Last prediction time

ValueTrackerAttachmentListResponse

{
  "count": 0,
  "data": [
    {
      "attachedObjectId": "string",
      "canView": true,
      "id": "string",
      "isAccessRequested": true,
      "overview": {
        "accuracyHealth": {
          "endDate": "2019-08-24T14:15:22Z",
          "message": "string",
          "startDate": "2019-08-24T14:15:22Z",
          "status": "string"
        },
        "modelHealth": {
          "endDate": "2019-08-24T14:15:22Z",
          "message": "string",
          "startDate": "2019-08-24T14:15:22Z",
          "status": "string"
        },
        "name": "string",
        "predictionServer": "string",
        "predictionUsage": {
          "dailyRates": [
            0
          ],
          "lastTimestamp": "2019-08-24T14:15:22Z"
        },
        "serviceHealth": {
          "endDate": "2019-08-24T14:15:22Z",
          "message": "string",
          "startDate": "2019-08-24T14:15:22Z",
          "status": "string"
        }
      },
      "type": "dataset",
      "useCaseId": "string"
    }
  ],
  "next": "string",
  "previous": "string",
  "totalCount": 0
}

Properties

Name Type Required Restrictions Description
count integer true Number of results returned
data [ValueTrackerAttachmentResponse] true An array of attachment objects
next string¦null true Link to next page
previous string¦null true Link to previous page
totalCount integer true Total number of results available

ValueTrackerAttachmentModelPackageOverview

{
  "createdAt": "2019-08-24T14:15:22Z",
  "deploymentCount": 0,
  "executionType": "string",
  "name": "string",
  "targetName": "string",
  "targetType": "string"
}

Properties

Name Type Required Restrictions Description
createdAt string(date-time) true Time when model package was created
deploymentCount integer true Number of deployments
executionType string true Type of execution
name string true Name of the model package
targetName string true Name of modeling target
targetType string true Type of modeling target

ValueTrackerAttachmentModelingProjectOverview

{
  "createdAt": "2019-08-24T14:15:22Z",
  "datasetName": "string",
  "name": "string",
  "numberOfModels": 0,
  "owner": "string",
  "targetName": "string",
  "useCase": {
    "id": "string",
    "name": "string"
  }
}

Properties

Name Type Required Restrictions Description
createdAt string(date-time) true Time when project was created
datasetName string true Name of default dataset
name string true Name of the project
numberOfModels integer¦null true Number of the models in the project
owner string¦null true Name of the modeling project owner
targetName string true Name of modeling target
useCase UseCaseInfo false Information about the Use Case that this modeling project is attached to

ValueTrackerAttachmentResponse

{
  "attachedObjectId": "string",
  "canView": true,
  "id": "string",
  "isAccessRequested": true,
  "overview": {
    "accuracyHealth": {
      "endDate": "2019-08-24T14:15:22Z",
      "message": "string",
      "startDate": "2019-08-24T14:15:22Z",
      "status": "string"
    },
    "modelHealth": {
      "endDate": "2019-08-24T14:15:22Z",
      "message": "string",
      "startDate": "2019-08-24T14:15:22Z",
      "status": "string"
    },
    "name": "string",
    "predictionServer": "string",
    "predictionUsage": {
      "dailyRates": [
        0
      ],
      "lastTimestamp": "2019-08-24T14:15:22Z"
    },
    "serviceHealth": {
      "endDate": "2019-08-24T14:15:22Z",
      "message": "string",
      "startDate": "2019-08-24T14:15:22Z",
      "status": "string"
    }
  },
  "type": "dataset",
  "useCaseId": "string"
}

Properties

Name Type Required Restrictions Description
attachedObjectId string true The id of the attached object
canView boolean true Indicates if user has view access to the attached object
id string true The id of the class ValueTracker
isAccessRequested boolean true Indicates if user has requested access to the attached object
overview any true Detailed information depending on the type of the attachment

oneOf

Name Type Required Restrictions Description
» anonymous ValueTrackerAttachmentDeploymentOverview false none

xor

Name Type Required Restrictions Description
» anonymous ValueTrackerAttachmentDatasetOverview false none

xor

Name Type Required Restrictions Description
» anonymous ValueTrackerAttachmentModelingProjectOverview false none

xor

Name Type Required Restrictions Description
» anonymous ValueTrackerAttachmentCustomModelOverview false none

xor

Name Type Required Restrictions Description
» anonymous ValueTrackerAttachmentModelPackageOverview false none

xor

Name Type Required Restrictions Description
» anonymous ValueTrackerAttachmentApplicationOverview false none

continued

Name Type Required Restrictions Description
type string true class ValueTracker attachment type
useCaseId string true The id of the class ValueTracker

Enumerated Values

Property Value
type [dataset, modelingProject, deployment, customModel, modelPackage, application]

ValueTrackerBucket

{
  "period": {
    "end": "2019-08-24T14:15:22Z",
    "start": "2019-08-24T14:15:22Z"
  },
  "predictionsCount": 0,
  "realizedValue": 0
}

Properties

Name Type Required Restrictions Description
period ValueTrackerBucketPeriod true A period object describing the time this bucket covers
predictionsCount integer true Total number of predictions that happened in this bucket
realizedValue integer false Total amount of value realised during this bucket

ValueTrackerBucketPeriod

{
  "end": "2019-08-24T14:15:22Z",
  "start": "2019-08-24T14:15:22Z"
}

A period object describing the time this bucket covers

Properties

Name Type Required Restrictions Description
end string(date-time) true RFC3339 datetime. End of time period to retrieve.
start string(date-time) true RFC3339 datetime. Start of time period to retrieve.

ValueTrackerCreateResponse

{
  "accuracyHealth": "string",
  "businessImpact": 1,
  "commentId": "string",
  "content": "string",
  "description": "string",
  "feasibility": 1,
  "id": "string",
  "inProductionWarning": "string",
  "mentions": [
    {
      "firstName": "string",
      "id": "string",
      "lastName": "string",
      "username": "string"
    }
  ],
  "modelHealth": "string",
  "name": "string",
  "notes": "string",
  "owner": {
    "firstName": "string",
    "id": "string",
    "lastName": "string",
    "username": "string"
  },
  "permissions": [
    "string"
  ],
  "potentialValue": {
    "currency": "BRL",
    "details": "string",
    "value": 0
  },
  "potentialValueTemplate": {
    "data": {
      "accuracyImprovement": 0,
      "decisionsCount": 0,
      "incorrectDecisionCost": 0,
      "incorrectDecisionsCount": 0
    },
    "templateType": "classification"
  },
  "predictionTargets": [
    "string"
  ],
  "predictionsCount": "string",
  "realizedValue": "string",
  "serviceHealth": "string",
  "stage": "ideation",
  "targetDates": [
    {
      "date": "2019-08-24T14:15:22Z",
      "stage": "ideation"
    }
  ]
}

Properties

Name Type Required Restrictions Description
accuracyHealth any false The health of the accuracy

anyOf

Name Type Required Restrictions Description
» anonymous string false none

or

Name Type Required Restrictions Description
» anonymous ValueTrackerHealthInformation false none

continued

Name Type Required Restrictions Description
businessImpact integer¦null false maximum: 5
minimum: 1
 Expected effects on overall business operations
commentId string false The id for this comment
content string false A string
description string false class ValueTracker description
feasibility integer¦null false maximum: 5
minimum: 1
 Assessment of how the class ValueTracker can be accomplished across multiple dimensions
id string false The id of the class ValueTracker
inProductionWarning string¦null false An optional warning to indicate that deployments are attached to this class ValueTracker.
mentions [ValueTrackerDrUserId] false A list of user objects
modelHealth any false The health of the model

anyOf

Name Type Required Restrictions Description
» anonymous string false none

or

Name Type Required Restrictions Description
» anonymous ValueTrackerHealthInformation false none

continued

Name Type Required Restrictions Description
name string false Name of the class ValueTracker
notes string¦null false User notes
owner ValueTrackerDrUserId false none
permissions [string]¦null false Permissions of current user
potentialValue ValueTrackerMonetaryValue false Optional, Contains MonetaryValue objects
potentialValueTemplate any false Optional, Contains Template type and parameter information

anyOf

Name Type Required Restrictions Description
» anonymous ValueTrackerValueTemplateClassification false none

or

Name Type Required Restrictions Description
» anonymous ValueTrackerValueTemplateRegression false none

continued

Name Type Required Restrictions Description
predictionTargets [string] false An array of strings prediction target names
predictionsCount any false Count of the number of predictions made.

anyOf

Name Type Required Restrictions Description
» anonymous string false none

or

Name Type Required Restrictions Description
» anonymous integer false none

or

Name Type Required Restrictions Description
» anonymous [integer]¦null false A list of prediction counts.

continued

Name Type Required Restrictions Description
realizedValue any false Optional, Contains MonetaryValue objects

anyOf

Name Type Required Restrictions Description
» anonymous string false none

or

Name Type Required Restrictions Description
» anonymous ValueTrackerMonetaryValue false Optional, Contains MonetaryValue objects

continued

Name Type Required Restrictions Description
serviceHealth any false The health of the service

anyOf

Name Type Required Restrictions Description
» anonymous string false none

or

Name Type Required Restrictions Description
» anonymous ValueTrackerHealthInformation false none

continued

Name Type Required Restrictions Description
stage string false Current stage of class ValueTracker
targetDates [ValueTrackerTargetDate]¦null false Array of TargetDate objects

Enumerated Values

Property Value
stage [ideation, queued, dataPrepAndModeling, validatingAndDeploying, inProduction, retired, onHold]

ValueTrackerDrUserId

{
  "firstName": "string",
  "id": "string",
  "lastName": "string",
  "username": "string"
}

Properties

Name Type Required Restrictions Description
firstName string¦null false First name of class ValueTracker owner
id string true The DR user ID
lastName string¦null false Last of class ValueTracker owner
username string false Username of class ValueTracker owner

ValueTrackerEventDescriptions

{
  "businessImpact": 1,
  "commentId": "string",
  "content": "string",
  "description": "string",
  "feasibility": 1,
  "id": "string",
  "mentions": [
    {
      "firstName": "string",
      "id": "string",
      "lastName": "string",
      "username": "string"
    }
  ],
  "name": "string",
  "notes": "string",
  "owner": {
    "firstName": "string",
    "id": "string",
    "lastName": "string",
    "username": "string"
  },
  "permissions": [
    "string"
  ],
  "potentialValue": {
    "currency": "BRL",
    "details": "string",
    "value": 0
  },
  "potentialValueTemplate": {
    "data": {
      "accuracyImprovement": 0,
      "decisionsCount": 0,
      "incorrectDecisionCost": 0,
      "incorrectDecisionsCount": 0
    },
    "templateType": "classification"
  },
  "predictionTargets": [
    "string"
  ],
  "realizedValue": "string",
  "stage": "ideation",
  "targetDates": [
    {
      "date": "2019-08-24T14:15:22Z",
      "stage": "ideation"
    }
  ]
}

Details of the activity, content depends on activity type

Properties

Name Type Required Restrictions Description
businessImpact integer¦null false maximum: 5
minimum: 1
 Expected effects on overall business operations
commentId string false The id for this comment
content string false A string
description string¦null false class ValueTracker description
feasibility integer¦null false maximum: 5
minimum: 1
 Assessment of how the class ValueTracker can be accomplished across multiple dimensions
id string¦null false The id of this description item
mentions [ValueTrackerDrUserId] false A list of user objects
name string¦null false The name of this event item
notes string¦null false User notes
owner ValueTrackerDrUserId false none
permissions [string]¦null false Permissions of current user
potentialValue ValueTrackerMonetaryValue false Optional, Contains MonetaryValue objects
potentialValueTemplate any false Optional, Contains Template type and parameter information

anyOf

Name Type Required Restrictions Description
» anonymous ValueTrackerValueTemplateClassification false none

or

Name Type Required Restrictions Description
» anonymous ValueTrackerValueTemplateRegression false none

continued

Name Type Required Restrictions Description
predictionTargets [string] false An array of strings prediction target names
realizedValue any false Optional, Contains MonetaryValue objects

anyOf

Name Type Required Restrictions Description
» anonymous string false none

or

Name Type Required Restrictions Description
» anonymous ValueTrackerMonetaryValue false Optional, Contains MonetaryValue objects

continued

Name Type Required Restrictions Description
stage string false Current stage of class ValueTracker
targetDates [ValueTrackerTargetDate]¦null false Array of TargetDate objects

Enumerated Values

Property Value
stage [ideation, queued, dataPrepAndModeling, validatingAndDeploying, inProduction, retired, onHold]

ValueTrackerHealthInformation

{
  "endDate": "2019-08-24T14:15:22Z",
  "message": "string",
  "startDate": "2019-08-24T14:15:22Z",
  "status": "string"
}

Properties

Name Type Required Restrictions Description
endDate string(date-time)¦null true The end date for this health status
message string¦null true Information about the health status
startDate string(date-time)¦null true The start date for this health status
status string¦null true The status of the class ValueTracker

ValueTrackerListResponse

{
  "count": 0,
  "data": [
    {
      "accuracyHealth": "string",
      "businessImpact": 1,
      "commentId": "string",
      "content": "string",
      "description": "string",
      "feasibility": 1,
      "id": "string",
      "inProductionWarning": "string",
      "mentions": [
        {
          "firstName": "string",
          "id": "string",
          "lastName": "string",
          "username": "string"
        }
      ],
      "modelHealth": "string",
      "name": "string",
      "notes": "string",
      "owner": {
        "firstName": "string",
        "id": "string",
        "lastName": "string",
        "username": "string"
      },
      "permissions": [
        "string"
      ],
      "potentialValue": {
        "currency": "BRL",
        "details": "string",
        "value": 0
      },
      "potentialValueTemplate": {
        "data": {
          "accuracyImprovement": 0,
          "decisionsCount": 0,
          "incorrectDecisionCost": 0,
          "incorrectDecisionsCount": 0
        },
        "templateType": "classification"
      },
      "predictionTargets": [
        "string"
      ],
      "predictionsCount": "string",
      "realizedValue": "string",
      "serviceHealth": "string",
      "stage": "ideation",
      "targetDates": [
        {
          "date": "2019-08-24T14:15:22Z",
          "stage": "ideation"
        }
      ]
    }
  ],
  "next": "http://example.com",
  "previous": "http://example.com",
  "totalCount": 0
}

Properties

Name Type Required Restrictions Description
count integer true The number of items returned on this page
data [ValueTrackerResponse] true A list of the class ValueTrackers that match the query
next string(uri)¦null true URL pointing to the next page (if null, there is no next page)
previous string(uri)¦null true URL pointing to the previous page (if null, there is no previous page)
totalCount integer true The number of items matching the query condition

ValueTrackerMonetaryValue

{
  "currency": "BRL",
  "details": "string",
  "value": 0
}

Optional, Contains MonetaryValue objects

Properties

Name Type Required Restrictions Description
currency string true ISO code of currency
details string¦null false Optional user notes
value number true Amount of value

Enumerated Values

Property Value
currency [BRL, EUR, GBP, JPY, KRW, UAH, USD]

ValueTrackerRealizedValuesOverTimeResponse

{
  "buckets": [
    {
      "period": {
        "end": "2019-08-24T14:15:22Z",
        "start": "2019-08-24T14:15:22Z"
      },
      "predictionsCount": 0,
      "realizedValue": 0
    }
  ],
  "previousTimeRangeSummary": {
    "averagePredictionsCount": 0,
    "averageRealizedValue": 0,
    "period": {
      "end": "2019-08-24T14:15:22Z",
      "start": "2019-08-24T14:15:22Z"
    },
    "totalPredictionsCount": 0,
    "totalRealizedValue": 0
  },
  "summary": {
    "averagePredictionsCount": 0,
    "averageRealizedValue": 0,
    "period": {
      "end": "2019-08-24T14:15:22Z",
      "start": "2019-08-24T14:15:22Z"
    },
    "totalPredictionsCount": 0,
    "totalRealizedValue": 0
  }
}

Properties

Name Type Required Restrictions Description
buckets [ValueTrackerBucket] true An array of bucket objects representing prediction totals and realized value over time
previousTimeRangeSummary ValueTrackerSummary true A summary object covering the time range before the given one with the same duration
summary ValueTrackerSummary true A summary object covering the time range before the given one with the same duration

ValueTrackerResponse

{
  "accuracyHealth": "string",
  "businessImpact": 1,
  "commentId": "string",
  "content": "string",
  "description": "string",
  "feasibility": 1,
  "id": "string",
  "inProductionWarning": "string",
  "mentions": [
    {
      "firstName": "string",
      "id": "string",
      "lastName": "string",
      "username": "string"
    }
  ],
  "modelHealth": "string",
  "name": "string",
  "notes": "string",
  "owner": {
    "firstName": "string",
    "id": "string",
    "lastName": "string",
    "username": "string"
  },
  "permissions": [
    "string"
  ],
  "potentialValue": {
    "currency": "BRL",
    "details": "string",
    "value": 0
  },
  "potentialValueTemplate": {
    "data": {
      "accuracyImprovement": 0,
      "decisionsCount": 0,
      "incorrectDecisionCost": 0,
      "incorrectDecisionsCount": 0
    },
    "templateType": "classification"
  },
  "predictionTargets": [
    "string"
  ],
  "predictionsCount": "string",
  "realizedValue": "string",
  "serviceHealth": "string",
  "stage": "ideation",
  "targetDates": [
    {
      "date": "2019-08-24T14:15:22Z",
      "stage": "ideation"
    }
  ]
}

Properties

Name Type Required Restrictions Description
accuracyHealth any false The health of the accuracy

anyOf

Name Type Required Restrictions Description
» anonymous string false none

or

Name Type Required Restrictions Description
» anonymous ValueTrackerHealthInformation false none

continued

Name Type Required Restrictions Description
businessImpact integer¦null false maximum: 5
minimum: 1
 Expected effects on overall business operations
commentId string false The id for this comment
content string false A string
description string¦null false class ValueTracker description
feasibility integer¦null false maximum: 5
minimum: 1
 Assessment of how the class ValueTracker can be accomplished across multiple dimensions
id string false The id of the class ValueTracker
inProductionWarning string¦null false An optional warning to indicate that deployments are attached to this class ValueTracker.
mentions [ValueTrackerDrUserId] false A list of user objects
modelHealth any false The health of the model

anyOf

Name Type Required Restrictions Description
» anonymous string false none

or

Name Type Required Restrictions Description
» anonymous ValueTrackerHealthInformation false none

continued

Name Type Required Restrictions Description
name string false Name of the class ValueTracker
notes string¦null false User notes
owner ValueTrackerDrUserId false none
permissions [string]¦null false Permissions of current user
potentialValue ValueTrackerMonetaryValue false Optional, Contains MonetaryValue objects
potentialValueTemplate any false Optional, Contains Template type and parameter information

anyOf

Name Type Required Restrictions Description
» anonymous ValueTrackerValueTemplateClassification false none

or

Name Type Required Restrictions Description
» anonymous ValueTrackerValueTemplateRegression false none

continued

Name Type Required Restrictions Description
predictionTargets [string] false An array of strings prediction target names
predictionsCount any false Count of the number of predictions made.

anyOf

Name Type Required Restrictions Description
» anonymous string false none

or

Name Type Required Restrictions Description
» anonymous integer false none

or

Name Type Required Restrictions Description
» anonymous [integer]¦null false A list of prediction counts.

continued

Name Type Required Restrictions Description
realizedValue any false Optional, Contains MonetaryValue objects

anyOf

Name Type Required Restrictions Description
» anonymous string false none

or

Name Type Required Restrictions Description
» anonymous ValueTrackerMonetaryValue false Optional, Contains MonetaryValue objects

continued

Name Type Required Restrictions Description
serviceHealth any false The health of the service

anyOf

Name Type Required Restrictions Description
» anonymous string false none

or

Name Type Required Restrictions Description
» anonymous ValueTrackerHealthInformation false none

continued

Name Type Required Restrictions Description
stage string false Current stage of class ValueTracker
targetDates [ValueTrackerTargetDate]¦null false Array of TargetDate objects

Enumerated Values

Property Value
stage [ideation, queued, dataPrepAndModeling, validatingAndDeploying, inProduction, retired, onHold]

ValueTrackerSharingListData

{
  "id": "string",
  "name": "string",
  "role": "OWNER",
  "shareRecipientType": "user"
}

Properties

Name Type Required Restrictions Description
id string true The ID of the recipient
name string false The name of the user, group, or organization
role string true The assigned role
shareRecipientType string true The recipient type

Enumerated Values

Property Value
role [OWNER, USER, CONSUMER, NO_ROLE]
shareRecipientType [user, group, organization]

ValueTrackerSharingListResponse

{
  "count": 0,
  "data": [
    {
      "id": "string",
      "name": "string",
      "role": "OWNER",
      "shareRecipientType": "user"
    }
  ],
  "next": "http://example.com",
  "previous": "http://example.com",
  "totalCount": 0
}

Properties

Name Type Required Restrictions Description
count integer true The number of items returned on this page
data [ValueTrackerSharingListData] true A list of sharing role objects
next string(uri)¦null true URL pointing to the next page (if null, there is no next page)
previous string(uri)¦null true URL pointing to the previous page (if null, there is no previous page)
totalCount integer true The number of items matching the query condition

ValueTrackerSharingRoleUpdateData

{
  "id": "string",
  "role": "OWNER",
  "shareRecipientType": "user",
  "username": "string"
}

Properties

Name Type Required Restrictions Description
id string false The ID of the recipient
role string true The assigned role
shareRecipientType string true The recipient type
username string false The name of the user, group, or organization

Enumerated Values

Property Value
role [OWNER, USER, CONSUMER, NO_ROLE]
shareRecipientType [user, group, organization]

ValueTrackerSharingUpdate

{
  "operation": "updateRoles",
  "roles": [
    {
      "id": "string",
      "role": "OWNER",
      "shareRecipientType": "user",
      "username": "string"
    }
  ]
}

Properties

Name Type Required Restrictions Description
operation string true The name of the action being taken. Only 'updateRoles' is supported.
roles [ValueTrackerSharingRoleUpdateData] true A list of sharing role objects

Enumerated Values

Property Value
operation updateRoles

ValueTrackerSummary

{
  "averagePredictionsCount": 0,
  "averageRealizedValue": 0,
  "period": {
    "end": "2019-08-24T14:15:22Z",
    "start": "2019-08-24T14:15:22Z"
  },
  "totalPredictionsCount": 0,
  "totalRealizedValue": 0
}

A summary object covering the time range before the given one with the same duration

Properties

Name Type Required Restrictions Description
averagePredictionsCount integer true Average number of predictions per bucket during this time period
averageRealizedValue integer false Average amount of value per bucket realised during this time period
period ValueTrackerBucketPeriod true A period object describing the time this bucket covers
totalPredictionsCount integer false Total number of predictions that happened during this time period
totalRealizedValue integer true Total amount of value realised during this time period

ValueTrackerTargetDate

{
  "date": "2019-08-24T14:15:22Z",
  "stage": "ideation"
}

Properties

Name Type Required Restrictions Description
date string(date-time) true Date of the target
stage string true Name of the target stage

Enumerated Values

Property Value
stage [ideation, queued, dataPrepAndModeling, validatingAndDeploying, inProduction, retired, onHold]

ValueTrackerUpdate

{
  "businessImpact": 1,
  "description": "string",
  "feasibility": 1,
  "name": "string",
  "notes": "string",
  "owner": {
    "firstName": "string",
    "id": "string",
    "lastName": "string",
    "username": "string"
  },
  "potentialValue": {
    "currency": "BRL",
    "details": "string",
    "value": 0
  },
  "potentialValueTemplate": {
    "data": {
      "accuracyImprovement": 0,
      "decisionsCount": 0,
      "incorrectDecisionCost": 0,
      "incorrectDecisionsCount": 0
    },
    "templateType": "classification"
  },
  "predictionTargets": [
    "string"
  ],
  "realizedValue": {
    "currency": "BRL",
    "details": "string",
    "value": 0
  },
  "stage": "ideation",
  "targetDates": [
    {
      "date": "2019-08-24T14:15:22Z",
      "stage": "ideation"
    }
  ]
}

Properties

Name Type Required Restrictions Description
businessImpact integer¦null false maximum: 5
minimum: 1
 Expected effects on overall business operations
description string¦null false maxLength: 1024
 class ValueTracker description
feasibility integer¦null false maximum: 5
minimum: 1
 Assessment of how the class ValueTracker can be accomplished across multiple dimensions
name string false maxLength: 512
 Name of the class ValueTracker
notes string¦null false maxLength: 1024
 User notes
owner ValueTrackerDrUserId false none
potentialValue ValueTrackerMonetaryValue false Optional, Contains MonetaryValue objects
potentialValueTemplate any false Contains Template type and parameter information defined in the response of GET /api/v2/valueTrackerValueTemplates/{templateType}/calculation/

anyOf

Name Type Required Restrictions Description
» anonymous ValueTrackerValueTemplateClassification false none

or

Name Type Required Restrictions Description
» anonymous ValueTrackerValueTemplateRegression false none

continued

Name Type Required Restrictions Description
predictionTargets [string]¦null false An array of strings prediction target names
realizedValue ValueTrackerMonetaryValue false Optional, Contains MonetaryValue objects
stage string false Current stage of class ValueTracker
targetDates [ValueTrackerTargetDate]¦null false Array of TargetDate objects

Enumerated Values

Property Value
stage [ideation, queued, dataPrepAndModeling, validatingAndDeploying, inProduction, retired, onHold]

ValueTrackerValueCalculateTemplate

{
  "data": {
    "accuracyImprovement": 0,
    "decisionsCount": 0,
    "incorrectDecisionCost": 0,
    "incorrectDecisionsCount": 0
  },
  "templateType": "classification"
}

Template type and data used for calculating the result

Properties

Name Type Required Restrictions Description
data any true Data used for calculating the result

oneOf

Name Type Required Restrictions Description
» anonymous ValueTrackerValueTemplateClassificationData false class ValueTracker value data

xor

Name Type Required Restrictions Description
» anonymous ValueTrackerValueTemplateRegressionData false class ValueTracker value data

continued

Name Type Required Restrictions Description
templateType string true The name of the class ValueTracker value template

Enumerated Values

Property Value
templateType [classification, regression]

ValueTrackerValueTemplateCalculateResponse

{
  "averageValuePerDecision": 0,
  "savedAnnually": 0,
  "template": {
    "data": {
      "accuracyImprovement": 0,
      "decisionsCount": 0,
      "incorrectDecisionCost": 0,
      "incorrectDecisionsCount": 0
    },
    "templateType": "classification"
  }
}

Properties

Name Type Required Restrictions Description
averageValuePerDecision number true Estimated average value per decision
savedAnnually number true Estimated amount saved annually
template ValueTrackerValueCalculateTemplate true Template type and data used for calculating the result

ValueTrackerValueTemplateClassification

{
  "data": {
    "accuracyImprovement": 0,
    "decisionsCount": 0,
    "incorrectDecisionCost": 0,
    "incorrectDecisionsCount": 0
  },
  "templateType": "classification"
}

Properties

Name Type Required Restrictions Description
data ValueTrackerValueTemplateClassificationData true class ValueTracker value data
templateType string true class ValueTracker value template type

Enumerated Values

Property Value
templateType classification

ValueTrackerValueTemplateClassificationData

{
  "accuracyImprovement": 0,
  "decisionsCount": 0,
  "incorrectDecisionCost": 0,
  "incorrectDecisionsCount": 0
}

class ValueTracker value data

Properties

Name Type Required Restrictions Description
accuracyImprovement number true Accuracy improvement
decisionsCount integer true Estimated number of decisions per year
incorrectDecisionCost number true Estimated cost of an individual incorrect decision
incorrectDecisionsCount integer true Estimated number of incorrect decisions per year

ValueTrackerValueTemplateParameterWithSchema

{
  "parameterName": "string",
  "schema": {
    "elementType": "integer",
    "label": "string",
    "maximum": 0,
    "minimum": 0,
    "placeholder": "string",
    "unit": "string"
  }
}

Properties

Name Type Required Restrictions Description
parameterName string true Name of the parameter
schema ValueTrackerValueTemplateSchema true Schema entry defining the type and limits of a template parameter

ValueTrackerValueTemplateRegression

{
  "data": {
    "accuracyImprovement": 0,
    "decisionsCount": 0,
    "targetValue": 0
  },
  "templateType": "regression"
}

Properties

Name Type Required Restrictions Description
data ValueTrackerValueTemplateRegressionData true class ValueTracker value data
templateType string true class ValueTracker value template type

Enumerated Values

Property Value
templateType regression

ValueTrackerValueTemplateRegressionData

{
  "accuracyImprovement": 0,
  "decisionsCount": 0,
  "targetValue": 0
}

class ValueTracker value data

Properties

Name Type Required Restrictions Description
accuracyImprovement number true Accuracy improvement
decisionsCount integer true Estimated number of decisions per year
targetValue number true Target value

ValueTrackerValueTemplateResponse

{
  "description": "string",
  "schema": [
    {
      "parameterName": "string",
      "schema": {
        "elementType": "integer",
        "label": "string",
        "maximum": 0,
        "minimum": 0,
        "placeholder": "string",
        "unit": "string"
      }
    }
  ],
  "templateType": "classification",
  "title": "string"
}

Properties

Name Type Required Restrictions Description
description string true Description of Value Template
schema [ValueTrackerValueTemplateParameterWithSchema] true Schema definition of all template parameters
templateType string true The name of the class ValueTracker value template to be retrieved
title string true Title of Value Template

Enumerated Values

Property Value
templateType [classification, regression]

ValueTrackerValueTemplateSchema

{
  "elementType": "integer",
  "label": "string",
  "maximum": 0,
  "minimum": 0,
  "placeholder": "string",
  "unit": "string"
}

Schema entry defining the type and limits of a template parameter

Properties

Name Type Required Restrictions Description
elementType string true Possible types used for template variables
label string true Label describing the represented value
maximum integer¦null true Sets Maximum value if given
minimum integer¦null true Sets Minimum value if given
placeholder string true Text that can be used to prefill an input filed for the value
unit string¦null true Unit type. e.g. %

Enumerated Values

Property Value
elementType [integer, float, number]
Updated November 26, 2024