Value Tracker
Use the endpoints described below to manage Value Trackers, as well as add comments and host discussions.
Post a comment
Body parameter
{
"properties": {
"content": {
"description": "Content of the comment, 10000 symbols max",
"maxLength": 10000,
"type": "string"
},
"entityId": {
"description": "ID of the entity to post the comment to",
"type": "string"
},
"entityType": {
"description": "Type of the entity to post the comment to, currently only useCase is supported",
"enum": [
"useCase",
"model",
"catalog",
"experimentContainer",
"deployment"
],
"type": "string"
},
"mentions": {
"description": "A list of users IDs mentioned in the content",
"items": {
"type": "string"
},
"maxItems": 100,
"type": "array"
}
},
"required": [
"content",
"entityId",
"entityType"
],
"type": "object"
}
| Name |
In |
Type |
Required |
Description |
| body |
body |
Comment |
false |
none |
Example responses
200 Response
{
"properties": {
"content": {
"description": "Content of the comment",
"type": "string"
},
"createdAt": {
"description": "Timestamp when the comment was created",
"type": "string"
},
"createdBy": {
"description": "User object with information about the commenter",
"properties": {
"firstName": {
"description": "First name of the commenter",
"type": "string"
},
"id": {
"description": "User ID of the commenter",
"type": "string"
},
"lastName": {
"description": "Last name of the commenter",
"type": "string"
},
"username": {
"description": "Username of the commenter",
"type": "string"
}
},
"required": [
"firstName",
"id",
"lastName",
"username"
],
"type": "object"
},
"entityId": {
"description": "ID of the entity the comment posted to",
"type": "string"
},
"entityType": {
"description": "Type of the entity to post the comment to, currently only useCase is supported",
"enum": [
"useCase",
"model",
"catalog",
"experimentContainer",
"deployment"
],
"type": "string"
},
"id": {
"description": "ID of the comment",
"type": "string"
},
"mentions": {
"description": "A list of users objects (see below) mentioned in the content",
"items": {
"description": "User object with information about the commenter",
"properties": {
"firstName": {
"description": "First name of the commenter",
"type": "string"
},
"id": {
"description": "User ID of the commenter",
"type": "string"
},
"lastName": {
"description": "Last name of the commenter",
"type": "string"
},
"username": {
"description": "Username of the commenter",
"type": "string"
}
},
"required": [
"firstName",
"id",
"lastName",
"username"
],
"type": "object"
},
"type": "array"
},
"updatedAt": {
"description": "Timestamp when the comment was updated",
"type": "string"
}
},
"required": [
"content",
"createdAt",
"createdBy",
"entityId",
"entityType",
"id",
"mentions",
"updatedAt"
],
"type": "object"
}
Responses
To perform this operation, you must be authenticated by means of one of the following methods:
BearerAuth
Delete a comment
| Name |
In |
Type |
Required |
Description |
| commentId |
path |
string |
true |
The ID of the comment |
Responses
| Status |
Meaning |
Description |
Schema |
| 200 |
OK |
none |
None |
| 204 |
No Content |
The use case comment was deleted |
None |
To perform this operation, you must be authenticated by means of one of the following methods:
BearerAuth
Retrieve a comment
| Name |
In |
Type |
Required |
Description |
| commentId |
path |
string |
true |
The ID of the comment |
Example responses
200 Response
{
"properties": {
"content": {
"description": "Content of the comment",
"type": "string"
},
"createdAt": {
"description": "Timestamp when the comment was created",
"type": "string"
},
"createdBy": {
"description": "User object with information about the commenter",
"properties": {
"firstName": {
"description": "First name of the commenter",
"type": "string"
},
"id": {
"description": "User ID of the commenter",
"type": "string"
},
"lastName": {
"description": "Last name of the commenter",
"type": "string"
},
"username": {
"description": "Username of the commenter",
"type": "string"
}
},
"required": [
"firstName",
"id",
"lastName",
"username"
],
"type": "object"
},
"entityId": {
"description": "ID of the entity the comment posted to",
"type": "string"
},
"entityType": {
"description": "Type of the entity to post the comment to, currently only useCase is supported",
"enum": [
"useCase",
"model",
"catalog",
"experimentContainer",
"deployment"
],
"type": "string"
},
"id": {
"description": "ID of the comment",
"type": "string"
},
"mentions": {
"description": "A list of users objects (see below) mentioned in the content",
"items": {
"description": "User object with information about the commenter",
"properties": {
"firstName": {
"description": "First name of the commenter",
"type": "string"
},
"id": {
"description": "User ID of the commenter",
"type": "string"
},
"lastName": {
"description": "Last name of the commenter",
"type": "string"
},
"username": {
"description": "Username of the commenter",
"type": "string"
}
},
"required": [
"firstName",
"id",
"lastName",
"username"
],
"type": "object"
},
"type": "array"
},
"updatedAt": {
"description": "Timestamp when the comment was updated",
"type": "string"
}
},
"required": [
"content",
"createdAt",
"createdBy",
"entityId",
"entityType",
"id",
"mentions",
"updatedAt"
],
"type": "object"
}
Responses
To perform this operation, you must be authenticated by means of one of the following methods:
BearerAuth
Update a comment
Body parameter
{
"properties": {
"content": {
"description": "Updated content of the comment, 10000 symbols max",
"maxLength": 10000,
"type": "string"
},
"mentions": {
"description": "A list of users IDs mentioned in the content",
"items": {
"type": "string"
},
"maxItems": 100,
"type": "array"
}
},
"required": [
"content"
],
"type": "object"
}
| Name |
In |
Type |
Required |
Description |
| commentId |
path |
string |
true |
The ID of the comment |
| body |
body |
CommentUpdate |
false |
none |
Responses
| Status |
Meaning |
Description |
Schema |
| 200 |
OK |
none |
None |
| 204 |
No Content |
The comment was successfully updated |
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
List comments
| 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 comments by a field of the comment. |
| entityId |
path |
string |
true |
ID of the entity to retrieve comments of |
| entityType |
path |
string |
true |
Type of the entity to retrieve a comments of, currently only useCase is supported |
Enumerated Values
| Parameter |
Value |
| orderBy |
[createdAt, -createdAt, updatedAt, -updatedAt] |
| entityType |
[useCase, model, catalog, experimentContainer, deployment] |
Example responses
200 Response
{
"properties": {
"count": {
"description": "Number of items returned on this page",
"type": "integer"
},
"data": {
"description": "A list of comments",
"items": {
"properties": {
"content": {
"description": "Content of the comment",
"type": "string"
},
"createdAt": {
"description": "Timestamp when the comment was created",
"type": "string"
},
"createdBy": {
"description": "User object with information about the commenter",
"properties": {
"firstName": {
"description": "First name of the commenter",
"type": "string"
},
"id": {
"description": "User ID of the commenter",
"type": "string"
},
"lastName": {
"description": "Last name of the commenter",
"type": "string"
},
"username": {
"description": "Username of the commenter",
"type": "string"
}
},
"required": [
"firstName",
"id",
"lastName",
"username"
],
"type": "object"
},
"entityId": {
"description": "ID of the entity the comment posted to",
"type": "string"
},
"entityType": {
"description": "Type of the entity to post the comment to, currently only useCase is supported",
"enum": [
"useCase",
"model",
"catalog",
"experimentContainer",
"deployment"
],
"type": "string"
},
"id": {
"description": "ID of the comment",
"type": "string"
},
"mentions": {
"description": "A list of users objects (see below) mentioned in the content",
"items": {
"description": "User object with information about the commenter",
"properties": {
"firstName": {
"description": "First name of the commenter",
"type": "string"
},
"id": {
"description": "User ID of the commenter",
"type": "string"
},
"lastName": {
"description": "Last name of the commenter",
"type": "string"
},
"username": {
"description": "Username of the commenter",
"type": "string"
}
},
"required": [
"firstName",
"id",
"lastName",
"username"
],
"type": "object"
},
"type": "array"
},
"updatedAt": {
"description": "Timestamp when the comment was updated",
"type": "string"
}
},
"required": [
"content",
"createdAt",
"createdBy",
"entityId",
"entityType",
"id",
"mentions",
"updatedAt"
],
"type": "object"
},
"type": "array"
},
"next": {
"description": "URL pointing to the next page (if null, there is no next page)",
"format": "uri",
"type": [
"string",
"null"
]
},
"previous": {
"description": "URL pointing to the previous page (if null, there is no previous page)",
"format": "uri",
"type": [
"string",
"null"
]
},
"totalCount": {
"description": "Number of all available items",
"type": "integer"
}
},
"required": [
"count",
"data",
"next",
"previous",
"totalCount"
],
"type": "object"
}
Responses
To perform this operation, you must be authenticated by means of one of the following methods:
BearerAuth
GET /api/v2/valueTrackerValueTemplates/
List available value trackers templates.
Example responses
200 Response
{
"items": {
"properties": {
"description": {
"description": "Description of Value Template",
"type": "string"
},
"schema": {
"description": "Schema definition of all template parameters",
"items": {
"properties": {
"parameterName": {
"description": "Name of the parameter",
"type": "string"
},
"schema": {
"description": "Schema entry defining the type and limits of a template parameter",
"properties": {
"elementType": {
"description": "Possible types used for template variables",
"enum": [
"integer",
"float",
"number"
],
"type": "string"
},
"label": {
"description": "Label describing the represented value",
"type": "string"
},
"maximum": {
"description": "Sets Maximum value if given",
"type": [
"integer",
"null"
]
},
"minimum": {
"description": "Sets Minimum value if given",
"type": [
"integer",
"null"
]
},
"placeholder": {
"description": "Text that can be used to prefill an input filed for the value",
"type": "string"
},
"unit": {
"description": "Unit type. e.g. %",
"type": [
"string",
"null"
]
}
},
"required": [
"elementType",
"label",
"maximum",
"minimum",
"placeholder",
"unit"
],
"type": "object"
}
},
"required": [
"parameterName",
"schema"
],
"type": "object"
},
"type": "array"
},
"templateType": {
"description": "The name of the class ValueTracker value template to be retrieved",
"enum": [
"classification",
"regression"
],
"type": "string"
},
"title": {
"description": "Title of Value Template",
"type": "string"
}
},
"required": [
"description",
"schema",
"templateType",
"title"
],
"type": "object"
},
"type": "array"
}
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.
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
{
"properties": {
"description": {
"description": "Description of Value Template",
"type": "string"
},
"schema": {
"description": "Schema definition of all template parameters",
"items": {
"properties": {
"parameterName": {
"description": "Name of the parameter",
"type": "string"
},
"schema": {
"description": "Schema entry defining the type and limits of a template parameter",
"properties": {
"elementType": {
"description": "Possible types used for template variables",
"enum": [
"integer",
"float",
"number"
],
"type": "string"
},
"label": {
"description": "Label describing the represented value",
"type": "string"
},
"maximum": {
"description": "Sets Maximum value if given",
"type": [
"integer",
"null"
]
},
"minimum": {
"description": "Sets Minimum value if given",
"type": [
"integer",
"null"
]
},
"placeholder": {
"description": "Text that can be used to prefill an input filed for the value",
"type": "string"
},
"unit": {
"description": "Unit type. e.g. %",
"type": [
"string",
"null"
]
}
},
"required": [
"elementType",
"label",
"maximum",
"minimum",
"placeholder",
"unit"
],
"type": "object"
}
},
"required": [
"parameterName",
"schema"
],
"type": "object"
},
"type": "array"
},
"templateType": {
"description": "The name of the class ValueTracker value template to be retrieved",
"enum": [
"classification",
"regression"
],
"type": "string"
},
"title": {
"description": "Title of Value Template",
"type": "string"
}
},
"required": [
"description",
"schema",
"templateType",
"title"
],
"type": "object"
}
Responses
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.
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
{
"properties": {
"averageValuePerDecision": {
"description": "Estimated average value per decision",
"type": "number"
},
"savedAnnually": {
"description": "Estimated amount saved annually",
"type": "number"
},
"template": {
"description": "Template type and data used for calculating the result",
"properties": {
"data": {
"description": "Data used for calculating the result",
"oneOf": [
{
"description": "class ValueTracker value data",
"properties": {
"accuracyImprovement": {
"description": "Accuracy improvement",
"type": "number"
},
"decisionsCount": {
"description": "Estimated number of decisions per year",
"type": "integer"
},
"incorrectDecisionCost": {
"description": "Estimated cost of an individual incorrect decision",
"type": "number"
},
"incorrectDecisionsCount": {
"description": "Estimated number of incorrect decisions per year",
"type": "integer"
}
},
"required": [
"accuracyImprovement",
"decisionsCount",
"incorrectDecisionCost",
"incorrectDecisionsCount"
],
"type": "object"
},
{
"description": "class ValueTracker value data",
"properties": {
"accuracyImprovement": {
"description": "Accuracy improvement",
"type": "number"
},
"decisionsCount": {
"description": "Estimated number of decisions per year",
"type": "integer"
},
"targetValue": {
"description": "Target value",
"type": "number"
}
},
"required": [
"accuracyImprovement",
"decisionsCount",
"targetValue"
],
"type": "object"
}
]
},
"templateType": {
"description": "The name of the class ValueTracker value template",
"enum": [
"classification",
"regression"
],
"type": "string"
}
},
"required": [
"data",
"templateType"
],
"type": "object"
}
},
"required": [
"averageValuePerDecision",
"savedAnnually",
"template"
],
"type": "object"
}
Responses
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.
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
{
"properties": {
"count": {
"description": "The number of items returned on this page",
"type": "integer"
},
"data": {
"description": "A list of the class ValueTrackers that match the query",
"items": {
"description": "class ValueTracker information",
"properties": {
"accuracyHealth": {
"anyOf": [
{
"type": "string"
},
{
"properties": {
"endDate": {
"description": "The end date for this health status",
"format": "date-time",
"type": [
"string",
"null"
]
},
"message": {
"description": "Information about the health status",
"type": [
"string",
"null"
]
},
"startDate": {
"description": "The start date for this health status",
"format": "date-time",
"type": [
"string",
"null"
]
},
"status": {
"description": "The status of the class ValueTracker",
"type": [
"string",
"null"
]
}
},
"required": [
"endDate",
"message",
"startDate",
"status"
],
"type": "object"
}
],
"description": "The health of the accuracy"
},
"businessImpact": {
"description": "Expected effects on overall business operations",
"maximum": 5,
"minimum": 1,
"type": [
"integer",
"null"
]
},
"commentId": {
"description": "The id for this comment",
"type": "string"
},
"content": {
"description": "A string",
"type": "string"
},
"description": {
"description": "class ValueTracker description",
"type": [
"string",
"null"
]
},
"feasibility": {
"description": "Assessment of how the class ValueTracker can be accomplished across multiple dimensions",
"maximum": 5,
"minimum": 1,
"type": [
"integer",
"null"
]
},
"id": {
"description": "The id of the class ValueTracker",
"type": "string"
},
"inProductionWarning": {
"description": "An optional warning to indicate that deployments are attached to this class ValueTracker.",
"type": [
"string",
"null"
]
},
"mentions": {
"description": "A list of user objects",
"items": {
"description": "DataRobot user information",
"properties": {
"firstName": {
"description": "First name of class ValueTracker owner",
"type": [
"string",
"null"
]
},
"id": {
"description": "The DR user ID",
"type": "string"
},
"lastName": {
"description": "Last of class ValueTracker owner",
"type": [
"string",
"null"
]
},
"username": {
"description": "Username of class ValueTracker owner",
"type": "string"
}
},
"required": [
"id"
],
"type": "object"
},
"type": "array"
},
"modelHealth": {
"anyOf": [
{
"type": "string"
},
{
"properties": {
"endDate": {
"description": "The end date for this health status",
"format": "date-time",
"type": [
"string",
"null"
]
},
"message": {
"description": "Information about the health status",
"type": [
"string",
"null"
]
},
"startDate": {
"description": "The start date for this health status",
"format": "date-time",
"type": [
"string",
"null"
]
},
"status": {
"description": "The status of the class ValueTracker",
"type": [
"string",
"null"
]
}
},
"required": [
"endDate",
"message",
"startDate",
"status"
],
"type": "object"
}
],
"description": "The health of the model"
},
"name": {
"description": "Name of the class ValueTracker",
"type": "string"
},
"notes": {
"description": "User notes",
"type": [
"string",
"null"
]
},
"owner": {
"description": "DataRobot user information",
"properties": {
"firstName": {
"description": "First name of class ValueTracker owner",
"type": [
"string",
"null"
]
},
"id": {
"description": "The DR user ID",
"type": "string"
},
"lastName": {
"description": "Last of class ValueTracker owner",
"type": [
"string",
"null"
]
},
"username": {
"description": "Username of class ValueTracker owner",
"type": "string"
}
},
"required": [
"id"
],
"type": "object"
},
"permissions": {
"description": "Permissions of current user",
"items": {
"type": "string"
},
"type": "array"
},
"potentialValue": {
"description": "Optional, Contains MonetaryValue objects",
"properties": {
"currency": {
"description": "ISO code of currency",
"enum": [
"AED",
"BRL",
"CHF",
"EUR",
"GBP",
"JPY",
"KRW",
"UAH",
"USD",
"ZAR"
],
"type": "string"
},
"details": {
"description": "Optional user notes",
"type": [
"string",
"null"
]
},
"value": {
"description": "Amount of value",
"type": "number"
}
},
"required": [
"currency",
"value"
],
"type": "object"
},
"potentialValueTemplate": {
"anyOf": [
{
"properties": {
"data": {
"description": "class ValueTracker value data",
"properties": {
"accuracyImprovement": {
"description": "Accuracy improvement",
"type": "number"
},
"decisionsCount": {
"description": "Estimated number of decisions per year",
"type": "integer"
},
"incorrectDecisionCost": {
"description": "Estimated cost of an individual incorrect decision",
"type": "number"
},
"incorrectDecisionsCount": {
"description": "Estimated number of incorrect decisions per year",
"type": "integer"
}
},
"required": [
"accuracyImprovement",
"decisionsCount",
"incorrectDecisionCost",
"incorrectDecisionsCount"
],
"type": "object"
},
"templateType": {
"description": "class ValueTracker value template type",
"enum": [
"classification"
],
"type": "string"
}
},
"required": [
"data",
"templateType"
],
"type": "object"
},
{
"properties": {
"data": {
"description": "class ValueTracker value data",
"properties": {
"accuracyImprovement": {
"description": "Accuracy improvement",
"type": "number"
},
"decisionsCount": {
"description": "Estimated number of decisions per year",
"type": "integer"
},
"targetValue": {
"description": "Target value",
"type": "number"
}
},
"required": [
"accuracyImprovement",
"decisionsCount",
"targetValue"
],
"type": "object"
},
"templateType": {
"description": "class ValueTracker value template type",
"enum": [
"regression"
],
"type": "string"
}
},
"required": [
"data",
"templateType"
],
"type": "object"
}
],
"description": "Optional, Contains Template type and parameter information"
},
"predictionTargets": {
"description": "An array of strings prediction target names",
"items": {
"description": "The name of the prediction target",
"type": "string"
},
"type": "array"
},
"predictionsCount": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"description": "A list of prediction counts.",
"items": {
"type": "integer"
},
"type": "array"
}
],
"description": "Count of the number of predictions made."
},
"realizedValue": {
"anyOf": [
{
"type": "string"
},
{
"description": "Optional, Contains MonetaryValue objects",
"properties": {
"currency": {
"description": "ISO code of currency",
"enum": [
"AED",
"BRL",
"CHF",
"EUR",
"GBP",
"JPY",
"KRW",
"UAH",
"USD",
"ZAR"
],
"type": "string"
},
"details": {
"description": "Optional user notes",
"type": [
"string",
"null"
]
},
"value": {
"description": "Amount of value",
"type": "number"
}
},
"required": [
"currency",
"value"
],
"type": "object"
}
],
"description": "Optional, Contains MonetaryValue objects"
},
"serviceHealth": {
"anyOf": [
{
"type": "string"
},
{
"properties": {
"endDate": {
"description": "The end date for this health status",
"format": "date-time",
"type": [
"string",
"null"
]
},
"message": {
"description": "Information about the health status",
"type": [
"string",
"null"
]
},
"startDate": {
"description": "The start date for this health status",
"format": "date-time",
"type": [
"string",
"null"
]
},
"status": {
"description": "The status of the class ValueTracker",
"type": [
"string",
"null"
]
}
},
"required": [
"endDate",
"message",
"startDate",
"status"
],
"type": "object"
}
],
"description": "The health of the service"
},
"stage": {
"description": "Current stage of class ValueTracker",
"enum": [
"ideation",
"queued",
"dataPrepAndModeling",
"validatingAndDeploying",
"inProduction",
"retired",
"onHold"
],
"type": "string"
},
"targetDates": {
"description": "Array of TargetDate objects",
"items": {
"properties": {
"date": {
"description": "Date of the target",
"format": "date-time",
"type": "string"
},
"stage": {
"description": "Name of the target stage",
"enum": [
"ideation",
"queued",
"dataPrepAndModeling",
"validatingAndDeploying",
"inProduction",
"retired",
"onHold"
],
"type": "string"
}
},
"required": [
"date",
"stage"
],
"type": "object"
},
"type": "array"
}
},
"type": "object"
},
"type": "array"
},
"next": {
"description": "URL pointing to the next page (if null, there is no next page)",
"format": "uri",
"type": [
"string",
"null"
]
},
"previous": {
"description": "URL pointing to the previous page (if null, there is no previous page)",
"format": "uri",
"type": [
"string",
"null"
]
},
"totalCount": {
"description": "The number of items matching the query condition",
"type": "integer"
}
},
"required": [
"count",
"data",
"next",
"previous",
"totalCount"
],
"type": "object"
}
Responses
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.
Body parameter
{
"properties": {
"businessImpact": {
"description": "Expected effects on overall business operations",
"maximum": 5,
"minimum": 1,
"type": [
"integer",
"null"
]
},
"commentId": {
"description": "The id for this comment",
"type": "string"
},
"content": {
"description": "A string",
"type": "string"
},
"description": {
"description": "class ValueTracker description",
"maxLength": 1024,
"type": "string"
},
"feasibility": {
"description": "Assessment of how the class ValueTracker can be accomplished across multiple dimensions",
"maximum": 5,
"minimum": 1,
"type": [
"integer",
"null"
]
},
"id": {
"description": "The id of this description item",
"type": [
"string",
"null"
]
},
"mentions": {
"description": "A list of user objects",
"items": {
"description": "DataRobot user information",
"properties": {
"firstName": {
"description": "First name of class ValueTracker owner",
"type": [
"string",
"null"
]
},
"id": {
"description": "The DR user ID",
"type": "string"
},
"lastName": {
"description": "Last of class ValueTracker owner",
"type": [
"string",
"null"
]
},
"username": {
"description": "Username of class ValueTracker owner",
"type": "string"
}
},
"required": [
"id"
],
"type": "object"
},
"type": "array"
},
"name": {
"description": "Name of the class ValueTracker",
"maxLength": 512,
"type": "string"
},
"notes": {
"description": "User notes",
"type": [
"string",
"null"
]
},
"owner": {
"description": "DataRobot user information",
"properties": {
"firstName": {
"description": "First name of class ValueTracker owner",
"type": [
"string",
"null"
]
},
"id": {
"description": "The DR user ID",
"type": "string"
},
"lastName": {
"description": "Last of class ValueTracker owner",
"type": [
"string",
"null"
]
},
"username": {
"description": "Username of class ValueTracker owner",
"type": "string"
}
},
"required": [
"id"
],
"type": "object"
},
"permissions": {
"description": "Permissions of current user",
"items": {
"type": "string"
},
"type": "array"
},
"potentialValue": {
"description": "Optional, Contains MonetaryValue objects",
"properties": {
"currency": {
"description": "ISO code of currency",
"enum": [
"AED",
"BRL",
"CHF",
"EUR",
"GBP",
"JPY",
"KRW",
"UAH",
"USD",
"ZAR"
],
"type": "string"
},
"details": {
"description": "Optional user notes",
"type": [
"string",
"null"
]
},
"value": {
"description": "Amount of value",
"type": "number"
}
},
"required": [
"currency",
"value"
],
"type": "object"
},
"potentialValueTemplate": {
"anyOf": [
{
"properties": {
"data": {
"description": "class ValueTracker value data",
"properties": {
"accuracyImprovement": {
"description": "Accuracy improvement",
"type": "number"
},
"decisionsCount": {
"description": "Estimated number of decisions per year",
"type": "integer"
},
"incorrectDecisionCost": {
"description": "Estimated cost of an individual incorrect decision",
"type": "number"
},
"incorrectDecisionsCount": {
"description": "Estimated number of incorrect decisions per year",
"type": "integer"
}
},
"required": [
"accuracyImprovement",
"decisionsCount",
"incorrectDecisionCost",
"incorrectDecisionsCount"
],
"type": "object"
},
"templateType": {
"description": "class ValueTracker value template type",
"enum": [
"classification"
],
"type": "string"
}
},
"required": [
"data",
"templateType"
],
"type": "object"
},
{
"properties": {
"data": {
"description": "class ValueTracker value data",
"properties": {
"accuracyImprovement": {
"description": "Accuracy improvement",
"type": "number"
},
"decisionsCount": {
"description": "Estimated number of decisions per year",
"type": "integer"
},
"targetValue": {
"description": "Target value",
"type": "number"
}
},
"required": [
"accuracyImprovement",
"decisionsCount",
"targetValue"
],
"type": "object"
},
"templateType": {
"description": "class ValueTracker value template type",
"enum": [
"regression"
],
"type": "string"
}
},
"required": [
"data",
"templateType"
],
"type": "object"
}
],
"description": "Optional, Contains Template type and parameter information"
},
"predictionTargets": {
"description": "An array of strings prediction target names",
"items": {
"description": "The name of the prediction target",
"type": "string"
},
"type": "array"
},
"realizedValue": {
"anyOf": [
{
"type": "string"
},
{
"description": "Optional, Contains MonetaryValue objects",
"properties": {
"currency": {
"description": "ISO code of currency",
"enum": [
"AED",
"BRL",
"CHF",
"EUR",
"GBP",
"JPY",
"KRW",
"UAH",
"USD",
"ZAR"
],
"type": "string"
},
"details": {
"description": "Optional user notes",
"type": [
"string",
"null"
]
},
"value": {
"description": "Amount of value",
"type": "number"
}
},
"required": [
"currency",
"value"
],
"type": "object"
}
],
"description": "Optional, Contains MonetaryValue objects"
},
"stage": {
"description": "Current stage of class ValueTracker",
"enum": [
"ideation",
"queued",
"dataPrepAndModeling",
"validatingAndDeploying",
"inProduction",
"retired",
"onHold"
],
"type": "string"
},
"targetDates": {
"description": "Array of TargetDate objects",
"items": {
"properties": {
"date": {
"description": "Date of the target",
"format": "date-time",
"type": "string"
},
"stage": {
"description": "Name of the target stage",
"enum": [
"ideation",
"queued",
"dataPrepAndModeling",
"validatingAndDeploying",
"inProduction",
"retired",
"onHold"
],
"type": "string"
}
},
"required": [
"date",
"stage"
],
"type": "object"
},
"type": "array"
}
},
"required": [
"name"
],
"type": "object"
}
Parameters
| Name |
In |
Type |
Required |
Description |
| body |
body |
ValueTracker |
false |
none |
Example responses
200 Response
{
"description": "class ValueTracker information",
"properties": {
"accuracyHealth": {
"anyOf": [
{
"type": "string"
},
{
"properties": {
"endDate": {
"description": "The end date for this health status",
"format": "date-time",
"type": [
"string",
"null"
]
},
"message": {
"description": "Information about the health status",
"type": [
"string",
"null"
]
},
"startDate": {
"description": "The start date for this health status",
"format": "date-time",
"type": [
"string",
"null"
]
},
"status": {
"description": "The status of the class ValueTracker",
"type": [
"string",
"null"
]
}
},
"required": [
"endDate",
"message",
"startDate",
"status"
],
"type": "object"
}
],
"description": "The health of the accuracy"
},
"businessImpact": {
"description": "Expected effects on overall business operations",
"maximum": 5,
"minimum": 1,
"type": [
"integer",
"null"
]
},
"commentId": {
"description": "The id for this comment",
"type": "string"
},
"content": {
"description": "A string",
"type": "string"
},
"description": {
"description": "class ValueTracker description",
"type": "string"
},
"feasibility": {
"description": "Assessment of how the class ValueTracker can be accomplished across multiple dimensions",
"maximum": 5,
"minimum": 1,
"type": [
"integer",
"null"
]
},
"id": {
"description": "The id of the class ValueTracker",
"type": "string"
},
"inProductionWarning": {
"description": "An optional warning to indicate that deployments are attached to this class ValueTracker.",
"type": [
"string",
"null"
]
},
"mentions": {
"description": "A list of user objects",
"items": {
"description": "DataRobot user information",
"properties": {
"firstName": {
"description": "First name of class ValueTracker owner",
"type": [
"string",
"null"
]
},
"id": {
"description": "The DR user ID",
"type": "string"
},
"lastName": {
"description": "Last of class ValueTracker owner",
"type": [
"string",
"null"
]
},
"username": {
"description": "Username of class ValueTracker owner",
"type": "string"
}
},
"required": [
"id"
],
"type": "object"
},
"type": "array"
},
"modelHealth": {
"anyOf": [
{
"type": "string"
},
{
"properties": {
"endDate": {
"description": "The end date for this health status",
"format": "date-time",
"type": [
"string",
"null"
]
},
"message": {
"description": "Information about the health status",
"type": [
"string",
"null"
]
},
"startDate": {
"description": "The start date for this health status",
"format": "date-time",
"type": [
"string",
"null"
]
},
"status": {
"description": "The status of the class ValueTracker",
"type": [
"string",
"null"
]
}
},
"required": [
"endDate",
"message",
"startDate",
"status"
],
"type": "object"
}
],
"description": "The health of the model"
},
"name": {
"description": "Name of the class ValueTracker",
"type": "string"
},
"notes": {
"description": "User notes",
"type": [
"string",
"null"
]
},
"owner": {
"description": "DataRobot user information",
"properties": {
"firstName": {
"description": "First name of class ValueTracker owner",
"type": [
"string",
"null"
]
},
"id": {
"description": "The DR user ID",
"type": "string"
},
"lastName": {
"description": "Last of class ValueTracker owner",
"type": [
"string",
"null"
]
},
"username": {
"description": "Username of class ValueTracker owner",
"type": "string"
}
},
"required": [
"id"
],
"type": "object"
},
"permissions": {
"description": "Permissions of current user",
"items": {
"type": "string"
},
"type": "array"
},
"potentialValue": {
"description": "Optional, Contains MonetaryValue objects",
"properties": {
"currency": {
"description": "ISO code of currency",
"enum": [
"AED",
"BRL",
"CHF",
"EUR",
"GBP",
"JPY",
"KRW",
"UAH",
"USD",
"ZAR"
],
"type": "string"
},
"details": {
"description": "Optional user notes",
"type": [
"string",
"null"
]
},
"value": {
"description": "Amount of value",
"type": "number"
}
},
"required": [
"currency",
"value"
],
"type": "object"
},
"potentialValueTemplate": {
"anyOf": [
{
"properties": {
"data": {
"description": "class ValueTracker value data",
"properties": {
"accuracyImprovement": {
"description": "Accuracy improvement",
"type": "number"
},
"decisionsCount": {
"description": "Estimated number of decisions per year",
"type": "integer"
},
"incorrectDecisionCost": {
"description": "Estimated cost of an individual incorrect decision",
"type": "number"
},
"incorrectDecisionsCount": {
"description": "Estimated number of incorrect decisions per year",
"type": "integer"
}
},
"required": [
"accuracyImprovement",
"decisionsCount",
"incorrectDecisionCost",
"incorrectDecisionsCount"
],
"type": "object"
},
"templateType": {
"description": "class ValueTracker value template type",
"enum": [
"classification"
],
"type": "string"
}
},
"required": [
"data",
"templateType"
],
"type": "object"
},
{
"properties": {
"data": {
"description": "class ValueTracker value data",
"properties": {
"accuracyImprovement": {
"description": "Accuracy improvement",
"type": "number"
},
"decisionsCount": {
"description": "Estimated number of decisions per year",
"type": "integer"
},
"targetValue": {
"description": "Target value",
"type": "number"
}
},
"required": [
"accuracyImprovement",
"decisionsCount",
"targetValue"
],
"type": "object"
},
"templateType": {
"description": "class ValueTracker value template type",
"enum": [
"regression"
],
"type": "string"
}
},
"required": [
"data",
"templateType"
],
"type": "object"
}
],
"description": "Optional, Contains Template type and parameter information"
},
"predictionTargets": {
"description": "An array of strings prediction target names",
"items": {
"description": "The name of the prediction target",
"type": "string"
},
"type": "array"
},
"predictionsCount": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"description": "A list of prediction counts.",
"items": {
"type": "integer"
},
"type": "array"
}
],
"description": "Count of the number of predictions made."
},
"realizedValue": {
"anyOf": [
{
"type": "string"
},
{
"description": "Optional, Contains MonetaryValue objects",
"properties": {
"currency": {
"description": "ISO code of currency",
"enum": [
"AED",
"BRL",
"CHF",
"EUR",
"GBP",
"JPY",
"KRW",
"UAH",
"USD",
"ZAR"
],
"type": "string"
},
"details": {
"description": "Optional user notes",
"type": [
"string",
"null"
]
},
"value": {
"description": "Amount of value",
"type": "number"
}
},
"required": [
"currency",
"value"
],
"type": "object"
}
],
"description": "Optional, Contains MonetaryValue objects"
},
"serviceHealth": {
"anyOf": [
{
"type": "string"
},
{
"properties": {
"endDate": {
"description": "The end date for this health status",
"format": "date-time",
"type": [
"string",
"null"
]
},
"message": {
"description": "Information about the health status",
"type": [
"string",
"null"
]
},
"startDate": {
"description": "The start date for this health status",
"format": "date-time",
"type": [
"string",
"null"
]
},
"status": {
"description": "The status of the class ValueTracker",
"type": [
"string",
"null"
]
}
},
"required": [
"endDate",
"message",
"startDate",
"status"
],
"type": "object"
}
],
"description": "The health of the service"
},
"stage": {
"description": "Current stage of class ValueTracker",
"enum": [
"ideation",
"queued",
"dataPrepAndModeling",
"validatingAndDeploying",
"inProduction",
"retired",
"onHold"
],
"type": "string"
},
"targetDates": {
"description": "Array of TargetDate objects",
"items": {
"properties": {
"date": {
"description": "Date of the target",
"format": "date-time",
"type": "string"
},
"stage": {
"description": "Name of the target stage",
"enum": [
"ideation",
"queued",
"dataPrepAndModeling",
"validatingAndDeploying",
"inProduction",
"retired",
"onHold"
],
"type": "string"
}
},
"required": [
"date",
"stage"
],
"type": "object"
},
"type": "array"
}
},
"type": "object"
}
Responses
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
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.
Parameters
| Name |
In |
Type |
Required |
Description |
| valueTrackerId |
path |
string |
true |
The id of the class ValueTracker |
Example responses
200 Response
{
"description": "class ValueTracker information",
"properties": {
"accuracyHealth": {
"anyOf": [
{
"type": "string"
},
{
"properties": {
"endDate": {
"description": "The end date for this health status",
"format": "date-time",
"type": [
"string",
"null"
]
},
"message": {
"description": "Information about the health status",
"type": [
"string",
"null"
]
},
"startDate": {
"description": "The start date for this health status",
"format": "date-time",
"type": [
"string",
"null"
]
},
"status": {
"description": "The status of the class ValueTracker",
"type": [
"string",
"null"
]
}
},
"required": [
"endDate",
"message",
"startDate",
"status"
],
"type": "object"
}
],
"description": "The health of the accuracy"
},
"businessImpact": {
"description": "Expected effects on overall business operations",
"maximum": 5,
"minimum": 1,
"type": [
"integer",
"null"
]
},
"commentId": {
"description": "The id for this comment",
"type": "string"
},
"content": {
"description": "A string",
"type": "string"
},
"description": {
"description": "class ValueTracker description",
"type": [
"string",
"null"
]
},
"feasibility": {
"description": "Assessment of how the class ValueTracker can be accomplished across multiple dimensions",
"maximum": 5,
"minimum": 1,
"type": [
"integer",
"null"
]
},
"id": {
"description": "The id of the class ValueTracker",
"type": "string"
},
"inProductionWarning": {
"description": "An optional warning to indicate that deployments are attached to this class ValueTracker.",
"type": [
"string",
"null"
]
},
"mentions": {
"description": "A list of user objects",
"items": {
"description": "DataRobot user information",
"properties": {
"firstName": {
"description": "First name of class ValueTracker owner",
"type": [
"string",
"null"
]
},
"id": {
"description": "The DR user ID",
"type": "string"
},
"lastName": {
"description": "Last of class ValueTracker owner",
"type": [
"string",
"null"
]
},
"username": {
"description": "Username of class ValueTracker owner",
"type": "string"
}
},
"required": [
"id"
],
"type": "object"
},
"type": "array"
},
"modelHealth": {
"anyOf": [
{
"type": "string"
},
{
"properties": {
"endDate": {
"description": "The end date for this health status",
"format": "date-time",
"type": [
"string",
"null"
]
},
"message": {
"description": "Information about the health status",
"type": [
"string",
"null"
]
},
"startDate": {
"description": "The start date for this health status",
"format": "date-time",
"type": [
"string",
"null"
]
},
"status": {
"description": "The status of the class ValueTracker",
"type": [
"string",
"null"
]
}
},
"required": [
"endDate",
"message",
"startDate",
"status"
],
"type": "object"
}
],
"description": "The health of the model"
},
"name": {
"description": "Name of the class ValueTracker",
"type": "string"
},
"notes": {
"description": "User notes",
"type": [
"string",
"null"
]
},
"owner": {
"description": "DataRobot user information",
"properties": {
"firstName": {
"description": "First name of class ValueTracker owner",
"type": [
"string",
"null"
]
},
"id": {
"description": "The DR user ID",
"type": "string"
},
"lastName": {
"description": "Last of class ValueTracker owner",
"type": [
"string",
"null"
]
},
"username": {
"description": "Username of class ValueTracker owner",
"type": "string"
}
},
"required": [
"id"
],
"type": "object"
},
"permissions": {
"description": "Permissions of current user",
"items": {
"type": "string"
},
"type": "array"
},
"potentialValue": {
"description": "Optional, Contains MonetaryValue objects",
"properties": {
"currency": {
"description": "ISO code of currency",
"enum": [
"AED",
"BRL",
"CHF",
"EUR",
"GBP",
"JPY",
"KRW",
"UAH",
"USD",
"ZAR"
],
"type": "string"
},
"details": {
"description": "Optional user notes",
"type": [
"string",
"null"
]
},
"value": {
"description": "Amount of value",
"type": "number"
}
},
"required": [
"currency",
"value"
],
"type": "object"
},
"potentialValueTemplate": {
"anyOf": [
{
"properties": {
"data": {
"description": "class ValueTracker value data",
"properties": {
"accuracyImprovement": {
"description": "Accuracy improvement",
"type": "number"
},
"decisionsCount": {
"description": "Estimated number of decisions per year",
"type": "integer"
},
"incorrectDecisionCost": {
"description": "Estimated cost of an individual incorrect decision",
"type": "number"
},
"incorrectDecisionsCount": {
"description": "Estimated number of incorrect decisions per year",
"type": "integer"
}
},
"required": [
"accuracyImprovement",
"decisionsCount",
"incorrectDecisionCost",
"incorrectDecisionsCount"
],
"type": "object"
},
"templateType": {
"description": "class ValueTracker value template type",
"enum": [
"classification"
],
"type": "string"
}
},
"required": [
"data",
"templateType"
],
"type": "object"
},
{
"properties": {
"data": {
"description": "class ValueTracker value data",
"properties": {
"accuracyImprovement": {
"description": "Accuracy improvement",
"type": "number"
},
"decisionsCount": {
"description": "Estimated number of decisions per year",
"type": "integer"
},
"targetValue": {
"description": "Target value",
"type": "number"
}
},
"required": [
"accuracyImprovement",
"decisionsCount",
"targetValue"
],
"type": "object"
},
"templateType": {
"description": "class ValueTracker value template type",
"enum": [
"regression"
],
"type": "string"
}
},
"required": [
"data",
"templateType"
],
"type": "object"
}
],
"description": "Optional, Contains Template type and parameter information"
},
"predictionTargets": {
"description": "An array of strings prediction target names",
"items": {
"description": "The name of the prediction target",
"type": "string"
},
"type": "array"
},
"predictionsCount": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"description": "A list of prediction counts.",
"items": {
"type": "integer"
},
"type": "array"
}
],
"description": "Count of the number of predictions made."
},
"realizedValue": {
"anyOf": [
{
"type": "string"
},
{
"description": "Optional, Contains MonetaryValue objects",
"properties": {
"currency": {
"description": "ISO code of currency",
"enum": [
"AED",
"BRL",
"CHF",
"EUR",
"GBP",
"JPY",
"KRW",
"UAH",
"USD",
"ZAR"
],
"type": "string"
},
"details": {
"description": "Optional user notes",
"type": [
"string",
"null"
]
},
"value": {
"description": "Amount of value",
"type": "number"
}
},
"required": [
"currency",
"value"
],
"type": "object"
}
],
"description": "Optional, Contains MonetaryValue objects"
},
"serviceHealth": {
"anyOf": [
{
"type": "string"
},
{
"properties": {
"endDate": {
"description": "The end date for this health status",
"format": "date-time",
"type": [
"string",
"null"
]
},
"message": {
"description": "Information about the health status",
"type": [
"string",
"null"
]
},
"startDate": {
"description": "The start date for this health status",
"format": "date-time",
"type": [
"string",
"null"
]
},
"status": {
"description": "The status of the class ValueTracker",
"type": [
"string",
"null"
]
}
},
"required": [
"endDate",
"message",
"startDate",
"status"
],
"type": "object"
}
],
"description": "The health of the service"
},
"stage": {
"description": "Current stage of class ValueTracker",
"enum": [
"ideation",
"queued",
"dataPrepAndModeling",
"validatingAndDeploying",
"inProduction",
"retired",
"onHold"
],
"type": "string"
},
"targetDates": {
"description": "Array of TargetDate objects",
"items": {
"properties": {
"date": {
"description": "Date of the target",
"format": "date-time",
"type": "string"
},
"stage": {
"description": "Name of the target stage",
"enum": [
"ideation",
"queued",
"dataPrepAndModeling",
"validatingAndDeploying",
"inProduction",
"retired",
"onHold"
],
"type": "string"
}
},
"required": [
"date",
"stage"
],
"type": "object"
},
"type": "array"
}
},
"type": "object"
}
Responses
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.
Body parameter
{
"properties": {
"businessImpact": {
"description": "Expected effects on overall business operations",
"maximum": 5,
"minimum": 1,
"type": [
"integer",
"null"
]
},
"description": {
"description": "class ValueTracker description",
"maxLength": 1024,
"type": [
"string",
"null"
]
},
"feasibility": {
"description": "Assessment of how the class ValueTracker can be accomplished across multiple dimensions",
"maximum": 5,
"minimum": 1,
"type": [
"integer",
"null"
]
},
"name": {
"description": "Name of the class ValueTracker",
"maxLength": 512,
"type": "string"
},
"notes": {
"description": "User notes",
"maxLength": 1024,
"type": [
"string",
"null"
]
},
"owner": {
"description": "DataRobot user information",
"properties": {
"firstName": {
"description": "First name of class ValueTracker owner",
"type": [
"string",
"null"
]
},
"id": {
"description": "The DR user ID",
"type": "string"
},
"lastName": {
"description": "Last of class ValueTracker owner",
"type": [
"string",
"null"
]
},
"username": {
"description": "Username of class ValueTracker owner",
"type": "string"
}
},
"required": [
"id"
],
"type": "object"
},
"potentialValue": {
"description": "Optional, Contains MonetaryValue objects",
"properties": {
"currency": {
"description": "ISO code of currency",
"enum": [
"AED",
"BRL",
"CHF",
"EUR",
"GBP",
"JPY",
"KRW",
"UAH",
"USD",
"ZAR"
],
"type": "string"
},
"details": {
"description": "Optional user notes",
"type": [
"string",
"null"
]
},
"value": {
"description": "Amount of value",
"type": "number"
}
},
"required": [
"currency",
"value"
],
"type": "object"
},
"potentialValueTemplate": {
"anyOf": [
{
"properties": {
"data": {
"description": "class ValueTracker value data",
"properties": {
"accuracyImprovement": {
"description": "Accuracy improvement",
"type": "number"
},
"decisionsCount": {
"description": "Estimated number of decisions per year",
"type": "integer"
},
"incorrectDecisionCost": {
"description": "Estimated cost of an individual incorrect decision",
"type": "number"
},
"incorrectDecisionsCount": {
"description": "Estimated number of incorrect decisions per year",
"type": "integer"
}
},
"required": [
"accuracyImprovement",
"decisionsCount",
"incorrectDecisionCost",
"incorrectDecisionsCount"
],
"type": "object"
},
"templateType": {
"description": "class ValueTracker value template type",
"enum": [
"classification"
],
"type": "string"
}
},
"required": [
"data",
"templateType"
],
"type": "object"
},
{
"properties": {
"data": {
"description": "class ValueTracker value data",
"properties": {
"accuracyImprovement": {
"description": "Accuracy improvement",
"type": "number"
},
"decisionsCount": {
"description": "Estimated number of decisions per year",
"type": "integer"
},
"targetValue": {
"description": "Target value",
"type": "number"
}
},
"required": [
"accuracyImprovement",
"decisionsCount",
"targetValue"
],
"type": "object"
},
"templateType": {
"description": "class ValueTracker value template type",
"enum": [
"regression"
],
"type": "string"
}
},
"required": [
"data",
"templateType"
],
"type": "object"
}
],
"description": "Contains Template type and parameter information defined in the response of [GET /api/v2/valueTrackerValueTemplates/{templateType}/calculation/][get-apiv2valuetrackervaluetemplatestemplatetypecalculation]"
},
"predictionTargets": {
"description": "An array of strings prediction target names",
"items": {
"type": "string"
},
"type": "array"
},
"realizedValue": {
"description": "Optional, Contains MonetaryValue objects",
"properties": {
"currency": {
"description": "ISO code of currency",
"enum": [
"AED",
"BRL",
"CHF",
"EUR",
"GBP",
"JPY",
"KRW",
"UAH",
"USD",
"ZAR"
],
"type": "string"
},
"details": {
"description": "Optional user notes",
"type": [
"string",
"null"
]
},
"value": {
"description": "Amount of value",
"type": "number"
}
},
"required": [
"currency",
"value"
],
"type": "object"
},
"stage": {
"description": "Current stage of class ValueTracker",
"enum": [
"ideation",
"queued",
"dataPrepAndModeling",
"validatingAndDeploying",
"inProduction",
"retired",
"onHold"
],
"type": "string"
},
"targetDates": {
"description": "Array of TargetDate objects",
"items": {
"properties": {
"date": {
"description": "Date of the target",
"format": "date-time",
"type": "string"
},
"stage": {
"description": "Name of the target stage",
"enum": [
"ideation",
"queued",
"dataPrepAndModeling",
"validatingAndDeploying",
"inProduction",
"retired",
"onHold"
],
"type": "string"
}
},
"required": [
"date",
"stage"
],
"type": "object"
},
"type": "array"
}
},
"type": "object"
}
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
{
"description": "class ValueTracker information",
"properties": {
"accuracyHealth": {
"anyOf": [
{
"type": "string"
},
{
"properties": {
"endDate": {
"description": "The end date for this health status",
"format": "date-time",
"type": [
"string",
"null"
]
},
"message": {
"description": "Information about the health status",
"type": [
"string",
"null"
]
},
"startDate": {
"description": "The start date for this health status",
"format": "date-time",
"type": [
"string",
"null"
]
},
"status": {
"description": "The status of the class ValueTracker",
"type": [
"string",
"null"
]
}
},
"required": [
"endDate",
"message",
"startDate",
"status"
],
"type": "object"
}
],
"description": "The health of the accuracy"
},
"businessImpact": {
"description": "Expected effects on overall business operations",
"maximum": 5,
"minimum": 1,
"type": [
"integer",
"null"
]
},
"commentId": {
"description": "The id for this comment",
"type": "string"
},
"content": {
"description": "A string",
"type": "string"
},
"description": {
"description": "class ValueTracker description",
"type": [
"string",
"null"
]
},
"feasibility": {
"description": "Assessment of how the class ValueTracker can be accomplished across multiple dimensions",
"maximum": 5,
"minimum": 1,
"type": [
"integer",
"null"
]
},
"id": {
"description": "The id of the class ValueTracker",
"type": "string"
},
"inProductionWarning": {
"description": "An optional warning to indicate that deployments are attached to this class ValueTracker.",
"type": [
"string",
"null"
]
},
"mentions": {
"description": "A list of user objects",
"items": {
"description": "DataRobot user information",
"properties": {
"firstName": {
"description": "First name of class ValueTracker owner",
"type": [
"string",
"null"
]
},
"id": {
"description": "The DR user ID",
"type": "string"
},
"lastName": {
"description": "Last of class ValueTracker owner",
"type": [
"string",
"null"
]
},
"username": {
"description": "Username of class ValueTracker owner",
"type": "string"
}
},
"required": [
"id"
],
"type": "object"
},
"type": "array"
},
"modelHealth": {
"anyOf": [
{
"type": "string"
},
{
"properties": {
"endDate": {
"description": "The end date for this health status",
"format": "date-time",
"type": [
"string",
"null"
]
},
"message": {
"description": "Information about the health status",
"type": [
"string",
"null"
]
},
"startDate": {
"description": "The start date for this health status",
"format": "date-time",
"type": [
"string",
"null"
]
},
"status": {
"description": "The status of the class ValueTracker",
"type": [
"string",
"null"
]
}
},
"required": [
"endDate",
"message",
"startDate",
"status"
],
"type": "object"
}
],
"description": "The health of the model"
},
"name": {
"description": "Name of the class ValueTracker",
"type": "string"
},
"notes": {
"description": "User notes",
"type": [
"string",
"null"
]
},
"owner": {
"description": "DataRobot user information",
"properties": {
"firstName": {
"description": "First name of class ValueTracker owner",
"type": [
"string",
"null"
]
},
"id": {
"description": "The DR user ID",
"type": "string"
},
"lastName": {
"description": "Last of class ValueTracker owner",
"type": [
"string",
"null"
]
},
"username": {
"description": "Username of class ValueTracker owner",
"type": "string"
}
},
"required": [
"id"
],
"type": "object"
},
"permissions": {
"description": "Permissions of current user",
"items": {
"type": "string"
},
"type": "array"
},
"potentialValue": {
"description": "Optional, Contains MonetaryValue objects",
"properties": {
"currency": {
"description": "ISO code of currency",
"enum": [
"AED",
"BRL",
"CHF",
"EUR",
"GBP",
"JPY",
"KRW",
"UAH",
"USD",
"ZAR"
],
"type": "string"
},
"details": {
"description": "Optional user notes",
"type": [
"string",
"null"
]
},
"value": {
"description": "Amount of value",
"type": "number"
}
},
"required": [
"currency",
"value"
],
"type": "object"
},
"potentialValueTemplate": {
"anyOf": [
{
"properties": {
"data": {
"description": "class ValueTracker value data",
"properties": {
"accuracyImprovement": {
"description": "Accuracy improvement",
"type": "number"
},
"decisionsCount": {
"description": "Estimated number of decisions per year",
"type": "integer"
},
"incorrectDecisionCost": {
"description": "Estimated cost of an individual incorrect decision",
"type": "number"
},
"incorrectDecisionsCount": {
"description": "Estimated number of incorrect decisions per year",
"type": "integer"
}
},
"required": [
"accuracyImprovement",
"decisionsCount",
"incorrectDecisionCost",
"incorrectDecisionsCount"
],
"type": "object"
},
"templateType": {
"description": "class ValueTracker value template type",
"enum": [
"classification"
],
"type": "string"
}
},
"required": [
"data",
"templateType"
],
"type": "object"
},
{
"properties": {
"data": {
"description": "class ValueTracker value data",
"properties": {
"accuracyImprovement": {
"description": "Accuracy improvement",
"type": "number"
},
"decisionsCount": {
"description": "Estimated number of decisions per year",
"type": "integer"
},
"targetValue": {
"description": "Target value",
"type": "number"
}
},
"required": [
"accuracyImprovement",
"decisionsCount",
"targetValue"
],
"type": "object"
},
"templateType": {
"description": "class ValueTracker value template type",
"enum": [
"regression"
],
"type": "string"
}
},
"required": [
"data",
"templateType"
],
"type": "object"
}
],
"description": "Optional, Contains Template type and parameter information"
},
"predictionTargets": {
"description": "An array of strings prediction target names",
"items": {
"description": "The name of the prediction target",
"type": "string"
},
"type": "array"
},
"predictionsCount": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"description": "A list of prediction counts.",
"items": {
"type": "integer"
},
"type": "array"
}
],
"description": "Count of the number of predictions made."
},
"realizedValue": {
"anyOf": [
{
"type": "string"
},
{
"description": "Optional, Contains MonetaryValue objects",
"properties": {
"currency": {
"description": "ISO code of currency",
"enum": [
"AED",
"BRL",
"CHF",
"EUR",
"GBP",
"JPY",
"KRW",
"UAH",
"USD",
"ZAR"
],
"type": "string"
},
"details": {
"description": "Optional user notes",
"type": [
"string",
"null"
]
},
"value": {
"description": "Amount of value",
"type": "number"
}
},
"required": [
"currency",
"value"
],
"type": "object"
}
],
"description": "Optional, Contains MonetaryValue objects"
},
"serviceHealth": {
"anyOf": [
{
"type": "string"
},
{
"properties": {
"endDate": {
"description": "The end date for this health status",
"format": "date-time",
"type": [
"string",
"null"
]
},
"message": {
"description": "Information about the health status",
"type": [
"string",
"null"
]
},
"startDate": {
"description": "The start date for this health status",
"format": "date-time",
"type": [
"string",
"null"
]
},
"status": {
"description": "The status of the class ValueTracker",
"type": [
"string",
"null"
]
}
},
"required": [
"endDate",
"message",
"startDate",
"status"
],
"type": "object"
}
],
"description": "The health of the service"
},
"stage": {
"description": "Current stage of class ValueTracker",
"enum": [
"ideation",
"queued",
"dataPrepAndModeling",
"validatingAndDeploying",
"inProduction",
"retired",
"onHold"
],
"type": "string"
},
"targetDates": {
"description": "Array of TargetDate objects",
"items": {
"properties": {
"date": {
"description": "Date of the target",
"format": "date-time",
"type": "string"
},
"stage": {
"description": "Name of the target stage",
"enum": [
"ideation",
"queued",
"dataPrepAndModeling",
"validatingAndDeploying",
"inProduction",
"retired",
"onHold"
],
"type": "string"
}
},
"required": [
"date",
"stage"
],
"type": "object"
},
"type": "array"
}
},
"type": "object"
}
Responses
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.
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
{
"properties": {
"count": {
"description": "The number of items returned on this page",
"type": "integer"
},
"data": {
"description": "The activities of a class ValueTracker",
"items": {
"description": "DataRobot user information",
"properties": {
"eventDescription": {
"description": "Details of the activity, content depends on activity type",
"properties": {
"businessImpact": {
"description": "Expected effects on overall business operations",
"maximum": 5,
"minimum": 1,
"type": [
"integer",
"null"
]
},
"commentId": {
"description": "The id for this comment",
"type": "string"
},
"content": {
"description": "A string",
"type": "string"
},
"description": {
"description": "class ValueTracker description",
"type": [
"string",
"null"
]
},
"feasibility": {
"description": "Assessment of how the class ValueTracker can be accomplished across multiple dimensions",
"maximum": 5,
"minimum": 1,
"type": [
"integer",
"null"
]
},
"id": {
"description": "The id of this description item",
"type": [
"string",
"null"
]
},
"mentions": {
"description": "A list of user objects",
"items": {
"description": "DataRobot user information",
"properties": {
"firstName": {
"description": "First name of class ValueTracker owner",
"type": [
"string",
"null"
]
},
"id": {
"description": "The DR user ID",
"type": "string"
},
"lastName": {
"description": "Last of class ValueTracker owner",
"type": [
"string",
"null"
]
},
"username": {
"description": "Username of class ValueTracker owner",
"type": "string"
}
},
"required": [
"id"
],
"type": "object"
},
"type": "array"
},
"name": {
"description": "The name of this event item",
"type": [
"string",
"null"
]
},
"notes": {
"description": "User notes",
"type": [
"string",
"null"
]
},
"owner": {
"description": "DataRobot user information",
"properties": {
"firstName": {
"description": "First name of class ValueTracker owner",
"type": [
"string",
"null"
]
},
"id": {
"description": "The DR user ID",
"type": "string"
},
"lastName": {
"description": "Last of class ValueTracker owner",
"type": [
"string",
"null"
]
},
"username": {
"description": "Username of class ValueTracker owner",
"type": "string"
}
},
"required": [
"id"
],
"type": "object"
},
"permissions": {
"description": "Permissions of current user",
"items": {
"type": "string"
},
"type": "array"
},
"potentialValue": {
"description": "Optional, Contains MonetaryValue objects",
"properties": {
"currency": {
"description": "ISO code of currency",
"enum": [
"AED",
"BRL",
"CHF",
"EUR",
"GBP",
"JPY",
"KRW",
"UAH",
"USD",
"ZAR"
],
"type": "string"
},
"details": {
"description": "Optional user notes",
"type": [
"string",
"null"
]
},
"value": {
"description": "Amount of value",
"type": "number"
}
},
"required": [
"currency",
"value"
],
"type": "object"
},
"potentialValueTemplate": {
"anyOf": [
{
"properties": {
"data": {
"description": "class ValueTracker value data",
"properties": {
"accuracyImprovement": {
"description": "Accuracy improvement",
"type": "number"
},
"decisionsCount": {
"description": "Estimated number of decisions per year",
"type": "integer"
},
"incorrectDecisionCost": {
"description": "Estimated cost of an individual incorrect decision",
"type": "number"
},
"incorrectDecisionsCount": {
"description": "Estimated number of incorrect decisions per year",
"type": "integer"
}
},
"required": [
"accuracyImprovement",
"decisionsCount",
"incorrectDecisionCost",
"incorrectDecisionsCount"
],
"type": "object"
},
"templateType": {
"description": "class ValueTracker value template type",
"enum": [
"classification"
],
"type": "string"
}
},
"required": [
"data",
"templateType"
],
"type": "object"
},
{
"properties": {
"data": {
"description": "class ValueTracker value data",
"properties": {
"accuracyImprovement": {
"description": "Accuracy improvement",
"type": "number"
},
"decisionsCount": {
"description": "Estimated number of decisions per year",
"type": "integer"
},
"targetValue": {
"description": "Target value",
"type": "number"
}
},
"required": [
"accuracyImprovement",
"decisionsCount",
"targetValue"
],
"type": "object"
},
"templateType": {
"description": "class ValueTracker value template type",
"enum": [
"regression"
],
"type": "string"
}
},
"required": [
"data",
"templateType"
],
"type": "object"
}
],
"description": "Optional, Contains Template type and parameter information"
},
"predictionTargets": {
"description": "An array of strings prediction target names",
"items": {
"description": "The name of the prediction target",
"type": "string"
},
"type": "array"
},
"realizedValue": {
"anyOf": [
{
"type": "string"
},
{
"description": "Optional, Contains MonetaryValue objects",
"properties": {
"currency": {
"description": "ISO code of currency",
"enum": [
"AED",
"BRL",
"CHF",
"EUR",
"GBP",
"JPY",
"KRW",
"UAH",
"USD",
"ZAR"
],
"type": "string"
},
"details": {
"description": "Optional user notes",
"type": [
"string",
"null"
]
},
"value": {
"description": "Amount of value",
"type": "number"
}
},
"required": [
"currency",
"value"
],
"type": "object"
}
],
"description": "Optional, Contains MonetaryValue objects"
},
"stage": {
"description": "Current stage of class ValueTracker",
"enum": [
"ideation",
"queued",
"dataPrepAndModeling",
"validatingAndDeploying",
"inProduction",
"retired",
"onHold"
],
"type": "string"
},
"targetDates": {
"description": "Array of TargetDate objects",
"items": {
"properties": {
"date": {
"description": "Date of the target",
"format": "date-time",
"type": "string"
},
"stage": {
"description": "Name of the target stage",
"enum": [
"ideation",
"queued",
"dataPrepAndModeling",
"validatingAndDeploying",
"inProduction",
"retired",
"onHold"
],
"type": "string"
}
},
"required": [
"date",
"stage"
],
"type": "object"
},
"type": "array"
}
},
"type": "object"
},
"eventType": {
"description": "The type of activity",
"type": [
"string",
"null"
]
},
"firstName": {
"description": "First name of class ValueTracker owner",
"type": [
"string",
"null"
]
},
"id": {
"description": "The id of the class ValueTracker activity",
"type": "string"
},
"lastName": {
"description": "Last of class ValueTracker owner",
"type": [
"string",
"null"
]
},
"timestamp": {
"description": "The timestamp of the activity",
"format": "date-time",
"type": "string"
},
"user": {
"description": "DataRobot user information",
"properties": {
"firstName": {
"description": "First name of class ValueTracker owner",
"type": [
"string",
"null"
]
},
"id": {
"description": "The DR user ID",
"type": "string"
},
"lastName": {
"description": "Last of class ValueTracker owner",
"type": [
"string",
"null"
]
},
"username": {
"description": "Username of class ValueTracker owner",
"type": "string"
}
},
"required": [
"id"
],
"type": "object"
},
"username": {
"description": "Username of class ValueTracker owner",
"type": "string"
}
},
"required": [
"eventDescription",
"eventType",
"timestamp",
"user"
],
"type": "object"
},
"type": "array"
},
"next": {
"description": "URL pointing to the next page (if null, there is no next page)",
"format": "uri",
"type": [
"string",
"null"
]
},
"previous": {
"description": "URL pointing to the previous page (if null, there is no previous page)",
"format": "uri",
"type": [
"string",
"null"
]
},
"totalCount": {
"description": "The number of items matching the query condition",
"type": "integer"
}
},
"required": [
"count",
"data",
"next",
"previous",
"totalCount"
],
"type": "object"
}
Responses
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.
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
{
"properties": {
"count": {
"description": "Number of results returned",
"type": "integer"
},
"data": {
"description": "An array of attachment objects",
"items": {
"properties": {
"attachedObjectId": {
"description": "The id of the attached object",
"type": "string"
},
"canView": {
"description": "Indicates if user has view access to the attached object",
"type": "boolean"
},
"id": {
"description": "The id of the class ValueTracker",
"type": "string"
},
"isAccessRequested": {
"description": "Indicates if user has requested access to the attached object",
"type": "boolean"
},
"overview": {
"description": "Detailed information depending on the type of the attachment",
"oneOf": [
{
"properties": {
"accuracyHealth": {
"description": "Accuracy related health status",
"properties": {
"endDate": {
"description": "End date of health status",
"format": "date-time",
"type": "string"
},
"message": {
"description": "Health status related information",
"type": "string"
},
"startDate": {
"description": "Start date of health status",
"format": "date-time",
"type": "string"
},
"status": {
"description": "Health status",
"type": "string"
}
},
"required": [
"endDate",
"message",
"startDate",
"status"
],
"type": "object"
},
"modelHealth": {
"description": "Accuracy related health status",
"properties": {
"endDate": {
"description": "End date of health status",
"format": "date-time",
"type": "string"
},
"message": {
"description": "Health status related information",
"type": "string"
},
"startDate": {
"description": "Start date of health status",
"format": "date-time",
"type": "string"
},
"status": {
"description": "Health status",
"type": "string"
}
},
"required": [
"endDate",
"message",
"startDate",
"status"
],
"type": "object"
},
"name": {
"description": "Name of the deployment",
"type": "string"
},
"predictionServer": {
"description": "Name of prediction server",
"type": "string"
},
"predictionUsage": {
"description": "class ValueTracker attachment detail for Deployment usage",
"properties": {
"dailyRates": {
"description": "List of daily request counts",
"items": {
"type": "integer"
},
"type": "array"
},
"lastTimestamp": {
"description": "Last prediction time",
"format": "date-time",
"type": "string"
}
},
"required": [
"dailyRates",
"lastTimestamp"
],
"type": "object"
},
"serviceHealth": {
"description": "Accuracy related health status",
"properties": {
"endDate": {
"description": "End date of health status",
"format": "date-time",
"type": "string"
},
"message": {
"description": "Health status related information",
"type": "string"
},
"startDate": {
"description": "Start date of health status",
"format": "date-time",
"type": "string"
},
"status": {
"description": "Health status",
"type": "string"
}
},
"required": [
"endDate",
"message",
"startDate",
"status"
],
"type": "object"
}
},
"required": [
"accuracyHealth",
"modelHealth",
"name",
"predictionServer",
"predictionUsage",
"serviceHealth"
],
"type": "object"
},
{
"properties": {
"createdAt": {
"description": "Time when dataset was created",
"format": "date-time",
"type": "string"
},
"createdBy": {
"description": "Name of user who created the dataset",
"type": "string"
},
"lastModifiedAt": {
"description": "Time of the last modification",
"format": "date-time",
"type": "string"
},
"lastModifiedBy": {
"description": "Name of user who did last modification",
"type": "string"
},
"name": {
"description": "Name of the dataset",
"type": "string"
}
},
"required": [
"createdAt",
"createdBy",
"lastModifiedAt",
"lastModifiedBy",
"name"
],
"type": "object"
},
{
"properties": {
"createdAt": {
"description": "Time when project was created",
"format": "date-time",
"type": "string"
},
"datasetName": {
"description": "Name of default dataset",
"type": "string"
},
"name": {
"description": "Name of the project",
"type": "string"
},
"numberOfModels": {
"description": "Number of the models in the project",
"type": [
"integer",
"null"
]
},
"owner": {
"description": "Name of the modeling project owner",
"type": [
"string",
"null"
]
},
"targetName": {
"description": "Name of modeling target",
"type": "string"
},
"useCase": {
"description": "Information about the Use Case that this modeling project is attached to",
"properties": {
"id": {
"description": "ID of the Use Case this modeling project is attached to",
"type": "string"
},
"name": {
"description": "Name of the Use Case this modeling project is attached to",
"type": "string"
}
},
"required": [
"id",
"name"
],
"type": "object"
}
},
"required": [
"createdAt",
"datasetName",
"name",
"numberOfModels",
"owner",
"targetName"
],
"type": "object"
},
{
"properties": {
"createdAt": {
"description": "Time when custom model was created",
"format": "date-time",
"type": "string"
},
"modifiedAt": {
"description": "Time of the last modification",
"format": "date-time",
"type": "string"
},
"name": {
"description": "Name of the custom model",
"type": "string"
},
"owner": {
"description": "Name of the custom model owner",
"type": "string"
}
},
"required": [
"createdAt",
"modifiedAt",
"name",
"owner"
],
"type": "object"
},
{
"properties": {
"createdAt": {
"description": "Time when model package was created",
"format": "date-time",
"type": "string"
},
"deploymentCount": {
"description": "Number of deployments",
"type": "integer"
},
"executionType": {
"description": "Type of execution",
"type": "string"
},
"name": {
"description": "Name of the model package",
"type": "string"
},
"targetName": {
"description": "Name of modeling target",
"type": "string"
},
"targetType": {
"description": "Type of modeling target",
"type": "string"
}
},
"required": [
"createdAt",
"deploymentCount",
"executionType",
"name",
"targetName",
"targetType"
],
"type": "object"
},
{
"properties": {
"appType": {
"description": "Type of the application",
"type": "string"
},
"createdAt": {
"description": "Time when application was created",
"format": "date-time",
"type": "string"
},
"lastModifiedAt": {
"description": "Time of the last modification",
"format": "date-time",
"type": "string"
},
"name": {
"description": "Name of the application",
"type": "string"
},
"version": {
"description": "Version string of the app",
"type": "string"
}
},
"required": [
"appType",
"createdAt",
"lastModifiedAt",
"name",
"version"
],
"type": "object"
}
]
},
"type": {
"description": "class ValueTracker attachment type",
"enum": [
"dataset",
"modelingProject",
"deployment",
"customModel",
"modelPackage",
"application"
],
"type": "string"
},
"useCaseId": {
"description": "The id of the class ValueTracker",
"type": "string"
}
},
"required": [
"attachedObjectId",
"canView",
"id",
"isAccessRequested",
"overview",
"type",
"useCaseId"
],
"type": "object"
},
"type": "array"
},
"next": {
"description": "Link to next page",
"type": [
"string",
"null"
]
},
"previous": {
"description": "Link to previous page",
"type": [
"string",
"null"
]
},
"totalCount": {
"description": "Total number of results available",
"type": "integer"
}
},
"required": [
"count",
"data",
"next",
"previous",
"totalCount"
],
"type": "object"
}
Responses
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.
Body parameter
{
"properties": {
"attachedObjects": {
"description": "An array of attachment objects",
"items": {
"properties": {
"attachedObjectId": {
"description": "The id of the attached object",
"type": "string"
},
"type": {
"description": "class ValueTracker attachment type",
"enum": [
"dataset",
"modelingProject",
"deployment",
"customModel",
"modelPackage",
"application"
],
"type": "string"
}
},
"required": [
"attachedObjectId",
"type"
],
"type": "object"
},
"type": "array"
}
},
"required": [
"attachedObjects"
],
"type": "object"
}
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
{
"items": {
"properties": {
"attachedObjectId": {
"description": "The id of the attached object",
"type": "string"
},
"type": {
"description": "class ValueTracker attachment type",
"enum": [
"dataset",
"modelingProject",
"deployment",
"customModel",
"modelPackage",
"application"
],
"type": "string"
}
},
"required": [
"attachedObjectId",
"type"
],
"type": "object"
},
"type": "array"
}
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.
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.
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
{
"properties": {
"attachedObjectId": {
"description": "The id of the attached object",
"type": "string"
},
"canView": {
"description": "Indicates if user has view access to the attached object",
"type": "boolean"
},
"id": {
"description": "The id of the class ValueTracker",
"type": "string"
},
"isAccessRequested": {
"description": "Indicates if user has requested access to the attached object",
"type": "boolean"
},
"overview": {
"description": "Detailed information depending on the type of the attachment",
"oneOf": [
{
"properties": {
"accuracyHealth": {
"description": "Accuracy related health status",
"properties": {
"endDate": {
"description": "End date of health status",
"format": "date-time",
"type": "string"
},
"message": {
"description": "Health status related information",
"type": "string"
},
"startDate": {
"description": "Start date of health status",
"format": "date-time",
"type": "string"
},
"status": {
"description": "Health status",
"type": "string"
}
},
"required": [
"endDate",
"message",
"startDate",
"status"
],
"type": "object"
},
"modelHealth": {
"description": "Accuracy related health status",
"properties": {
"endDate": {
"description": "End date of health status",
"format": "date-time",
"type": "string"
},
"message": {
"description": "Health status related information",
"type": "string"
},
"startDate": {
"description": "Start date of health status",
"format": "date-time",
"type": "string"
},
"status": {
"description": "Health status",
"type": "string"
}
},
"required": [
"endDate",
"message",
"startDate",
"status"
],
"type": "object"
},
"name": {
"description": "Name of the deployment",
"type": "string"
},
"predictionServer": {
"description": "Name of prediction server",
"type": "string"
},
"predictionUsage": {
"description": "class ValueTracker attachment detail for Deployment usage",
"properties": {
"dailyRates": {
"description": "List of daily request counts",
"items": {
"type": "integer"
},
"type": "array"
},
"lastTimestamp": {
"description": "Last prediction time",
"format": "date-time",
"type": "string"
}
},
"required": [
"dailyRates",
"lastTimestamp"
],
"type": "object"
},
"serviceHealth": {
"description": "Accuracy related health status",
"properties": {
"endDate": {
"description": "End date of health status",
"format": "date-time",
"type": "string"
},
"message": {
"description": "Health status related information",
"type": "string"
},
"startDate": {
"description": "Start date of health status",
"format": "date-time",
"type": "string"
},
"status": {
"description": "Health status",
"type": "string"
}
},
"required": [
"endDate",
"message",
"startDate",
"status"
],
"type": "object"
}
},
"required": [
"accuracyHealth",
"modelHealth",
"name",
"predictionServer",
"predictionUsage",
"serviceHealth"
],
"type": "object"
},
{
"properties": {
"createdAt": {
"description": "Time when dataset was created",
"format": "date-time",
"type": "string"
},
"createdBy": {
"description": "Name of user who created the dataset",
"type": "string"
},
"lastModifiedAt": {
"description": "Time of the last modification",
"format": "date-time",
"type": "string"
},
"lastModifiedBy": {
"description": "Name of user who did last modification",
"type": "string"
},
"name": {
"description": "Name of the dataset",
"type": "string"
}
},
"required": [
"createdAt",
"createdBy",
"lastModifiedAt",
"lastModifiedBy",
"name"
],
"type": "object"
},
{
"properties": {
"createdAt": {
"description": "Time when project was created",
"format": "date-time",
"type": "string"
},
"datasetName": {
"description": "Name of default dataset",
"type": "string"
},
"name": {
"description": "Name of the project",
"type": "string"
},
"numberOfModels": {
"description": "Number of the models in the project",
"type": [
"integer",
"null"
]
},
"owner": {
"description": "Name of the modeling project owner",
"type": [
"string",
"null"
]
},
"targetName": {
"description": "Name of modeling target",
"type": "string"
},
"useCase": {
"description": "Information about the Use Case that this modeling project is attached to",
"properties": {
"id": {
"description": "ID of the Use Case this modeling project is attached to",
"type": "string"
},
"name": {
"description": "Name of the Use Case this modeling project is attached to",
"type": "string"
}
},
"required": [
"id",
"name"
],
"type": "object"
}
},
"required": [
"createdAt",
"datasetName",
"name",
"numberOfModels",
"owner",
"targetName"
],
"type": "object"
},
{
"properties": {
"createdAt": {
"description": "Time when custom model was created",
"format": "date-time",
"type": "string"
},
"modifiedAt": {
"description": "Time of the last modification",
"format": "date-time",
"type": "string"
},
"name": {
"description": "Name of the custom model",
"type": "string"
},
"owner": {
"description": "Name of the custom model owner",
"type": "string"
}
},
"required": [
"createdAt",
"modifiedAt",
"name",
"owner"
],
"type": "object"
},
{
"properties": {
"createdAt": {
"description": "Time when model package was created",
"format": "date-time",
"type": "string"
},
"deploymentCount": {
"description": "Number of deployments",
"type": "integer"
},
"executionType": {
"description": "Type of execution",
"type": "string"
},
"name": {
"description": "Name of the model package",
"type": "string"
},
"targetName": {
"description": "Name of modeling target",
"type": "string"
},
"targetType": {
"description": "Type of modeling target",
"type": "string"
}
},
"required": [
"createdAt",
"deploymentCount",
"executionType",
"name",
"targetName",
"targetType"
],
"type": "object"
},
{
"properties": {
"appType": {
"description": "Type of the application",
"type": "string"
},
"createdAt": {
"description": "Time when application was created",
"format": "date-time",
"type": "string"
},
"lastModifiedAt": {
"description": "Time of the last modification",
"format": "date-time",
"type": "string"
},
"name": {
"description": "Name of the application",
"type": "string"
},
"version": {
"description": "Version string of the app",
"type": "string"
}
},
"required": [
"appType",
"createdAt",
"lastModifiedAt",
"name",
"version"
],
"type": "object"
}
]
},
"type": {
"description": "class ValueTracker attachment type",
"enum": [
"dataset",
"modelingProject",
"deployment",
"customModel",
"modelPackage",
"application"
],
"type": "string"
},
"useCaseId": {
"description": "The id of the class ValueTracker",
"type": "string"
}
},
"required": [
"attachedObjectId",
"canView",
"id",
"isAccessRequested",
"overview",
"type",
"useCaseId"
],
"type": "object"
}
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
Parameters
| Name |
In |
Type |
Required |
Description |
| start |
query |
string,null(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,null(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
{
"properties": {
"buckets": {
"description": "An array of `bucket` objects representing prediction totals and realized value over time",
"items": {
"properties": {
"period": {
"description": "A `period` object describing the time this bucket covers",
"properties": {
"end": {
"description": "RFC3339 datetime. End of time period to retrieve.",
"format": "date-time",
"type": "string"
},
"start": {
"description": "RFC3339 datetime. Start of time period to retrieve.",
"format": "date-time",
"type": "string"
}
},
"required": [
"end",
"start"
],
"type": "object"
},
"predictionsCount": {
"description": "Total number of predictions that happened in this bucket",
"type": "integer"
},
"realizedValue": {
"description": "Total amount of value realised during this bucket",
"type": "integer"
}
},
"required": [
"period",
"predictionsCount"
],
"type": "object"
},
"type": "array"
},
"previousTimeRangeSummary": {
"description": "A `summary` object covering the time range before the given one with the same duration",
"properties": {
"averagePredictionsCount": {
"description": "Average number of predictions per bucket during this time period",
"type": "integer"
},
"averageRealizedValue": {
"description": "Average amount of value per bucket realised during this time period",
"type": "integer"
},
"period": {
"description": "A `period` object describing the time this bucket covers",
"properties": {
"end": {
"description": "RFC3339 datetime. End of time period to retrieve.",
"format": "date-time",
"type": "string"
},
"start": {
"description": "RFC3339 datetime. Start of time period to retrieve.",
"format": "date-time",
"type": "string"
}
},
"required": [
"end",
"start"
],
"type": "object"
},
"totalPredictionsCount": {
"description": "Total number of predictions that happened during this time period",
"type": "integer"
},
"totalRealizedValue": {
"description": "Total amount of value realised during this time period",
"type": "integer"
}
},
"required": [
"averagePredictionsCount",
"period",
"totalRealizedValue"
],
"type": "object"
},
"summary": {
"description": "A `summary` object covering the time range before the given one with the same duration",
"properties": {
"averagePredictionsCount": {
"description": "Average number of predictions per bucket during this time period",
"type": "integer"
},
"averageRealizedValue": {
"description": "Average amount of value per bucket realised during this time period",
"type": "integer"
},
"period": {
"description": "A `period` object describing the time this bucket covers",
"properties": {
"end": {
"description": "RFC3339 datetime. End of time period to retrieve.",
"format": "date-time",
"type": "string"
},
"start": {
"description": "RFC3339 datetime. Start of time period to retrieve.",
"format": "date-time",
"type": "string"
}
},
"required": [
"end",
"start"
],
"type": "object"
},
"totalPredictionsCount": {
"description": "Total number of predictions that happened during this time period",
"type": "integer"
},
"totalRealizedValue": {
"description": "Total amount of value realised during this time period",
"type": "integer"
}
},
"required": [
"averagePredictionsCount",
"period",
"totalRealizedValue"
],
"type": "object"
}
},
"required": [
"buckets",
"previousTimeRangeSummary",
"summary"
],
"type": "object"
}
Responses
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
| 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
{
"properties": {
"count": {
"description": "The number of items returned on this page",
"type": "integer"
},
"data": {
"description": "A list of sharing role objects",
"items": {
"properties": {
"id": {
"description": "The ID of the recipient",
"type": "string"
},
"name": {
"description": "The name of the user, group, or organization",
"type": "string"
},
"role": {
"description": "The assigned role",
"enum": [
"OWNER",
"USER",
"CONSUMER",
"NO_ROLE"
],
"type": "string"
},
"shareRecipientType": {
"description": "The recipient type",
"enum": [
"user",
"group",
"organization"
],
"type": "string"
}
},
"required": [
"id",
"role",
"shareRecipientType"
],
"type": "object"
},
"type": "array"
},
"next": {
"description": "URL pointing to the next page (if null, there is no next page)",
"format": "uri",
"type": [
"string",
"null"
]
},
"previous": {
"description": "URL pointing to the previous page (if null, there is no previous page)",
"format": "uri",
"type": [
"string",
"null"
]
},
"totalCount": {
"description": "The number of items matching the query condition",
"type": "integer"
}
},
"required": [
"count",
"data",
"next",
"previous",
"totalCount"
],
"type": "object"
}
Responses
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.
Body parameter
{
"properties": {
"operation": {
"description": "The name of the action being taken. Only 'updateRoles' is supported.",
"enum": [
"updateRoles"
],
"type": "string"
},
"roles": {
"description": "A list of sharing role objects",
"items": {
"properties": {
"id": {
"description": "The ID of the recipient",
"type": "string"
},
"role": {
"description": "The assigned role",
"enum": [
"OWNER",
"USER",
"CONSUMER",
"NO_ROLE"
],
"type": "string"
},
"shareRecipientType": {
"description": "The recipient type",
"enum": [
"user",
"group",
"organization"
],
"type": "string"
},
"username": {
"description": "The name of the user, group, or organization",
"type": "string"
}
},
"required": [
"role",
"shareRecipientType"
],
"type": "object"
},
"type": "array"
}
},
"required": [
"operation",
"roles"
],
"type": "object"
}
| 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
{
"properties": {
"content": {
"description": "Content of the comment, 10000 symbols max",
"maxLength": 10000,
"type": "string"
},
"entityId": {
"description": "ID of the entity to post the comment to",
"type": "string"
},
"entityType": {
"description": "Type of the entity to post the comment to, currently only useCase is supported",
"enum": [
"useCase",
"model",
"catalog",
"experimentContainer",
"deployment"
],
"type": "string"
},
"mentions": {
"description": "A list of users IDs mentioned in the content",
"items": {
"type": "string"
},
"maxItems": 100,
"type": "array"
}
},
"required": [
"content",
"entityId",
"entityType"
],
"type": "object"
}
Properties
| Name |
Type |
Required |
Restrictions |
Description |
| content |
string |
true |
maxLength: 10000
|
Content of the comment, 10000 symbols max |
| entityId |
string |
true |
|
ID of the entity to post the comment to |
| entityType |
string |
true |
|
Type of the entity to post the comment to, currently only useCase is supported |
| mentions |
[string] |
false |
maxItems: 100
|
A list of users IDs mentioned in the content |
Enumerated Values
| Property |
Value |
| entityType |
[useCase, model, catalog, experimentContainer, deployment] |
{
"properties": {
"count": {
"description": "Number of items returned on this page",
"type": "integer"
},
"data": {
"description": "A list of comments",
"items": {
"properties": {
"content": {
"description": "Content of the comment",
"type": "string"
},
"createdAt": {
"description": "Timestamp when the comment was created",
"type": "string"
},
"createdBy": {
"description": "User object with information about the commenter",
"properties": {
"firstName": {
"description": "First name of the commenter",
"type": "string"
},
"id": {
"description": "User ID of the commenter",
"type": "string"
},
"lastName": {
"description": "Last name of the commenter",
"type": "string"
},
"username": {
"description": "Username of the commenter",
"type": "string"
}
},
"required": [
"firstName",
"id",
"lastName",
"username"
],
"type": "object"
},
"entityId": {
"description": "ID of the entity the comment posted to",
"type": "string"
},
"entityType": {
"description": "Type of the entity to post the comment to, currently only useCase is supported",
"enum": [
"useCase",
"model",
"catalog",
"experimentContainer",
"deployment"
],
"type": "string"
},
"id": {
"description": "ID of the comment",
"type": "string"
},
"mentions": {
"description": "A list of users objects (see below) mentioned in the content",
"items": {
"description": "User object with information about the commenter",
"properties": {
"firstName": {
"description": "First name of the commenter",
"type": "string"
},
"id": {
"description": "User ID of the commenter",
"type": "string"
},
"lastName": {
"description": "Last name of the commenter",
"type": "string"
},
"username": {
"description": "Username of the commenter",
"type": "string"
}
},
"required": [
"firstName",
"id",
"lastName",
"username"
],
"type": "object"
},
"type": "array"
},
"updatedAt": {
"description": "Timestamp when the comment was updated",
"type": "string"
}
},
"required": [
"content",
"createdAt",
"createdBy",
"entityId",
"entityType",
"id",
"mentions",
"updatedAt"
],
"type": "object"
},
"type": "array"
},
"next": {
"description": "URL pointing to the next page (if null, there is no next page)",
"format": "uri",
"type": [
"string",
"null"
]
},
"previous": {
"description": "URL pointing to the previous page (if null, there is no previous page)",
"format": "uri",
"type": [
"string",
"null"
]
},
"totalCount": {
"description": "Number of all available items",
"type": "integer"
}
},
"required": [
"count",
"data",
"next",
"previous",
"totalCount"
],
"type": "object"
}
Properties
| Name |
Type |
Required |
Restrictions |
Description |
| count |
integer |
true |
|
Number of items returned on this page |
| data |
[CommentRetrieve] |
true |
|
A list of comments |
| 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 |
|
Number of all available items |
{
"properties": {
"content": {
"description": "Content of the comment",
"type": "string"
},
"createdAt": {
"description": "Timestamp when the comment was created",
"type": "string"
},
"createdBy": {
"description": "User object with information about the commenter",
"properties": {
"firstName": {
"description": "First name of the commenter",
"type": "string"
},
"id": {
"description": "User ID of the commenter",
"type": "string"
},
"lastName": {
"description": "Last name of the commenter",
"type": "string"
},
"username": {
"description": "Username of the commenter",
"type": "string"
}
},
"required": [
"firstName",
"id",
"lastName",
"username"
],
"type": "object"
},
"entityId": {
"description": "ID of the entity the comment posted to",
"type": "string"
},
"entityType": {
"description": "Type of the entity to post the comment to, currently only useCase is supported",
"enum": [
"useCase",
"model",
"catalog",
"experimentContainer",
"deployment"
],
"type": "string"
},
"id": {
"description": "ID of the comment",
"type": "string"
},
"mentions": {
"description": "A list of users objects (see below) mentioned in the content",
"items": {
"description": "User object with information about the commenter",
"properties": {
"firstName": {
"description": "First name of the commenter",
"type": "string"
},
"id": {
"description": "User ID of the commenter",
"type": "string"
},
"lastName": {
"description": "Last name of the commenter",
"type": "string"
},
"username": {
"description": "Username of the commenter",
"type": "string"
}
},
"required": [
"firstName",
"id",
"lastName",
"username"
],
"type": "object"
},
"type": "array"
},
"updatedAt": {
"description": "Timestamp when the comment was updated",
"type": "string"
}
},
"required": [
"content",
"createdAt",
"createdBy",
"entityId",
"entityType",
"id",
"mentions",
"updatedAt"
],
"type": "object"
}
Properties
| Name |
Type |
Required |
Restrictions |
Description |
| content |
string |
true |
|
Content of the comment |
| createdAt |
string |
true |
|
Timestamp when the comment was created |
| createdBy |
CommentUser |
true |
|
User object with information about the commenter |
| entityId |
string |
true |
|
ID of the entity the comment posted to |
| entityType |
string |
true |
|
Type of the entity to post the comment to, currently only useCase is supported |
| id |
string |
true |
|
ID of the comment |
| mentions |
[CommentUser] |
true |
|
A list of users objects (see below) mentioned in the content |
| updatedAt |
string |
true |
|
Timestamp when the comment was updated |
Enumerated Values
| Property |
Value |
| entityType |
[useCase, model, catalog, experimentContainer, deployment] |
{
"properties": {
"content": {
"description": "Updated content of the comment, 10000 symbols max",
"maxLength": 10000,
"type": "string"
},
"mentions": {
"description": "A list of users IDs mentioned in the content",
"items": {
"type": "string"
},
"maxItems": 100,
"type": "array"
}
},
"required": [
"content"
],
"type": "object"
}
Properties
| Name |
Type |
Required |
Restrictions |
Description |
| content |
string |
true |
maxLength: 10000
|
Updated content of the comment, 10000 symbols max |
| mentions |
[string] |
false |
maxItems: 100
|
A list of users IDs mentioned in the content |
{
"description": "User object with information about the commenter",
"properties": {
"firstName": {
"description": "First name of the commenter",
"type": "string"
},
"id": {
"description": "User ID of the commenter",
"type": "string"
},
"lastName": {
"description": "Last name of the commenter",
"type": "string"
},
"username": {
"description": "Username of the commenter",
"type": "string"
}
},
"required": [
"firstName",
"id",
"lastName",
"username"
],
"type": "object"
}
User object with information about the commenter
Properties
| Name |
Type |
Required |
Restrictions |
Description |
| firstName |
string |
true |
|
First name of the commenter |
| id |
string |
true |
|
User ID of the commenter |
| lastName |
string |
true |
|
Last name of the commenter |
| username |
string |
true |
|
Username of the commenter |
CreateValueTrackerAttachment
{
"properties": {
"attachedObjects": {
"description": "An array of attachment objects",
"items": {
"properties": {
"attachedObjectId": {
"description": "The id of the attached object",
"type": "string"
},
"type": {
"description": "class ValueTracker attachment type",
"enum": [
"dataset",
"modelingProject",
"deployment",
"customModel",
"modelPackage",
"application"
],
"type": "string"
}
},
"required": [
"attachedObjectId",
"type"
],
"type": "object"
},
"type": "array"
}
},
"required": [
"attachedObjects"
],
"type": "object"
}
Properties
| Name |
Type |
Required |
Restrictions |
Description |
| attachedObjects |
[ValueTrackerAttachment] |
true |
|
An array of attachment objects |
UseCaseInfo
{
"description": "Information about the Use Case that this modeling project is attached to",
"properties": {
"id": {
"description": "ID of the Use Case this modeling project is attached to",
"type": "string"
},
"name": {
"description": "Name of the Use Case this modeling project is attached to",
"type": "string"
}
},
"required": [
"id",
"name"
],
"type": "object"
}
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
{
"properties": {
"businessImpact": {
"description": "Expected effects on overall business operations",
"maximum": 5,
"minimum": 1,
"type": [
"integer",
"null"
]
},
"commentId": {
"description": "The id for this comment",
"type": "string"
},
"content": {
"description": "A string",
"type": "string"
},
"description": {
"description": "class ValueTracker description",
"maxLength": 1024,
"type": "string"
},
"feasibility": {
"description": "Assessment of how the class ValueTracker can be accomplished across multiple dimensions",
"maximum": 5,
"minimum": 1,
"type": [
"integer",
"null"
]
},
"id": {
"description": "The id of this description item",
"type": [
"string",
"null"
]
},
"mentions": {
"description": "A list of user objects",
"items": {
"description": "DataRobot user information",
"properties": {
"firstName": {
"description": "First name of class ValueTracker owner",
"type": [
"string",
"null"
]
},
"id": {
"description": "The DR user ID",
"type": "string"
},
"lastName": {
"description": "Last of class ValueTracker owner",
"type": [
"string",
"null"
]
},
"username": {
"description": "Username of class ValueTracker owner",
"type": "string"
}
},
"required": [
"id"
],
"type": "object"
},
"type": "array"
},
"name": {
"description": "Name of the class ValueTracker",
"maxLength": 512,
"type": "string"
},
"notes": {
"description": "User notes",
"type": [
"string",
"null"
]
},
"owner": {
"description": "DataRobot user information",
"properties": {
"firstName": {
"description": "First name of class ValueTracker owner",
"type": [
"string",
"null"
]
},
"id": {
"description": "The DR user ID",
"type": "string"
},
"lastName": {
"description": "Last of class ValueTracker owner",
"type": [
"string",
"null"
]
},
"username": {
"description": "Username of class ValueTracker owner",
"type": "string"
}
},
"required": [
"id"
],
"type": "object"
},
"permissions": {
"description": "Permissions of current user",
"items": {
"type": "string"
},
"type": "array"
},
"potentialValue": {
"description": "Optional, Contains MonetaryValue objects",
"properties": {
"currency": {
"description": "ISO code of currency",
"enum": [
"AED",
"BRL",
"CHF",
"EUR",
"GBP",
"JPY",
"KRW",
"UAH",
"USD",
"ZAR"
],
"type": "string"
},
"details": {
"description": "Optional user notes",
"type": [
"string",
"null"
]
},
"value": {
"description": "Amount of value",
"type": "number"
}
},
"required": [
"currency",
"value"
],
"type": "object"
},
"potentialValueTemplate": {
"anyOf": [
{
"properties": {
"data": {
"description": "class ValueTracker value data",
"properties": {
"accuracyImprovement": {
"description": "Accuracy improvement",
"type": "number"
},
"decisionsCount": {
"description": "Estimated number of decisions per year",
"type": "integer"
},
"incorrectDecisionCost": {
"description": "Estimated cost of an individual incorrect decision",
"type": "number"
},
"incorrectDecisionsCount": {
"description": "Estimated number of incorrect decisions per year",
"type": "integer"
}
},
"required": [
"accuracyImprovement",
"decisionsCount",
"incorrectDecisionCost",
"incorrectDecisionsCount"
],
"type": "object"
},
"templateType": {
"description": "class ValueTracker value template type",
"enum": [
"classification"
],
"type": "string"
}
},
"required": [
"data",
"templateType"
],
"type": "object"
},
{
"properties": {
"data": {
"description": "class ValueTracker value data",
"properties": {
"accuracyImprovement": {
"description": "Accuracy improvement",
"type": "number"
},
"decisionsCount": {
"description": "Estimated number of decisions per year",
"type": "integer"
},
"targetValue": {
"description": "Target value",
"type": "number"
}
},
"required": [
"accuracyImprovement",
"decisionsCount",
"targetValue"
],
"type": "object"
},
"templateType": {
"description": "class ValueTracker value template type",
"enum": [
"regression"
],
"type": "string"
}
},
"required": [
"data",
"templateType"
],
"type": "object"
}
],
"description": "Optional, Contains Template type and parameter information"
},
"predictionTargets": {
"description": "An array of strings prediction target names",
"items": {
"description": "The name of the prediction target",
"type": "string"
},
"type": "array"
},
"realizedValue": {
"anyOf": [
{
"type": "string"
},
{
"description": "Optional, Contains MonetaryValue objects",
"properties": {
"currency": {
"description": "ISO code of currency",
"enum": [
"AED",
"BRL",
"CHF",
"EUR",
"GBP",
"JPY",
"KRW",
"UAH",
"USD",
"ZAR"
],
"type": "string"
},
"details": {
"description": "Optional user notes",
"type": [
"string",
"null"
]
},
"value": {
"description": "Amount of value",
"type": "number"
}
},
"required": [
"currency",
"value"
],
"type": "object"
}
],
"description": "Optional, Contains MonetaryValue objects"
},
"stage": {
"description": "Current stage of class ValueTracker",
"enum": [
"ideation",
"queued",
"dataPrepAndModeling",
"validatingAndDeploying",
"inProduction",
"retired",
"onHold"
],
"type": "string"
},
"targetDates": {
"description": "Array of TargetDate objects",
"items": {
"properties": {
"date": {
"description": "Date of the target",
"format": "date-time",
"type": "string"
},
"stage": {
"description": "Name of the target stage",
"enum": [
"ideation",
"queued",
"dataPrepAndModeling",
"validatingAndDeploying",
"inProduction",
"retired",
"onHold"
],
"type": "string"
}
},
"required": [
"date",
"stage"
],
"type": "object"
},
"type": "array"
}
},
"required": [
"name"
],
"type": "object"
}
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 |
|
DataRobot user information |
| permissions |
[string] |
false |
|
Permissions of current user |
| potentialValue |
ValueTrackerMonetaryValue |
false |
|
Optional, Contains MonetaryValue objects |
| potentialValueTemplate |
any |
false |
|
Optional, Contains Template type and parameter information |
anyOf
or
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
{
"description": "DataRobot user information",
"properties": {
"eventDescription": {
"description": "Details of the activity, content depends on activity type",
"properties": {
"businessImpact": {
"description": "Expected effects on overall business operations",
"maximum": 5,
"minimum": 1,
"type": [
"integer",
"null"
]
},
"commentId": {
"description": "The id for this comment",
"type": "string"
},
"content": {
"description": "A string",
"type": "string"
},
"description": {
"description": "class ValueTracker description",
"type": [
"string",
"null"
]
},
"feasibility": {
"description": "Assessment of how the class ValueTracker can be accomplished across multiple dimensions",
"maximum": 5,
"minimum": 1,
"type": [
"integer",
"null"
]
},
"id": {
"description": "The id of this description item",
"type": [
"string",
"null"
]
},
"mentions": {
"description": "A list of user objects",
"items": {
"description": "DataRobot user information",
"properties": {
"firstName": {
"description": "First name of class ValueTracker owner",
"type": [
"string",
"null"
]
},
"id": {
"description": "The DR user ID",
"type": "string"
},
"lastName": {
"description": "Last of class ValueTracker owner",
"type": [
"string",
"null"
]
},
"username": {
"description": "Username of class ValueTracker owner",
"type": "string"
}
},
"required": [
"id"
],
"type": "object"
},
"type": "array"
},
"name": {
"description": "The name of this event item",
"type": [
"string",
"null"
]
},
"notes": {
"description": "User notes",
"type": [
"string",
"null"
]
},
"owner": {
"description": "DataRobot user information",
"properties": {
"firstName": {
"description": "First name of class ValueTracker owner",
"type": [
"string",
"null"
]
},
"id": {
"description": "The DR user ID",
"type": "string"
},
"lastName": {
"description": "Last of class ValueTracker owner",
"type": [
"string",
"null"
]
},
"username": {
"description": "Username of class ValueTracker owner",
"type": "string"
}
},
"required": [
"id"
],
"type": "object"
},
"permissions": {
"description": "Permissions of current user",
"items": {
"type": "string"
},
"type": "array"
},
"potentialValue": {
"description": "Optional, Contains MonetaryValue objects",
"properties": {
"currency": {
"description": "ISO code of currency",
"enum": [
"AED",
"BRL",
"CHF",
"EUR",
"GBP",
"JPY",
"KRW",
"UAH",
"USD",
"ZAR"
],
"type": "string"
},
"details": {
"description": "Optional user notes",
"type": [
"string",
"null"
]
},
"value": {
"description": "Amount of value",
"type": "number"
}
},
"required": [
"currency",
"value"
],
"type": "object"
},
"potentialValueTemplate": {
"anyOf": [
{
"properties": {
"data": {
"description": "class ValueTracker value data",
"properties": {
"accuracyImprovement": {
"description": "Accuracy improvement",
"type": "number"
},
"decisionsCount": {
"description": "Estimated number of decisions per year",
"type": "integer"
},
"incorrectDecisionCost": {
"description": "Estimated cost of an individual incorrect decision",
"type": "number"
},
"incorrectDecisionsCount": {
"description": "Estimated number of incorrect decisions per year",
"type": "integer"
}
},
"required": [
"accuracyImprovement",
"decisionsCount",
"incorrectDecisionCost",
"incorrectDecisionsCount"
],
"type": "object"
},
"templateType": {
"description": "class ValueTracker value template type",
"enum": [
"classification"
],
"type": "string"
}
},
"required": [
"data",
"templateType"
],
"type": "object"
},
{
"properties": {
"data": {
"description": "class ValueTracker value data",
"properties": {
"accuracyImprovement": {
"description": "Accuracy improvement",
"type": "number"
},
"decisionsCount": {
"description": "Estimated number of decisions per year",
"type": "integer"
},
"targetValue": {
"description": "Target value",
"type": "number"
}
},
"required": [
"accuracyImprovement",
"decisionsCount",
"targetValue"
],
"type": "object"
},
"templateType": {
"description": "class ValueTracker value template type",
"enum": [
"regression"
],
"type": "string"
}
},
"required": [
"data",
"templateType"
],
"type": "object"
}
],
"description": "Optional, Contains Template type and parameter information"
},
"predictionTargets": {
"description": "An array of strings prediction target names",
"items": {
"description": "The name of the prediction target",
"type": "string"
},
"type": "array"
},
"realizedValue": {
"anyOf": [
{
"type": "string"
},
{
"description": "Optional, Contains MonetaryValue objects",
"properties": {
"currency": {
"description": "ISO code of currency",
"enum": [
"AED",
"BRL",
"CHF",
"EUR",
"GBP",
"JPY",
"KRW",
"UAH",
"USD",
"ZAR"
],
"type": "string"
},
"details": {
"description": "Optional user notes",
"type": [
"string",
"null"
]
},
"value": {
"description": "Amount of value",
"type": "number"
}
},
"required": [
"currency",
"value"
],
"type": "object"
}
],
"description": "Optional, Contains MonetaryValue objects"
},
"stage": {
"description": "Current stage of class ValueTracker",
"enum": [
"ideation",
"queued",
"dataPrepAndModeling",
"validatingAndDeploying",
"inProduction",
"retired",
"onHold"
],
"type": "string"
},
"targetDates": {
"description": "Array of TargetDate objects",
"items": {
"properties": {
"date": {
"description": "Date of the target",
"format": "date-time",
"type": "string"
},
"stage": {
"description": "Name of the target stage",
"enum": [
"ideation",
"queued",
"dataPrepAndModeling",
"validatingAndDeploying",
"inProduction",
"retired",
"onHold"
],
"type": "string"
}
},
"required": [
"date",
"stage"
],
"type": "object"
},
"type": "array"
}
},
"type": "object"
},
"eventType": {
"description": "The type of activity",
"type": [
"string",
"null"
]
},
"firstName": {
"description": "First name of class ValueTracker owner",
"type": [
"string",
"null"
]
},
"id": {
"description": "The id of the class ValueTracker activity",
"type": "string"
},
"lastName": {
"description": "Last of class ValueTracker owner",
"type": [
"string",
"null"
]
},
"timestamp": {
"description": "The timestamp of the activity",
"format": "date-time",
"type": "string"
},
"user": {
"description": "DataRobot user information",
"properties": {
"firstName": {
"description": "First name of class ValueTracker owner",
"type": [
"string",
"null"
]
},
"id": {
"description": "The DR user ID",
"type": "string"
},
"lastName": {
"description": "Last of class ValueTracker owner",
"type": [
"string",
"null"
]
},
"username": {
"description": "Username of class ValueTracker owner",
"type": "string"
}
},
"required": [
"id"
],
"type": "object"
},
"username": {
"description": "Username of class ValueTracker owner",
"type": "string"
}
},
"required": [
"eventDescription",
"eventType",
"timestamp",
"user"
],
"type": "object"
}
DataRobot user information
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 |
|
DataRobot user information |
| username |
string |
false |
|
Username of class ValueTracker owner |
ValueTrackerActivityListResponse
{
"properties": {
"count": {
"description": "The number of items returned on this page",
"type": "integer"
},
"data": {
"description": "The activities of a class ValueTracker",
"items": {
"description": "DataRobot user information",
"properties": {
"eventDescription": {
"description": "Details of the activity, content depends on activity type",
"properties": {
"businessImpact": {
"description": "Expected effects on overall business operations",
"maximum": 5,
"minimum": 1,
"type": [
"integer",
"null"
]
},
"commentId": {
"description": "The id for this comment",
"type": "string"
},
"content": {
"description": "A string",
"type": "string"
},
"description": {
"description": "class ValueTracker description",
"type": [
"string",
"null"
]
},
"feasibility": {
"description": "Assessment of how the class ValueTracker can be accomplished across multiple dimensions",
"maximum": 5,
"minimum": 1,
"type": [
"integer",
"null"
]
},
"id": {
"description": "The id of this description item",
"type": [
"string",
"null"
]
},
"mentions": {
"description": "A list of user objects",
"items": {
"description": "DataRobot user information",
"properties": {
"firstName": {
"description": "First name of class ValueTracker owner",
"type": [
"string",
"null"
]
},
"id": {
"description": "The DR user ID",
"type": "string"
},
"lastName": {
"description": "Last of class ValueTracker owner",
"type": [
"string",
"null"
]
},
"username": {
"description": "Username of class ValueTracker owner",
"type": "string"
}
},
"required": [
"id"
],
"type": "object"
},
"type": "array"
},
"name": {
"description": "The name of this event item",
"type": [
"string",
"null"
]
},
"notes": {
"description": "User notes",
"type": [
"string",
"null"
]
},
"owner": {
"description": "DataRobot user information",
"properties": {
"firstName": {
"description": "First name of class ValueTracker owner",
"type": [
"string",
"null"
]
},
"id": {
"description": "The DR user ID",
"type": "string"
},
"lastName": {
"description": "Last of class ValueTracker owner",
"type": [
"string",
"null"
]
},
"username": {
"description": "Username of class ValueTracker owner",
"type": "string"
}
},
"required": [
"id"
],
"type": "object"
},
"permissions": {
"description": "Permissions of current user",
"items": {
"type": "string"
},
"type": "array"
},
"potentialValue": {
"description": "Optional, Contains MonetaryValue objects",
"properties": {
"currency": {
"description": "ISO code of currency",
"enum": [
"AED",
"BRL",
"CHF",
"EUR",
"GBP",
"JPY",
"KRW",
"UAH",
"USD",
"ZAR"
],
"type": "string"
},
"details": {
"description": "Optional user notes",
"type": [
"string",
"null"
]
},
"value": {
"description": "Amount of value",
"type": "number"
}
},
"required": [
"currency",
"value"
],
"type": "object"
},
"potentialValueTemplate": {
"anyOf": [
{
"properties": {
"data": {
"description": "class ValueTracker value data",
"properties": {
"accuracyImprovement": {
"description": "Accuracy improvement",
"type": "number"
},
"decisionsCount": {
"description": "Estimated number of decisions per year",
"type": "integer"
},
"incorrectDecisionCost": {
"description": "Estimated cost of an individual incorrect decision",
"type": "number"
},
"incorrectDecisionsCount": {
"description": "Estimated number of incorrect decisions per year",
"type": "integer"
}
},
"required": [
"accuracyImprovement",
"decisionsCount",
"incorrectDecisionCost",
"incorrectDecisionsCount"
],
"type": "object"
},
"templateType": {
"description": "class ValueTracker value template type",
"enum": [
"classification"
],
"type": "string"
}
},
"required": [
"data",
"templateType"
],
"type": "object"
},
{
"properties": {
"data": {
"description": "class ValueTracker value data",
"properties": {
"accuracyImprovement": {
"description": "Accuracy improvement",
"type": "number"
},
"decisionsCount": {
"description": "Estimated number of decisions per year",
"type": "integer"
},
"targetValue": {
"description": "Target value",
"type": "number"
}
},
"required": [
"accuracyImprovement",
"decisionsCount",
"targetValue"
],
"type": "object"
},
"templateType": {
"description": "class ValueTracker value template type",
"enum": [
"regression"
],
"type": "string"
}
},
"required": [
"data",
"templateType"
],
"type": "object"
}
],
"description": "Optional, Contains Template type and parameter information"
},
"predictionTargets": {
"description": "An array of strings prediction target names",
"items": {
"description": "The name of the prediction target",
"type": "string"
},
"type": "array"
},
"realizedValue": {
"anyOf": [
{
"type": "string"
},
{
"description": "Optional, Contains MonetaryValue objects",
"properties": {
"currency": {
"description": "ISO code of currency",
"enum": [
"AED",
"BRL",
"CHF",
"EUR",
"GBP",
"JPY",
"KRW",
"UAH",
"USD",
"ZAR"
],
"type": "string"
},
"details": {
"description": "Optional user notes",
"type": [
"string",
"null"
]
},
"value": {
"description": "Amount of value",
"type": "number"
}
},
"required": [
"currency",
"value"
],
"type": "object"
}
],
"description": "Optional, Contains MonetaryValue objects"
},
"stage": {
"description": "Current stage of class ValueTracker",
"enum": [
"ideation",
"queued",
"dataPrepAndModeling",
"validatingAndDeploying",
"inProduction",
"retired",
"onHold"
],
"type": "string"
},
"targetDates": {
"description": "Array of TargetDate objects",
"items": {
"properties": {
"date": {
"description": "Date of the target",
"format": "date-time",
"type": "string"
},
"stage": {
"description": "Name of the target stage",
"enum": [
"ideation",
"queued",
"dataPrepAndModeling",
"validatingAndDeploying",
"inProduction",
"retired",
"onHold"
],
"type": "string"
}
},
"required": [
"date",
"stage"
],
"type": "object"
},
"type": "array"
}
},
"type": "object"
},
"eventType": {
"description": "The type of activity",
"type": [
"string",
"null"
]
},
"firstName": {
"description": "First name of class ValueTracker owner",
"type": [
"string",
"null"
]
},
"id": {
"description": "The id of the class ValueTracker activity",
"type": "string"
},
"lastName": {
"description": "Last of class ValueTracker owner",
"type": [
"string",
"null"
]
},
"timestamp": {
"description": "The timestamp of the activity",
"format": "date-time",
"type": "string"
},
"user": {
"description": "DataRobot user information",
"properties": {
"firstName": {
"description": "First name of class ValueTracker owner",
"type": [
"string",
"null"
]
},
"id": {
"description": "The DR user ID",
"type": "string"
},
"lastName": {
"description": "Last of class ValueTracker owner",
"type": [
"string",
"null"
]
},
"username": {
"description": "Username of class ValueTracker owner",
"type": "string"
}
},
"required": [
"id"
],
"type": "object"
},
"username": {
"description": "Username of class ValueTracker owner",
"type": "string"
}
},
"required": [
"eventDescription",
"eventType",
"timestamp",
"user"
],
"type": "object"
},
"type": "array"
},
"next": {
"description": "URL pointing to the next page (if null, there is no next page)",
"format": "uri",
"type": [
"string",
"null"
]
},
"previous": {
"description": "URL pointing to the previous page (if null, there is no previous page)",
"format": "uri",
"type": [
"string",
"null"
]
},
"totalCount": {
"description": "The number of items matching the query condition",
"type": "integer"
}
},
"required": [
"count",
"data",
"next",
"previous",
"totalCount"
],
"type": "object"
}
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,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 number of items matching the query condition |
ValueTrackerAttachment
{
"properties": {
"attachedObjectId": {
"description": "The id of the attached object",
"type": "string"
},
"type": {
"description": "class ValueTracker attachment type",
"enum": [
"dataset",
"modelingProject",
"deployment",
"customModel",
"modelPackage",
"application"
],
"type": "string"
}
},
"required": [
"attachedObjectId",
"type"
],
"type": "object"
}
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
{
"properties": {
"appType": {
"description": "Type of the application",
"type": "string"
},
"createdAt": {
"description": "Time when application was created",
"format": "date-time",
"type": "string"
},
"lastModifiedAt": {
"description": "Time of the last modification",
"format": "date-time",
"type": "string"
},
"name": {
"description": "Name of the application",
"type": "string"
},
"version": {
"description": "Version string of the app",
"type": "string"
}
},
"required": [
"appType",
"createdAt",
"lastModifiedAt",
"name",
"version"
],
"type": "object"
}
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
{
"properties": {
"createdAt": {
"description": "Time when custom model was created",
"format": "date-time",
"type": "string"
},
"modifiedAt": {
"description": "Time of the last modification",
"format": "date-time",
"type": "string"
},
"name": {
"description": "Name of the custom model",
"type": "string"
},
"owner": {
"description": "Name of the custom model owner",
"type": "string"
}
},
"required": [
"createdAt",
"modifiedAt",
"name",
"owner"
],
"type": "object"
}
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
{
"properties": {
"createdAt": {
"description": "Time when dataset was created",
"format": "date-time",
"type": "string"
},
"createdBy": {
"description": "Name of user who created the dataset",
"type": "string"
},
"lastModifiedAt": {
"description": "Time of the last modification",
"format": "date-time",
"type": "string"
},
"lastModifiedBy": {
"description": "Name of user who did last modification",
"type": "string"
},
"name": {
"description": "Name of the dataset",
"type": "string"
}
},
"required": [
"createdAt",
"createdBy",
"lastModifiedAt",
"lastModifiedBy",
"name"
],
"type": "object"
}
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
{
"description": "Accuracy related health status",
"properties": {
"endDate": {
"description": "End date of health status",
"format": "date-time",
"type": "string"
},
"message": {
"description": "Health status related information",
"type": "string"
},
"startDate": {
"description": "Start date of health status",
"format": "date-time",
"type": "string"
},
"status": {
"description": "Health status",
"type": "string"
}
},
"required": [
"endDate",
"message",
"startDate",
"status"
],
"type": "object"
}
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
{
"properties": {
"accuracyHealth": {
"description": "Accuracy related health status",
"properties": {
"endDate": {
"description": "End date of health status",
"format": "date-time",
"type": "string"
},
"message": {
"description": "Health status related information",
"type": "string"
},
"startDate": {
"description": "Start date of health status",
"format": "date-time",
"type": "string"
},
"status": {
"description": "Health status",
"type": "string"
}
},
"required": [
"endDate",
"message",
"startDate",
"status"
],
"type": "object"
},
"modelHealth": {
"description": "Accuracy related health status",
"properties": {
"endDate": {
"description": "End date of health status",
"format": "date-time",
"type": "string"
},
"message": {
"description": "Health status related information",
"type": "string"
},
"startDate": {
"description": "Start date of health status",
"format": "date-time",
"type": "string"
},
"status": {
"description": "Health status",
"type": "string"
}
},
"required": [
"endDate",
"message",
"startDate",
"status"
],
"type": "object"
},
"name": {
"description": "Name of the deployment",
"type": "string"
},
"predictionServer": {
"description": "Name of prediction server",
"type": "string"
},
"predictionUsage": {
"description": "class ValueTracker attachment detail for Deployment usage",
"properties": {
"dailyRates": {
"description": "List of daily request counts",
"items": {
"type": "integer"
},
"type": "array"
},
"lastTimestamp": {
"description": "Last prediction time",
"format": "date-time",
"type": "string"
}
},
"required": [
"dailyRates",
"lastTimestamp"
],
"type": "object"
},
"serviceHealth": {
"description": "Accuracy related health status",
"properties": {
"endDate": {
"description": "End date of health status",
"format": "date-time",
"type": "string"
},
"message": {
"description": "Health status related information",
"type": "string"
},
"startDate": {
"description": "Start date of health status",
"format": "date-time",
"type": "string"
},
"status": {
"description": "Health status",
"type": "string"
}
},
"required": [
"endDate",
"message",
"startDate",
"status"
],
"type": "object"
}
},
"required": [
"accuracyHealth",
"modelHealth",
"name",
"predictionServer",
"predictionUsage",
"serviceHealth"
],
"type": "object"
}
Properties
ValueTrackerAttachmentDeploymentPredictionUsage
{
"description": "class ValueTracker attachment detail for Deployment usage",
"properties": {
"dailyRates": {
"description": "List of daily request counts",
"items": {
"type": "integer"
},
"type": "array"
},
"lastTimestamp": {
"description": "Last prediction time",
"format": "date-time",
"type": "string"
}
},
"required": [
"dailyRates",
"lastTimestamp"
],
"type": "object"
}
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
{
"properties": {
"count": {
"description": "Number of results returned",
"type": "integer"
},
"data": {
"description": "An array of attachment objects",
"items": {
"properties": {
"attachedObjectId": {
"description": "The id of the attached object",
"type": "string"
},
"canView": {
"description": "Indicates if user has view access to the attached object",
"type": "boolean"
},
"id": {
"description": "The id of the class ValueTracker",
"type": "string"
},
"isAccessRequested": {
"description": "Indicates if user has requested access to the attached object",
"type": "boolean"
},
"overview": {
"description": "Detailed information depending on the type of the attachment",
"oneOf": [
{
"properties": {
"accuracyHealth": {
"description": "Accuracy related health status",
"properties": {
"endDate": {
"description": "End date of health status",
"format": "date-time",
"type": "string"
},
"message": {
"description": "Health status related information",
"type": "string"
},
"startDate": {
"description": "Start date of health status",
"format": "date-time",
"type": "string"
},
"status": {
"description": "Health status",
"type": "string"
}
},
"required": [
"endDate",
"message",
"startDate",
"status"
],
"type": "object"
},
"modelHealth": {
"description": "Accuracy related health status",
"properties": {
"endDate": {
"description": "End date of health status",
"format": "date-time",
"type": "string"
},
"message": {
"description": "Health status related information",
"type": "string"
},
"startDate": {
"description": "Start date of health status",
"format": "date-time",
"type": "string"
},
"status": {
"description": "Health status",
"type": "string"
}
},
"required": [
"endDate",
"message",
"startDate",
"status"
],
"type": "object"
},
"name": {
"description": "Name of the deployment",
"type": "string"
},
"predictionServer": {
"description": "Name of prediction server",
"type": "string"
},
"predictionUsage": {
"description": "class ValueTracker attachment detail for Deployment usage",
"properties": {
"dailyRates": {
"description": "List of daily request counts",
"items": {
"type": "integer"
},
"type": "array"
},
"lastTimestamp": {
"description": "Last prediction time",
"format": "date-time",
"type": "string"
}
},
"required": [
"dailyRates",
"lastTimestamp"
],
"type": "object"
},
"serviceHealth": {
"description": "Accuracy related health status",
"properties": {
"endDate": {
"description": "End date of health status",
"format": "date-time",
"type": "string"
},
"message": {
"description": "Health status related information",
"type": "string"
},
"startDate": {
"description": "Start date of health status",
"format": "date-time",
"type": "string"
},
"status": {
"description": "Health status",
"type": "string"
}
},
"required": [
"endDate",
"message",
"startDate",
"status"
],
"type": "object"
}
},
"required": [
"accuracyHealth",
"modelHealth",
"name",
"predictionServer",
"predictionUsage",
"serviceHealth"
],
"type": "object"
},
{
"properties": {
"createdAt": {
"description": "Time when dataset was created",
"format": "date-time",
"type": "string"
},
"createdBy": {
"description": "Name of user who created the dataset",
"type": "string"
},
"lastModifiedAt": {
"description": "Time of the last modification",
"format": "date-time",
"type": "string"
},
"lastModifiedBy": {
"description": "Name of user who did last modification",
"type": "string"
},
"name": {
"description": "Name of the dataset",
"type": "string"
}
},
"required": [
"createdAt",
"createdBy",
"lastModifiedAt",
"lastModifiedBy",
"name"
],
"type": "object"
},
{
"properties": {
"createdAt": {
"description": "Time when project was created",
"format": "date-time",
"type": "string"
},
"datasetName": {
"description": "Name of default dataset",
"type": "string"
},
"name": {
"description": "Name of the project",
"type": "string"
},
"numberOfModels": {
"description": "Number of the models in the project",
"type": [
"integer",
"null"
]
},
"owner": {
"description": "Name of the modeling project owner",
"type": [
"string",
"null"
]
},
"targetName": {
"description": "Name of modeling target",
"type": "string"
},
"useCase": {
"description": "Information about the Use Case that this modeling project is attached to",
"properties": {
"id": {
"description": "ID of the Use Case this modeling project is attached to",
"type": "string"
},
"name": {
"description": "Name of the Use Case this modeling project is attached to",
"type": "string"
}
},
"required": [
"id",
"name"
],
"type": "object"
}
},
"required": [
"createdAt",
"datasetName",
"name",
"numberOfModels",
"owner",
"targetName"
],
"type": "object"
},
{
"properties": {
"createdAt": {
"description": "Time when custom model was created",
"format": "date-time",
"type": "string"
},
"modifiedAt": {
"description": "Time of the last modification",
"format": "date-time",
"type": "string"
},
"name": {
"description": "Name of the custom model",
"type": "string"
},
"owner": {
"description": "Name of the custom model owner",
"type": "string"
}
},
"required": [
"createdAt",
"modifiedAt",
"name",
"owner"
],
"type": "object"
},
{
"properties": {
"createdAt": {
"description": "Time when model package was created",
"format": "date-time",
"type": "string"
},
"deploymentCount": {
"description": "Number of deployments",
"type": "integer"
},
"executionType": {
"description": "Type of execution",
"type": "string"
},
"name": {
"description": "Name of the model package",
"type": "string"
},
"targetName": {
"description": "Name of modeling target",
"type": "string"
},
"targetType": {
"description": "Type of modeling target",
"type": "string"
}
},
"required": [
"createdAt",
"deploymentCount",
"executionType",
"name",
"targetName",
"targetType"
],
"type": "object"
},
{
"properties": {
"appType": {
"description": "Type of the application",
"type": "string"
},
"createdAt": {
"description": "Time when application was created",
"format": "date-time",
"type": "string"
},
"lastModifiedAt": {
"description": "Time of the last modification",
"format": "date-time",
"type": "string"
},
"name": {
"description": "Name of the application",
"type": "string"
},
"version": {
"description": "Version string of the app",
"type": "string"
}
},
"required": [
"appType",
"createdAt",
"lastModifiedAt",
"name",
"version"
],
"type": "object"
}
]
},
"type": {
"description": "class ValueTracker attachment type",
"enum": [
"dataset",
"modelingProject",
"deployment",
"customModel",
"modelPackage",
"application"
],
"type": "string"
},
"useCaseId": {
"description": "The id of the class ValueTracker",
"type": "string"
}
},
"required": [
"attachedObjectId",
"canView",
"id",
"isAccessRequested",
"overview",
"type",
"useCaseId"
],
"type": "object"
},
"type": "array"
},
"next": {
"description": "Link to next page",
"type": [
"string",
"null"
]
},
"previous": {
"description": "Link to previous page",
"type": [
"string",
"null"
]
},
"totalCount": {
"description": "Total number of results available",
"type": "integer"
}
},
"required": [
"count",
"data",
"next",
"previous",
"totalCount"
],
"type": "object"
}
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
{
"properties": {
"createdAt": {
"description": "Time when model package was created",
"format": "date-time",
"type": "string"
},
"deploymentCount": {
"description": "Number of deployments",
"type": "integer"
},
"executionType": {
"description": "Type of execution",
"type": "string"
},
"name": {
"description": "Name of the model package",
"type": "string"
},
"targetName": {
"description": "Name of modeling target",
"type": "string"
},
"targetType": {
"description": "Type of modeling target",
"type": "string"
}
},
"required": [
"createdAt",
"deploymentCount",
"executionType",
"name",
"targetName",
"targetType"
],
"type": "object"
}
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
{
"properties": {
"createdAt": {
"description": "Time when project was created",
"format": "date-time",
"type": "string"
},
"datasetName": {
"description": "Name of default dataset",
"type": "string"
},
"name": {
"description": "Name of the project",
"type": "string"
},
"numberOfModels": {
"description": "Number of the models in the project",
"type": [
"integer",
"null"
]
},
"owner": {
"description": "Name of the modeling project owner",
"type": [
"string",
"null"
]
},
"targetName": {
"description": "Name of modeling target",
"type": "string"
},
"useCase": {
"description": "Information about the Use Case that this modeling project is attached to",
"properties": {
"id": {
"description": "ID of the Use Case this modeling project is attached to",
"type": "string"
},
"name": {
"description": "Name of the Use Case this modeling project is attached to",
"type": "string"
}
},
"required": [
"id",
"name"
],
"type": "object"
}
},
"required": [
"createdAt",
"datasetName",
"name",
"numberOfModels",
"owner",
"targetName"
],
"type": "object"
}
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
{
"properties": {
"attachedObjectId": {
"description": "The id of the attached object",
"type": "string"
},
"canView": {
"description": "Indicates if user has view access to the attached object",
"type": "boolean"
},
"id": {
"description": "The id of the class ValueTracker",
"type": "string"
},
"isAccessRequested": {
"description": "Indicates if user has requested access to the attached object",
"type": "boolean"
},
"overview": {
"description": "Detailed information depending on the type of the attachment",
"oneOf": [
{
"properties": {
"accuracyHealth": {
"description": "Accuracy related health status",
"properties": {
"endDate": {
"description": "End date of health status",
"format": "date-time",
"type": "string"
},
"message": {
"description": "Health status related information",
"type": "string"
},
"startDate": {
"description": "Start date of health status",
"format": "date-time",
"type": "string"
},
"status": {
"description": "Health status",
"type": "string"
}
},
"required": [
"endDate",
"message",
"startDate",
"status"
],
"type": "object"
},
"modelHealth": {
"description": "Accuracy related health status",
"properties": {
"endDate": {
"description": "End date of health status",
"format": "date-time",
"type": "string"
},
"message": {
"description": "Health status related information",
"type": "string"
},
"startDate": {
"description": "Start date of health status",
"format": "date-time",
"type": "string"
},
"status": {
"description": "Health status",
"type": "string"
}
},
"required": [
"endDate",
"message",
"startDate",
"status"
],
"type": "object"
},
"name": {
"description": "Name of the deployment",
"type": "string"
},
"predictionServer": {
"description": "Name of prediction server",
"type": "string"
},
"predictionUsage": {
"description": "class ValueTracker attachment detail for Deployment usage",
"properties": {
"dailyRates": {
"description": "List of daily request counts",
"items": {
"type": "integer"
},
"type": "array"
},
"lastTimestamp": {
"description": "Last prediction time",
"format": "date-time",
"type": "string"
}
},
"required": [
"dailyRates",
"lastTimestamp"
],
"type": "object"
},
"serviceHealth": {
"description": "Accuracy related health status",
"properties": {
"endDate": {
"description": "End date of health status",
"format": "date-time",
"type": "string"
},
"message": {
"description": "Health status related information",
"type": "string"
},
"startDate": {
"description": "Start date of health status",
"format": "date-time",
"type": "string"
},
"status": {
"description": "Health status",
"type": "string"
}
},
"required": [
"endDate",
"message",
"startDate",
"status"
],
"type": "object"
}
},
"required": [
"accuracyHealth",
"modelHealth",
"name",
"predictionServer",
"predictionUsage",
"serviceHealth"
],
"type": "object"
},
{
"properties": {
"createdAt": {
"description": "Time when dataset was created",
"format": "date-time",
"type": "string"
},
"createdBy": {
"description": "Name of user who created the dataset",
"type": "string"
},
"lastModifiedAt": {
"description": "Time of the last modification",
"format": "date-time",
"type": "string"
},
"lastModifiedBy": {
"description": "Name of user who did last modification",
"type": "string"
},
"name": {
"description": "Name of the dataset",
"type": "string"
}
},
"required": [
"createdAt",
"createdBy",
"lastModifiedAt",
"lastModifiedBy",
"name"
],
"type": "object"
},
{
"properties": {
"createdAt": {
"description": "Time when project was created",
"format": "date-time",
"type": "string"
},
"datasetName": {
"description": "Name of default dataset",
"type": "string"
},
"name": {
"description": "Name of the project",
"type": "string"
},
"numberOfModels": {
"description": "Number of the models in the project",
"type": [
"integer",
"null"
]
},
"owner": {
"description": "Name of the modeling project owner",
"type": [
"string",
"null"
]
},
"targetName": {
"description": "Name of modeling target",
"type": "string"
},
"useCase": {
"description": "Information about the Use Case that this modeling project is attached to",
"properties": {
"id": {
"description": "ID of the Use Case this modeling project is attached to",
"type": "string"
},
"name": {
"description": "Name of the Use Case this modeling project is attached to",
"type": "string"
}
},
"required": [
"id",
"name"
],
"type": "object"
}
},
"required": [
"createdAt",
"datasetName",
"name",
"numberOfModels",
"owner",
"targetName"
],
"type": "object"
},
{
"properties": {
"createdAt": {
"description": "Time when custom model was created",
"format": "date-time",
"type": "string"
},
"modifiedAt": {
"description": "Time of the last modification",
"format": "date-time",
"type": "string"
},
"name": {
"description": "Name of the custom model",
"type": "string"
},
"owner": {
"description": "Name of the custom model owner",
"type": "string"
}
},
"required": [
"createdAt",
"modifiedAt",
"name",
"owner"
],
"type": "object"
},
{
"properties": {
"createdAt": {
"description": "Time when model package was created",
"format": "date-time",
"type": "string"
},
"deploymentCount": {
"description": "Number of deployments",
"type": "integer"
},
"executionType": {
"description": "Type of execution",
"type": "string"
},
"name": {
"description": "Name of the model package",
"type": "string"
},
"targetName": {
"description": "Name of modeling target",
"type": "string"
},
"targetType": {
"description": "Type of modeling target",
"type": "string"
}
},
"required": [
"createdAt",
"deploymentCount",
"executionType",
"name",
"targetName",
"targetType"
],
"type": "object"
},
{
"properties": {
"appType": {
"description": "Type of the application",
"type": "string"
},
"createdAt": {
"description": "Time when application was created",
"format": "date-time",
"type": "string"
},
"lastModifiedAt": {
"description": "Time of the last modification",
"format": "date-time",
"type": "string"
},
"name": {
"description": "Name of the application",
"type": "string"
},
"version": {
"description": "Version string of the app",
"type": "string"
}
},
"required": [
"appType",
"createdAt",
"lastModifiedAt",
"name",
"version"
],
"type": "object"
}
]
},
"type": {
"description": "class ValueTracker attachment type",
"enum": [
"dataset",
"modelingProject",
"deployment",
"customModel",
"modelPackage",
"application"
],
"type": "string"
},
"useCaseId": {
"description": "The id of the class ValueTracker",
"type": "string"
}
},
"required": [
"attachedObjectId",
"canView",
"id",
"isAccessRequested",
"overview",
"type",
"useCaseId"
],
"type": "object"
}
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
xor
xor
xor
xor
xor
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
{
"properties": {
"period": {
"description": "A `period` object describing the time this bucket covers",
"properties": {
"end": {
"description": "RFC3339 datetime. End of time period to retrieve.",
"format": "date-time",
"type": "string"
},
"start": {
"description": "RFC3339 datetime. Start of time period to retrieve.",
"format": "date-time",
"type": "string"
}
},
"required": [
"end",
"start"
],
"type": "object"
},
"predictionsCount": {
"description": "Total number of predictions that happened in this bucket",
"type": "integer"
},
"realizedValue": {
"description": "Total amount of value realised during this bucket",
"type": "integer"
}
},
"required": [
"period",
"predictionsCount"
],
"type": "object"
}
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
{
"description": "A `period` object describing the time this bucket covers",
"properties": {
"end": {
"description": "RFC3339 datetime. End of time period to retrieve.",
"format": "date-time",
"type": "string"
},
"start": {
"description": "RFC3339 datetime. Start of time period to retrieve.",
"format": "date-time",
"type": "string"
}
},
"required": [
"end",
"start"
],
"type": "object"
}
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
{
"description": "class ValueTracker information",
"properties": {
"accuracyHealth": {
"anyOf": [
{
"type": "string"
},
{
"properties": {
"endDate": {
"description": "The end date for this health status",
"format": "date-time",
"type": [
"string",
"null"
]
},
"message": {
"description": "Information about the health status",
"type": [
"string",
"null"
]
},
"startDate": {
"description": "The start date for this health status",
"format": "date-time",
"type": [
"string",
"null"
]
},
"status": {
"description": "The status of the class ValueTracker",
"type": [
"string",
"null"
]
}
},
"required": [
"endDate",
"message",
"startDate",
"status"
],
"type": "object"
}
],
"description": "The health of the accuracy"
},
"businessImpact": {
"description": "Expected effects on overall business operations",
"maximum": 5,
"minimum": 1,
"type": [
"integer",
"null"
]
},
"commentId": {
"description": "The id for this comment",
"type": "string"
},
"content": {
"description": "A string",
"type": "string"
},
"description": {
"description": "class ValueTracker description",
"type": "string"
},
"feasibility": {
"description": "Assessment of how the class ValueTracker can be accomplished across multiple dimensions",
"maximum": 5,
"minimum": 1,
"type": [
"integer",
"null"
]
},
"id": {
"description": "The id of the class ValueTracker",
"type": "string"
},
"inProductionWarning": {
"description": "An optional warning to indicate that deployments are attached to this class ValueTracker.",
"type": [
"string",
"null"
]
},
"mentions": {
"description": "A list of user objects",
"items": {
"description": "DataRobot user information",
"properties": {
"firstName": {
"description": "First name of class ValueTracker owner",
"type": [
"string",
"null"
]
},
"id": {
"description": "The DR user ID",
"type": "string"
},
"lastName": {
"description": "Last of class ValueTracker owner",
"type": [
"string",
"null"
]
},
"username": {
"description": "Username of class ValueTracker owner",
"type": "string"
}
},
"required": [
"id"
],
"type": "object"
},
"type": "array"
},
"modelHealth": {
"anyOf": [
{
"type": "string"
},
{
"properties": {
"endDate": {
"description": "The end date for this health status",
"format": "date-time",
"type": [
"string",
"null"
]
},
"message": {
"description": "Information about the health status",
"type": [
"string",
"null"
]
},
"startDate": {
"description": "The start date for this health status",
"format": "date-time",
"type": [
"string",
"null"
]
},
"status": {
"description": "The status of the class ValueTracker",
"type": [
"string",
"null"
]
}
},
"required": [
"endDate",
"message",
"startDate",
"status"
],
"type": "object"
}
],
"description": "The health of the model"
},
"name": {
"description": "Name of the class ValueTracker",
"type": "string"
},
"notes": {
"description": "User notes",
"type": [
"string",
"null"
]
},
"owner": {
"description": "DataRobot user information",
"properties": {
"firstName": {
"description": "First name of class ValueTracker owner",
"type": [
"string",
"null"
]
},
"id": {
"description": "The DR user ID",
"type": "string"
},
"lastName": {
"description": "Last of class ValueTracker owner",
"type": [
"string",
"null"
]
},
"username": {
"description": "Username of class ValueTracker owner",
"type": "string"
}
},
"required": [
"id"
],
"type": "object"
},
"permissions": {
"description": "Permissions of current user",
"items": {
"type": "string"
},
"type": "array"
},
"potentialValue": {
"description": "Optional, Contains MonetaryValue objects",
"properties": {
"currency": {
"description": "ISO code of currency",
"enum": [
"AED",
"BRL",
"CHF",
"EUR",
"GBP",
"JPY",
"KRW",
"UAH",
"USD",
"ZAR"
],
"type": "string"
},
"details": {
"description": "Optional user notes",
"type": [
"string",
"null"
]
},
"value": {
"description": "Amount of value",
"type": "number"
}
},
"required": [
"currency",
"value"
],
"type": "object"
},
"potentialValueTemplate": {
"anyOf": [
{
"properties": {
"data": {
"description": "class ValueTracker value data",
"properties": {
"accuracyImprovement": {
"description": "Accuracy improvement",
"type": "number"
},
"decisionsCount": {
"description": "Estimated number of decisions per year",
"type": "integer"
},
"incorrectDecisionCost": {
"description": "Estimated cost of an individual incorrect decision",
"type": "number"
},
"incorrectDecisionsCount": {
"description": "Estimated number of incorrect decisions per year",
"type": "integer"
}
},
"required": [
"accuracyImprovement",
"decisionsCount",
"incorrectDecisionCost",
"incorrectDecisionsCount"
],
"type": "object"
},
"templateType": {
"description": "class ValueTracker value template type",
"enum": [
"classification"
],
"type": "string"
}
},
"required": [
"data",
"templateType"
],
"type": "object"
},
{
"properties": {
"data": {
"description": "class ValueTracker value data",
"properties": {
"accuracyImprovement": {
"description": "Accuracy improvement",
"type": "number"
},
"decisionsCount": {
"description": "Estimated number of decisions per year",
"type": "integer"
},
"targetValue": {
"description": "Target value",
"type": "number"
}
},
"required": [
"accuracyImprovement",
"decisionsCount",
"targetValue"
],
"type": "object"
},
"templateType": {
"description": "class ValueTracker value template type",
"enum": [
"regression"
],
"type": "string"
}
},
"required": [
"data",
"templateType"
],
"type": "object"
}
],
"description": "Optional, Contains Template type and parameter information"
},
"predictionTargets": {
"description": "An array of strings prediction target names",
"items": {
"description": "The name of the prediction target",
"type": "string"
},
"type": "array"
},
"predictionsCount": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"description": "A list of prediction counts.",
"items": {
"type": "integer"
},
"type": "array"
}
],
"description": "Count of the number of predictions made."
},
"realizedValue": {
"anyOf": [
{
"type": "string"
},
{
"description": "Optional, Contains MonetaryValue objects",
"properties": {
"currency": {
"description": "ISO code of currency",
"enum": [
"AED",
"BRL",
"CHF",
"EUR",
"GBP",
"JPY",
"KRW",
"UAH",
"USD",
"ZAR"
],
"type": "string"
},
"details": {
"description": "Optional user notes",
"type": [
"string",
"null"
]
},
"value": {
"description": "Amount of value",
"type": "number"
}
},
"required": [
"currency",
"value"
],
"type": "object"
}
],
"description": "Optional, Contains MonetaryValue objects"
},
"serviceHealth": {
"anyOf": [
{
"type": "string"
},
{
"properties": {
"endDate": {
"description": "The end date for this health status",
"format": "date-time",
"type": [
"string",
"null"
]
},
"message": {
"description": "Information about the health status",
"type": [
"string",
"null"
]
},
"startDate": {
"description": "The start date for this health status",
"format": "date-time",
"type": [
"string",
"null"
]
},
"status": {
"description": "The status of the class ValueTracker",
"type": [
"string",
"null"
]
}
},
"required": [
"endDate",
"message",
"startDate",
"status"
],
"type": "object"
}
],
"description": "The health of the service"
},
"stage": {
"description": "Current stage of class ValueTracker",
"enum": [
"ideation",
"queued",
"dataPrepAndModeling",
"validatingAndDeploying",
"inProduction",
"retired",
"onHold"
],
"type": "string"
},
"targetDates": {
"description": "Array of TargetDate objects",
"items": {
"properties": {
"date": {
"description": "Date of the target",
"format": "date-time",
"type": "string"
},
"stage": {
"description": "Name of the target stage",
"enum": [
"ideation",
"queued",
"dataPrepAndModeling",
"validatingAndDeploying",
"inProduction",
"retired",
"onHold"
],
"type": "string"
}
},
"required": [
"date",
"stage"
],
"type": "object"
},
"type": "array"
}
},
"type": "object"
}
class ValueTracker information
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
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
continued
| Name |
Type |
Required |
Restrictions |
Description |
| name |
string |
false |
|
Name of the class ValueTracker |
| notes |
string,null |
false |
|
User notes |
| owner |
ValueTrackerDrUserId |
false |
|
DataRobot user information |
| permissions |
[string] |
false |
|
Permissions of current user |
| potentialValue |
ValueTrackerMonetaryValue |
false |
|
Optional, Contains MonetaryValue objects |
| potentialValueTemplate |
any |
false |
|
Optional, Contains Template type and parameter information |
anyOf
or
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] |
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
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] |
ValueTrackerDrUserId
{
"description": "DataRobot user information",
"properties": {
"firstName": {
"description": "First name of class ValueTracker owner",
"type": [
"string",
"null"
]
},
"id": {
"description": "The DR user ID",
"type": "string"
},
"lastName": {
"description": "Last of class ValueTracker owner",
"type": [
"string",
"null"
]
},
"username": {
"description": "Username of class ValueTracker owner",
"type": "string"
}
},
"required": [
"id"
],
"type": "object"
}
DataRobot user information
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
{
"description": "Details of the activity, content depends on activity type",
"properties": {
"businessImpact": {
"description": "Expected effects on overall business operations",
"maximum": 5,
"minimum": 1,
"type": [
"integer",
"null"
]
},
"commentId": {
"description": "The id for this comment",
"type": "string"
},
"content": {
"description": "A string",
"type": "string"
},
"description": {
"description": "class ValueTracker description",
"type": [
"string",
"null"
]
},
"feasibility": {
"description": "Assessment of how the class ValueTracker can be accomplished across multiple dimensions",
"maximum": 5,
"minimum": 1,
"type": [
"integer",
"null"
]
},
"id": {
"description": "The id of this description item",
"type": [
"string",
"null"
]
},
"mentions": {
"description": "A list of user objects",
"items": {
"description": "DataRobot user information",
"properties": {
"firstName": {
"description": "First name of class ValueTracker owner",
"type": [
"string",
"null"
]
},
"id": {
"description": "The DR user ID",
"type": "string"
},
"lastName": {
"description": "Last of class ValueTracker owner",
"type": [
"string",
"null"
]
},
"username": {
"description": "Username of class ValueTracker owner",
"type": "string"
}
},
"required": [
"id"
],
"type": "object"
},
"type": "array"
},
"name": {
"description": "The name of this event item",
"type": [
"string",
"null"
]
},
"notes": {
"description": "User notes",
"type": [
"string",
"null"
]
},
"owner": {
"description": "DataRobot user information",
"properties": {
"firstName": {
"description": "First name of class ValueTracker owner",
"type": [
"string",
"null"
]
},
"id": {
"description": "The DR user ID",
"type": "string"
},
"lastName": {
"description": "Last of class ValueTracker owner",
"type": [
"string",
"null"
]
},
"username": {
"description": "Username of class ValueTracker owner",
"type": "string"
}
},
"required": [
"id"
],
"type": "object"
},
"permissions": {
"description": "Permissions of current user",
"items": {
"type": "string"
},
"type": "array"
},
"potentialValue": {
"description": "Optional, Contains MonetaryValue objects",
"properties": {
"currency": {
"description": "ISO code of currency",
"enum": [
"AED",
"BRL",
"CHF",
"EUR",
"GBP",
"JPY",
"KRW",
"UAH",
"USD",
"ZAR"
],
"type": "string"
},
"details": {
"description": "Optional user notes",
"type": [
"string",
"null"
]
},
"value": {
"description": "Amount of value",
"type": "number"
}
},
"required": [
"currency",
"value"
],
"type": "object"
},
"potentialValueTemplate": {
"anyOf": [
{
"properties": {
"data": {
"description": "class ValueTracker value data",
"properties": {
"accuracyImprovement": {
"description": "Accuracy improvement",
"type": "number"
},
"decisionsCount": {
"description": "Estimated number of decisions per year",
"type": "integer"
},
"incorrectDecisionCost": {
"description": "Estimated cost of an individual incorrect decision",
"type": "number"
},
"incorrectDecisionsCount": {
"description": "Estimated number of incorrect decisions per year",
"type": "integer"
}
},
"required": [
"accuracyImprovement",
"decisionsCount",
"incorrectDecisionCost",
"incorrectDecisionsCount"
],
"type": "object"
},
"templateType": {
"description": "class ValueTracker value template type",
"enum": [
"classification"
],
"type": "string"
}
},
"required": [
"data",
"templateType"
],
"type": "object"
},
{
"properties": {
"data": {
"description": "class ValueTracker value data",
"properties": {
"accuracyImprovement": {
"description": "Accuracy improvement",
"type": "number"
},
"decisionsCount": {
"description": "Estimated number of decisions per year",
"type": "integer"
},
"targetValue": {
"description": "Target value",
"type": "number"
}
},
"required": [
"accuracyImprovement",
"decisionsCount",
"targetValue"
],
"type": "object"
},
"templateType": {
"description": "class ValueTracker value template type",
"enum": [
"regression"
],
"type": "string"
}
},
"required": [
"data",
"templateType"
],
"type": "object"
}
],
"description": "Optional, Contains Template type and parameter information"
},
"predictionTargets": {
"description": "An array of strings prediction target names",
"items": {
"description": "The name of the prediction target",
"type": "string"
},
"type": "array"
},
"realizedValue": {
"anyOf": [
{
"type": "string"
},
{
"description": "Optional, Contains MonetaryValue objects",
"properties": {
"currency": {
"description": "ISO code of currency",
"enum": [
"AED",
"BRL",
"CHF",
"EUR",
"GBP",
"JPY",
"KRW",
"UAH",
"USD",
"ZAR"
],
"type": "string"
},
"details": {
"description": "Optional user notes",
"type": [
"string",
"null"
]
},
"value": {
"description": "Amount of value",
"type": "number"
}
},
"required": [
"currency",
"value"
],
"type": "object"
}
],
"description": "Optional, Contains MonetaryValue objects"
},
"stage": {
"description": "Current stage of class ValueTracker",
"enum": [
"ideation",
"queued",
"dataPrepAndModeling",
"validatingAndDeploying",
"inProduction",
"retired",
"onHold"
],
"type": "string"
},
"targetDates": {
"description": "Array of TargetDate objects",
"items": {
"properties": {
"date": {
"description": "Date of the target",
"format": "date-time",
"type": "string"
},
"stage": {
"description": "Name of the target stage",
"enum": [
"ideation",
"queued",
"dataPrepAndModeling",
"validatingAndDeploying",
"inProduction",
"retired",
"onHold"
],
"type": "string"
}
},
"required": [
"date",
"stage"
],
"type": "object"
},
"type": "array"
}
},
"type": "object"
}
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 |
|
DataRobot user information |
| permissions |
[string] |
false |
|
Permissions of current user |
| potentialValue |
ValueTrackerMonetaryValue |
false |
|
Optional, Contains MonetaryValue objects |
| potentialValueTemplate |
any |
false |
|
Optional, Contains Template type and parameter information |
anyOf
or
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] |
{
"properties": {
"endDate": {
"description": "The end date for this health status",
"format": "date-time",
"type": [
"string",
"null"
]
},
"message": {
"description": "Information about the health status",
"type": [
"string",
"null"
]
},
"startDate": {
"description": "The start date for this health status",
"format": "date-time",
"type": [
"string",
"null"
]
},
"status": {
"description": "The status of the class ValueTracker",
"type": [
"string",
"null"
]
}
},
"required": [
"endDate",
"message",
"startDate",
"status"
],
"type": "object"
}
Properties
| Name |
Type |
Required |
Restrictions |
Description |
| endDate |
string,null(date-time) |
true |
|
The end date for this health status |
| message |
string,null |
true |
|
Information about the health status |
| startDate |
string,null(date-time) |
true |
|
The start date for this health status |
| status |
string,null |
true |
|
The status of the class ValueTracker |
ValueTrackerListResponse
{
"properties": {
"count": {
"description": "The number of items returned on this page",
"type": "integer"
},
"data": {
"description": "A list of the class ValueTrackers that match the query",
"items": {
"description": "class ValueTracker information",
"properties": {
"accuracyHealth": {
"anyOf": [
{
"type": "string"
},
{
"properties": {
"endDate": {
"description": "The end date for this health status",
"format": "date-time",
"type": [
"string",
"null"
]
},
"message": {
"description": "Information about the health status",
"type": [
"string",
"null"
]
},
"startDate": {
"description": "The start date for this health status",
"format": "date-time",
"type": [
"string",
"null"
]
},
"status": {
"description": "The status of the class ValueTracker",
"type": [
"string",
"null"
]
}
},
"required": [
"endDate",
"message",
"startDate",
"status"
],
"type": "object"
}
],
"description": "The health of the accuracy"
},
"businessImpact": {
"description": "Expected effects on overall business operations",
"maximum": 5,
"minimum": 1,
"type": [
"integer",
"null"
]
},
"commentId": {
"description": "The id for this comment",
"type": "string"
},
"content": {
"description": "A string",
"type": "string"
},
"description": {
"description": "class ValueTracker description",
"type": [
"string",
"null"
]
},
"feasibility": {
"description": "Assessment of how the class ValueTracker can be accomplished across multiple dimensions",
"maximum": 5,
"minimum": 1,
"type": [
"integer",
"null"
]
},
"id": {
"description": "The id of the class ValueTracker",
"type": "string"
},
"inProductionWarning": {
"description": "An optional warning to indicate that deployments are attached to this class ValueTracker.",
"type": [
"string",
"null"
]
},
"mentions": {
"description": "A list of user objects",
"items": {
"description": "DataRobot user information",
"properties": {
"firstName": {
"description": "First name of class ValueTracker owner",
"type": [
"string",
"null"
]
},
"id": {
"description": "The DR user ID",
"type": "string"
},
"lastName": {
"description": "Last of class ValueTracker owner",
"type": [
"string",
"null"
]
},
"username": {
"description": "Username of class ValueTracker owner",
"type": "string"
}
},
"required": [
"id"
],
"type": "object"
},
"type": "array"
},
"modelHealth": {
"anyOf": [
{
"type": "string"
},
{
"properties": {
"endDate": {
"description": "The end date for this health status",
"format": "date-time",
"type": [
"string",
"null"
]
},
"message": {
"description": "Information about the health status",
"type": [
"string",
"null"
]
},
"startDate": {
"description": "The start date for this health status",
"format": "date-time",
"type": [
"string",
"null"
]
},
"status": {
"description": "The status of the class ValueTracker",
"type": [
"string",
"null"
]
}
},
"required": [
"endDate",
"message",
"startDate",
"status"
],
"type": "object"
}
],
"description": "The health of the model"
},
"name": {
"description": "Name of the class ValueTracker",
"type": "string"
},
"notes": {
"description": "User notes",
"type": [
"string",
"null"
]
},
"owner": {
"description": "DataRobot user information",
"properties": {
"firstName": {
"description": "First name of class ValueTracker owner",
"type": [
"string",
"null"
]
},
"id": {
"description": "The DR user ID",
"type": "string"
},
"lastName": {
"description": "Last of class ValueTracker owner",
"type": [
"string",
"null"
]
},
"username": {
"description": "Username of class ValueTracker owner",
"type": "string"
}
},
"required": [
"id"
],
"type": "object"
},
"permissions": {
"description": "Permissions of current user",
"items": {
"type": "string"
},
"type": "array"
},
"potentialValue": {
"description": "Optional, Contains MonetaryValue objects",
"properties": {
"currency": {
"description": "ISO code of currency",
"enum": [
"AED",
"BRL",
"CHF",
"EUR",
"GBP",
"JPY",
"KRW",
"UAH",
"USD",
"ZAR"
],
"type": "string"
},
"details": {
"description": "Optional user notes",
"type": [
"string",
"null"
]
},
"value": {
"description": "Amount of value",
"type": "number"
}
},
"required": [
"currency",
"value"
],
"type": "object"
},
"potentialValueTemplate": {
"anyOf": [
{
"properties": {
"data": {
"description": "class ValueTracker value data",
"properties": {
"accuracyImprovement": {
"description": "Accuracy improvement",
"type": "number"
},
"decisionsCount": {
"description": "Estimated number of decisions per year",
"type": "integer"
},
"incorrectDecisionCost": {
"description": "Estimated cost of an individual incorrect decision",
"type": "number"
},
"incorrectDecisionsCount": {
"description": "Estimated number of incorrect decisions per year",
"type": "integer"
}
},
"required": [
"accuracyImprovement",
"decisionsCount",
"incorrectDecisionCost",
"incorrectDecisionsCount"
],
"type": "object"
},
"templateType": {
"description": "class ValueTracker value template type",
"enum": [
"classification"
],
"type": "string"
}
},
"required": [
"data",
"templateType"
],
"type": "object"
},
{
"properties": {
"data": {
"description": "class ValueTracker value data",
"properties": {
"accuracyImprovement": {
"description": "Accuracy improvement",
"type": "number"
},
"decisionsCount": {
"description": "Estimated number of decisions per year",
"type": "integer"
},
"targetValue": {
"description": "Target value",
"type": "number"
}
},
"required": [
"accuracyImprovement",
"decisionsCount",
"targetValue"
],
"type": "object"
},
"templateType": {
"description": "class ValueTracker value template type",
"enum": [
"regression"
],
"type": "string"
}
},
"required": [
"data",
"templateType"
],
"type": "object"
}
],
"description": "Optional, Contains Template type and parameter information"
},
"predictionTargets": {
"description": "An array of strings prediction target names",
"items": {
"description": "The name of the prediction target",
"type": "string"
},
"type": "array"
},
"predictionsCount": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"description": "A list of prediction counts.",
"items": {
"type": "integer"
},
"type": "array"
}
],
"description": "Count of the number of predictions made."
},
"realizedValue": {
"anyOf": [
{
"type": "string"
},
{
"description": "Optional, Contains MonetaryValue objects",
"properties": {
"currency": {
"description": "ISO code of currency",
"enum": [
"AED",
"BRL",
"CHF",
"EUR",
"GBP",
"JPY",
"KRW",
"UAH",
"USD",
"ZAR"
],
"type": "string"
},
"details": {
"description": "Optional user notes",
"type": [
"string",
"null"
]
},
"value": {
"description": "Amount of value",
"type": "number"
}
},
"required": [
"currency",
"value"
],
"type": "object"
}
],
"description": "Optional, Contains MonetaryValue objects"
},
"serviceHealth": {
"anyOf": [
{
"type": "string"
},
{
"properties": {
"endDate": {
"description": "The end date for this health status",
"format": "date-time",
"type": [
"string",
"null"
]
},
"message": {
"description": "Information about the health status",
"type": [
"string",
"null"
]
},
"startDate": {
"description": "The start date for this health status",
"format": "date-time",
"type": [
"string",
"null"
]
},
"status": {
"description": "The status of the class ValueTracker",
"type": [
"string",
"null"
]
}
},
"required": [
"endDate",
"message",
"startDate",
"status"
],
"type": "object"
}
],
"description": "The health of the service"
},
"stage": {
"description": "Current stage of class ValueTracker",
"enum": [
"ideation",
"queued",
"dataPrepAndModeling",
"validatingAndDeploying",
"inProduction",
"retired",
"onHold"
],
"type": "string"
},
"targetDates": {
"description": "Array of TargetDate objects",
"items": {
"properties": {
"date": {
"description": "Date of the target",
"format": "date-time",
"type": "string"
},
"stage": {
"description": "Name of the target stage",
"enum": [
"ideation",
"queued",
"dataPrepAndModeling",
"validatingAndDeploying",
"inProduction",
"retired",
"onHold"
],
"type": "string"
}
},
"required": [
"date",
"stage"
],
"type": "object"
},
"type": "array"
}
},
"type": "object"
},
"type": "array"
},
"next": {
"description": "URL pointing to the next page (if null, there is no next page)",
"format": "uri",
"type": [
"string",
"null"
]
},
"previous": {
"description": "URL pointing to the previous page (if null, there is no previous page)",
"format": "uri",
"type": [
"string",
"null"
]
},
"totalCount": {
"description": "The number of items matching the query condition",
"type": "integer"
}
},
"required": [
"count",
"data",
"next",
"previous",
"totalCount"
],
"type": "object"
}
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,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 number of items matching the query condition |
ValueTrackerMonetaryValue
{
"description": "Optional, Contains MonetaryValue objects",
"properties": {
"currency": {
"description": "ISO code of currency",
"enum": [
"AED",
"BRL",
"CHF",
"EUR",
"GBP",
"JPY",
"KRW",
"UAH",
"USD",
"ZAR"
],
"type": "string"
},
"details": {
"description": "Optional user notes",
"type": [
"string",
"null"
]
},
"value": {
"description": "Amount of value",
"type": "number"
}
},
"required": [
"currency",
"value"
],
"type": "object"
}
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 |
[AED, BRL, CHF, EUR, GBP, JPY, KRW, UAH, USD, ZAR] |
ValueTrackerRealizedValuesOverTimeResponse
{
"properties": {
"buckets": {
"description": "An array of `bucket` objects representing prediction totals and realized value over time",
"items": {
"properties": {
"period": {
"description": "A `period` object describing the time this bucket covers",
"properties": {
"end": {
"description": "RFC3339 datetime. End of time period to retrieve.",
"format": "date-time",
"type": "string"
},
"start": {
"description": "RFC3339 datetime. Start of time period to retrieve.",
"format": "date-time",
"type": "string"
}
},
"required": [
"end",
"start"
],
"type": "object"
},
"predictionsCount": {
"description": "Total number of predictions that happened in this bucket",
"type": "integer"
},
"realizedValue": {
"description": "Total amount of value realised during this bucket",
"type": "integer"
}
},
"required": [
"period",
"predictionsCount"
],
"type": "object"
},
"type": "array"
},
"previousTimeRangeSummary": {
"description": "A `summary` object covering the time range before the given one with the same duration",
"properties": {
"averagePredictionsCount": {
"description": "Average number of predictions per bucket during this time period",
"type": "integer"
},
"averageRealizedValue": {
"description": "Average amount of value per bucket realised during this time period",
"type": "integer"
},
"period": {
"description": "A `period` object describing the time this bucket covers",
"properties": {
"end": {
"description": "RFC3339 datetime. End of time period to retrieve.",
"format": "date-time",
"type": "string"
},
"start": {
"description": "RFC3339 datetime. Start of time period to retrieve.",
"format": "date-time",
"type": "string"
}
},
"required": [
"end",
"start"
],
"type": "object"
},
"totalPredictionsCount": {
"description": "Total number of predictions that happened during this time period",
"type": "integer"
},
"totalRealizedValue": {
"description": "Total amount of value realised during this time period",
"type": "integer"
}
},
"required": [
"averagePredictionsCount",
"period",
"totalRealizedValue"
],
"type": "object"
},
"summary": {
"description": "A `summary` object covering the time range before the given one with the same duration",
"properties": {
"averagePredictionsCount": {
"description": "Average number of predictions per bucket during this time period",
"type": "integer"
},
"averageRealizedValue": {
"description": "Average amount of value per bucket realised during this time period",
"type": "integer"
},
"period": {
"description": "A `period` object describing the time this bucket covers",
"properties": {
"end": {
"description": "RFC3339 datetime. End of time period to retrieve.",
"format": "date-time",
"type": "string"
},
"start": {
"description": "RFC3339 datetime. Start of time period to retrieve.",
"format": "date-time",
"type": "string"
}
},
"required": [
"end",
"start"
],
"type": "object"
},
"totalPredictionsCount": {
"description": "Total number of predictions that happened during this time period",
"type": "integer"
},
"totalRealizedValue": {
"description": "Total amount of value realised during this time period",
"type": "integer"
}
},
"required": [
"averagePredictionsCount",
"period",
"totalRealizedValue"
],
"type": "object"
}
},
"required": [
"buckets",
"previousTimeRangeSummary",
"summary"
],
"type": "object"
}
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
{
"description": "class ValueTracker information",
"properties": {
"accuracyHealth": {
"anyOf": [
{
"type": "string"
},
{
"properties": {
"endDate": {
"description": "The end date for this health status",
"format": "date-time",
"type": [
"string",
"null"
]
},
"message": {
"description": "Information about the health status",
"type": [
"string",
"null"
]
},
"startDate": {
"description": "The start date for this health status",
"format": "date-time",
"type": [
"string",
"null"
]
},
"status": {
"description": "The status of the class ValueTracker",
"type": [
"string",
"null"
]
}
},
"required": [
"endDate",
"message",
"startDate",
"status"
],
"type": "object"
}
],
"description": "The health of the accuracy"
},
"businessImpact": {
"description": "Expected effects on overall business operations",
"maximum": 5,
"minimum": 1,
"type": [
"integer",
"null"
]
},
"commentId": {
"description": "The id for this comment",
"type": "string"
},
"content": {
"description": "A string",
"type": "string"
},
"description": {
"description": "class ValueTracker description",
"type": [
"string",
"null"
]
},
"feasibility": {
"description": "Assessment of how the class ValueTracker can be accomplished across multiple dimensions",
"maximum": 5,
"minimum": 1,
"type": [
"integer",
"null"
]
},
"id": {
"description": "The id of the class ValueTracker",
"type": "string"
},
"inProductionWarning": {
"description": "An optional warning to indicate that deployments are attached to this class ValueTracker.",
"type": [
"string",
"null"
]
},
"mentions": {
"description": "A list of user objects",
"items": {
"description": "DataRobot user information",
"properties": {
"firstName": {
"description": "First name of class ValueTracker owner",
"type": [
"string",
"null"
]
},
"id": {
"description": "The DR user ID",
"type": "string"
},
"lastName": {
"description": "Last of class ValueTracker owner",
"type": [
"string",
"null"
]
},
"username": {
"description": "Username of class ValueTracker owner",
"type": "string"
}
},
"required": [
"id"
],
"type": "object"
},
"type": "array"
},
"modelHealth": {
"anyOf": [
{
"type": "string"
},
{
"properties": {
"endDate": {
"description": "The end date for this health status",
"format": "date-time",
"type": [
"string",
"null"
]
},
"message": {
"description": "Information about the health status",
"type": [
"string",
"null"
]
},
"startDate": {
"description": "The start date for this health status",
"format": "date-time",
"type": [
"string",
"null"
]
},
"status": {
"description": "The status of the class ValueTracker",
"type": [
"string",
"null"
]
}
},
"required": [
"endDate",
"message",
"startDate",
"status"
],
"type": "object"
}
],
"description": "The health of the model"
},
"name": {
"description": "Name of the class ValueTracker",
"type": "string"
},
"notes": {
"description": "User notes",
"type": [
"string",
"null"
]
},
"owner": {
"description": "DataRobot user information",
"properties": {
"firstName": {
"description": "First name of class ValueTracker owner",
"type": [
"string",
"null"
]
},
"id": {
"description": "The DR user ID",
"type": "string"
},
"lastName": {
"description": "Last of class ValueTracker owner",
"type": [
"string",
"null"
]
},
"username": {
"description": "Username of class ValueTracker owner",
"type": "string"
}
},
"required": [
"id"
],
"type": "object"
},
"permissions": {
"description": "Permissions of current user",
"items": {
"type": "string"
},
"type": "array"
},
"potentialValue": {
"description": "Optional, Contains MonetaryValue objects",
"properties": {
"currency": {
"description": "ISO code of currency",
"enum": [
"AED",
"BRL",
"CHF",
"EUR",
"GBP",
"JPY",
"KRW",
"UAH",
"USD",
"ZAR"
],
"type": "string"
},
"details": {
"description": "Optional user notes",
"type": [
"string",
"null"
]
},
"value": {
"description": "Amount of value",
"type": "number"
}
},
"required": [
"currency",
"value"
],
"type": "object"
},
"potentialValueTemplate": {
"anyOf": [
{
"properties": {
"data": {
"description": "class ValueTracker value data",
"properties": {
"accuracyImprovement": {
"description": "Accuracy improvement",
"type": "number"
},
"decisionsCount": {
"description": "Estimated number of decisions per year",
"type": "integer"
},
"incorrectDecisionCost": {
"description": "Estimated cost of an individual incorrect decision",
"type": "number"
},
"incorrectDecisionsCount": {
"description": "Estimated number of incorrect decisions per year",
"type": "integer"
}
},
"required": [
"accuracyImprovement",
"decisionsCount",
"incorrectDecisionCost",
"incorrectDecisionsCount"
],
"type": "object"
},
"templateType": {
"description": "class ValueTracker value template type",
"enum": [
"classification"
],
"type": "string"
}
},
"required": [
"data",
"templateType"
],
"type": "object"
},
{
"properties": {
"data": {
"description": "class ValueTracker value data",
"properties": {
"accuracyImprovement": {
"description": "Accuracy improvement",
"type": "number"
},
"decisionsCount": {
"description": "Estimated number of decisions per year",
"type": "integer"
},
"targetValue": {
"description": "Target value",
"type": "number"
}
},
"required": [
"accuracyImprovement",
"decisionsCount",
"targetValue"
],
"type": "object"
},
"templateType": {
"description": "class ValueTracker value template type",
"enum": [
"regression"
],
"type": "string"
}
},
"required": [
"data",
"templateType"
],
"type": "object"
}
],
"description": "Optional, Contains Template type and parameter information"
},
"predictionTargets": {
"description": "An array of strings prediction target names",
"items": {
"description": "The name of the prediction target",
"type": "string"
},
"type": "array"
},
"predictionsCount": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"description": "A list of prediction counts.",
"items": {
"type": "integer"
},
"type": "array"
}
],
"description": "Count of the number of predictions made."
},
"realizedValue": {
"anyOf": [
{
"type": "string"
},
{
"description": "Optional, Contains MonetaryValue objects",
"properties": {
"currency": {
"description": "ISO code of currency",
"enum": [
"AED",
"BRL",
"CHF",
"EUR",
"GBP",
"JPY",
"KRW",
"UAH",
"USD",
"ZAR"
],
"type": "string"
},
"details": {
"description": "Optional user notes",
"type": [
"string",
"null"
]
},
"value": {
"description": "Amount of value",
"type": "number"
}
},
"required": [
"currency",
"value"
],
"type": "object"
}
],
"description": "Optional, Contains MonetaryValue objects"
},
"serviceHealth": {
"anyOf": [
{
"type": "string"
},
{
"properties": {
"endDate": {
"description": "The end date for this health status",
"format": "date-time",
"type": [
"string",
"null"
]
},
"message": {
"description": "Information about the health status",
"type": [
"string",
"null"
]
},
"startDate": {
"description": "The start date for this health status",
"format": "date-time",
"type": [
"string",
"null"
]
},
"status": {
"description": "The status of the class ValueTracker",
"type": [
"string",
"null"
]
}
},
"required": [
"endDate",
"message",
"startDate",
"status"
],
"type": "object"
}
],
"description": "The health of the service"
},
"stage": {
"description": "Current stage of class ValueTracker",
"enum": [
"ideation",
"queued",
"dataPrepAndModeling",
"validatingAndDeploying",
"inProduction",
"retired",
"onHold"
],
"type": "string"
},
"targetDates": {
"description": "Array of TargetDate objects",
"items": {
"properties": {
"date": {
"description": "Date of the target",
"format": "date-time",
"type": "string"
},
"stage": {
"description": "Name of the target stage",
"enum": [
"ideation",
"queued",
"dataPrepAndModeling",
"validatingAndDeploying",
"inProduction",
"retired",
"onHold"
],
"type": "string"
}
},
"required": [
"date",
"stage"
],
"type": "object"
},
"type": "array"
}
},
"type": "object"
}
class ValueTracker information
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
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
continued
| Name |
Type |
Required |
Restrictions |
Description |
| name |
string |
false |
|
Name of the class ValueTracker |
| notes |
string,null |
false |
|
User notes |
| owner |
ValueTrackerDrUserId |
false |
|
DataRobot user information |
| permissions |
[string] |
false |
|
Permissions of current user |
| potentialValue |
ValueTrackerMonetaryValue |
false |
|
Optional, Contains MonetaryValue objects |
| potentialValueTemplate |
any |
false |
|
Optional, Contains Template type and parameter information |
anyOf
or
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] |
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
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] |
ValueTrackerSharingListData
{
"properties": {
"id": {
"description": "The ID of the recipient",
"type": "string"
},
"name": {
"description": "The name of the user, group, or organization",
"type": "string"
},
"role": {
"description": "The assigned role",
"enum": [
"OWNER",
"USER",
"CONSUMER",
"NO_ROLE"
],
"type": "string"
},
"shareRecipientType": {
"description": "The recipient type",
"enum": [
"user",
"group",
"organization"
],
"type": "string"
}
},
"required": [
"id",
"role",
"shareRecipientType"
],
"type": "object"
}
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
{
"properties": {
"count": {
"description": "The number of items returned on this page",
"type": "integer"
},
"data": {
"description": "A list of sharing role objects",
"items": {
"properties": {
"id": {
"description": "The ID of the recipient",
"type": "string"
},
"name": {
"description": "The name of the user, group, or organization",
"type": "string"
},
"role": {
"description": "The assigned role",
"enum": [
"OWNER",
"USER",
"CONSUMER",
"NO_ROLE"
],
"type": "string"
},
"shareRecipientType": {
"description": "The recipient type",
"enum": [
"user",
"group",
"organization"
],
"type": "string"
}
},
"required": [
"id",
"role",
"shareRecipientType"
],
"type": "object"
},
"type": "array"
},
"next": {
"description": "URL pointing to the next page (if null, there is no next page)",
"format": "uri",
"type": [
"string",
"null"
]
},
"previous": {
"description": "URL pointing to the previous page (if null, there is no previous page)",
"format": "uri",
"type": [
"string",
"null"
]
},
"totalCount": {
"description": "The number of items matching the query condition",
"type": "integer"
}
},
"required": [
"count",
"data",
"next",
"previous",
"totalCount"
],
"type": "object"
}
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,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 number of items matching the query condition |
ValueTrackerSharingRoleUpdateData
{
"properties": {
"id": {
"description": "The ID of the recipient",
"type": "string"
},
"role": {
"description": "The assigned role",
"enum": [
"OWNER",
"USER",
"CONSUMER",
"NO_ROLE"
],
"type": "string"
},
"shareRecipientType": {
"description": "The recipient type",
"enum": [
"user",
"group",
"organization"
],
"type": "string"
},
"username": {
"description": "The name of the user, group, or organization",
"type": "string"
}
},
"required": [
"role",
"shareRecipientType"
],
"type": "object"
}
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
{
"properties": {
"operation": {
"description": "The name of the action being taken. Only 'updateRoles' is supported.",
"enum": [
"updateRoles"
],
"type": "string"
},
"roles": {
"description": "A list of sharing role objects",
"items": {
"properties": {
"id": {
"description": "The ID of the recipient",
"type": "string"
},
"role": {
"description": "The assigned role",
"enum": [
"OWNER",
"USER",
"CONSUMER",
"NO_ROLE"
],
"type": "string"
},
"shareRecipientType": {
"description": "The recipient type",
"enum": [
"user",
"group",
"organization"
],
"type": "string"
},
"username": {
"description": "The name of the user, group, or organization",
"type": "string"
}
},
"required": [
"role",
"shareRecipientType"
],
"type": "object"
},
"type": "array"
}
},
"required": [
"operation",
"roles"
],
"type": "object"
}
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
{
"description": "A `summary` object covering the time range before the given one with the same duration",
"properties": {
"averagePredictionsCount": {
"description": "Average number of predictions per bucket during this time period",
"type": "integer"
},
"averageRealizedValue": {
"description": "Average amount of value per bucket realised during this time period",
"type": "integer"
},
"period": {
"description": "A `period` object describing the time this bucket covers",
"properties": {
"end": {
"description": "RFC3339 datetime. End of time period to retrieve.",
"format": "date-time",
"type": "string"
},
"start": {
"description": "RFC3339 datetime. Start of time period to retrieve.",
"format": "date-time",
"type": "string"
}
},
"required": [
"end",
"start"
],
"type": "object"
},
"totalPredictionsCount": {
"description": "Total number of predictions that happened during this time period",
"type": "integer"
},
"totalRealizedValue": {
"description": "Total amount of value realised during this time period",
"type": "integer"
}
},
"required": [
"averagePredictionsCount",
"period",
"totalRealizedValue"
],
"type": "object"
}
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
{
"properties": {
"date": {
"description": "Date of the target",
"format": "date-time",
"type": "string"
},
"stage": {
"description": "Name of the target stage",
"enum": [
"ideation",
"queued",
"dataPrepAndModeling",
"validatingAndDeploying",
"inProduction",
"retired",
"onHold"
],
"type": "string"
}
},
"required": [
"date",
"stage"
],
"type": "object"
}
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
{
"properties": {
"businessImpact": {
"description": "Expected effects on overall business operations",
"maximum": 5,
"minimum": 1,
"type": [
"integer",
"null"
]
},
"description": {
"description": "class ValueTracker description",
"maxLength": 1024,
"type": [
"string",
"null"
]
},
"feasibility": {
"description": "Assessment of how the class ValueTracker can be accomplished across multiple dimensions",
"maximum": 5,
"minimum": 1,
"type": [
"integer",
"null"
]
},
"name": {
"description": "Name of the class ValueTracker",
"maxLength": 512,
"type": "string"
},
"notes": {
"description": "User notes",
"maxLength": 1024,
"type": [
"string",
"null"
]
},
"owner": {
"description": "DataRobot user information",
"properties": {
"firstName": {
"description": "First name of class ValueTracker owner",
"type": [
"string",
"null"
]
},
"id": {
"description": "The DR user ID",
"type": "string"
},
"lastName": {
"description": "Last of class ValueTracker owner",
"type": [
"string",
"null"
]
},
"username": {
"description": "Username of class ValueTracker owner",
"type": "string"
}
},
"required": [
"id"
],
"type": "object"
},
"potentialValue": {
"description": "Optional, Contains MonetaryValue objects",
"properties": {
"currency": {
"description": "ISO code of currency",
"enum": [
"AED",
"BRL",
"CHF",
"EUR",
"GBP",
"JPY",
"KRW",
"UAH",
"USD",
"ZAR"
],
"type": "string"
},
"details": {
"description": "Optional user notes",
"type": [
"string",
"null"
]
},
"value": {
"description": "Amount of value",
"type": "number"
}
},
"required": [
"currency",
"value"
],
"type": "object"
},
"potentialValueTemplate": {
"anyOf": [
{
"properties": {
"data": {
"description": "class ValueTracker value data",
"properties": {
"accuracyImprovement": {
"description": "Accuracy improvement",
"type": "number"
},
"decisionsCount": {
"description": "Estimated number of decisions per year",
"type": "integer"
},
"incorrectDecisionCost": {
"description": "Estimated cost of an individual incorrect decision",
"type": "number"
},
"incorrectDecisionsCount": {
"description": "Estimated number of incorrect decisions per year",
"type": "integer"
}
},
"required": [
"accuracyImprovement",
"decisionsCount",
"incorrectDecisionCost",
"incorrectDecisionsCount"
],
"type": "object"
},
"templateType": {
"description": "class ValueTracker value template type",
"enum": [
"classification"
],
"type": "string"
}
},
"required": [
"data",
"templateType"
],
"type": "object"
},
{
"properties": {
"data": {
"description": "class ValueTracker value data",
"properties": {
"accuracyImprovement": {
"description": "Accuracy improvement",
"type": "number"
},
"decisionsCount": {
"description": "Estimated number of decisions per year",
"type": "integer"
},
"targetValue": {
"description": "Target value",
"type": "number"
}
},
"required": [
"accuracyImprovement",
"decisionsCount",
"targetValue"
],
"type": "object"
},
"templateType": {
"description": "class ValueTracker value template type",
"enum": [
"regression"
],
"type": "string"
}
},
"required": [
"data",
"templateType"
],
"type": "object"
}
],
"description": "Contains Template type and parameter information defined in the response of [GET /api/v2/valueTrackerValueTemplates/{templateType}/calculation/][get-apiv2valuetrackervaluetemplatestemplatetypecalculation]"
},
"predictionTargets": {
"description": "An array of strings prediction target names",
"items": {
"type": "string"
},
"type": "array"
},
"realizedValue": {
"description": "Optional, Contains MonetaryValue objects",
"properties": {
"currency": {
"description": "ISO code of currency",
"enum": [
"AED",
"BRL",
"CHF",
"EUR",
"GBP",
"JPY",
"KRW",
"UAH",
"USD",
"ZAR"
],
"type": "string"
},
"details": {
"description": "Optional user notes",
"type": [
"string",
"null"
]
},
"value": {
"description": "Amount of value",
"type": "number"
}
},
"required": [
"currency",
"value"
],
"type": "object"
},
"stage": {
"description": "Current stage of class ValueTracker",
"enum": [
"ideation",
"queued",
"dataPrepAndModeling",
"validatingAndDeploying",
"inProduction",
"retired",
"onHold"
],
"type": "string"
},
"targetDates": {
"description": "Array of TargetDate objects",
"items": {
"properties": {
"date": {
"description": "Date of the target",
"format": "date-time",
"type": "string"
},
"stage": {
"description": "Name of the target stage",
"enum": [
"ideation",
"queued",
"dataPrepAndModeling",
"validatingAndDeploying",
"inProduction",
"retired",
"onHold"
],
"type": "string"
}
},
"required": [
"date",
"stage"
],
"type": "object"
},
"type": "array"
}
},
"type": "object"
}
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 |
|
DataRobot user information |
| 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
or
continued
| Name |
Type |
Required |
Restrictions |
Description |
| predictionTargets |
[string] |
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] |
false |
|
Array of TargetDate objects |
Enumerated Values
| Property |
Value |
| stage |
[ideation, queued, dataPrepAndModeling, validatingAndDeploying, inProduction, retired, onHold] |
ValueTrackerValueCalculateTemplate
{
"description": "Template type and data used for calculating the result",
"properties": {
"data": {
"description": "Data used for calculating the result",
"oneOf": [
{
"description": "class ValueTracker value data",
"properties": {
"accuracyImprovement": {
"description": "Accuracy improvement",
"type": "number"
},
"decisionsCount": {
"description": "Estimated number of decisions per year",
"type": "integer"
},
"incorrectDecisionCost": {
"description": "Estimated cost of an individual incorrect decision",
"type": "number"
},
"incorrectDecisionsCount": {
"description": "Estimated number of incorrect decisions per year",
"type": "integer"
}
},
"required": [
"accuracyImprovement",
"decisionsCount",
"incorrectDecisionCost",
"incorrectDecisionsCount"
],
"type": "object"
},
{
"description": "class ValueTracker value data",
"properties": {
"accuracyImprovement": {
"description": "Accuracy improvement",
"type": "number"
},
"decisionsCount": {
"description": "Estimated number of decisions per year",
"type": "integer"
},
"targetValue": {
"description": "Target value",
"type": "number"
}
},
"required": [
"accuracyImprovement",
"decisionsCount",
"targetValue"
],
"type": "object"
}
]
},
"templateType": {
"description": "The name of the class ValueTracker value template",
"enum": [
"classification",
"regression"
],
"type": "string"
}
},
"required": [
"data",
"templateType"
],
"type": "object"
}
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
xor
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
{
"properties": {
"averageValuePerDecision": {
"description": "Estimated average value per decision",
"type": "number"
},
"savedAnnually": {
"description": "Estimated amount saved annually",
"type": "number"
},
"template": {
"description": "Template type and data used for calculating the result",
"properties": {
"data": {
"description": "Data used for calculating the result",
"oneOf": [
{
"description": "class ValueTracker value data",
"properties": {
"accuracyImprovement": {
"description": "Accuracy improvement",
"type": "number"
},
"decisionsCount": {
"description": "Estimated number of decisions per year",
"type": "integer"
},
"incorrectDecisionCost": {
"description": "Estimated cost of an individual incorrect decision",
"type": "number"
},
"incorrectDecisionsCount": {
"description": "Estimated number of incorrect decisions per year",
"type": "integer"
}
},
"required": [
"accuracyImprovement",
"decisionsCount",
"incorrectDecisionCost",
"incorrectDecisionsCount"
],
"type": "object"
},
{
"description": "class ValueTracker value data",
"properties": {
"accuracyImprovement": {
"description": "Accuracy improvement",
"type": "number"
},
"decisionsCount": {
"description": "Estimated number of decisions per year",
"type": "integer"
},
"targetValue": {
"description": "Target value",
"type": "number"
}
},
"required": [
"accuracyImprovement",
"decisionsCount",
"targetValue"
],
"type": "object"
}
]
},
"templateType": {
"description": "The name of the class ValueTracker value template",
"enum": [
"classification",
"regression"
],
"type": "string"
}
},
"required": [
"data",
"templateType"
],
"type": "object"
}
},
"required": [
"averageValuePerDecision",
"savedAnnually",
"template"
],
"type": "object"
}
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
{
"properties": {
"data": {
"description": "class ValueTracker value data",
"properties": {
"accuracyImprovement": {
"description": "Accuracy improvement",
"type": "number"
},
"decisionsCount": {
"description": "Estimated number of decisions per year",
"type": "integer"
},
"incorrectDecisionCost": {
"description": "Estimated cost of an individual incorrect decision",
"type": "number"
},
"incorrectDecisionsCount": {
"description": "Estimated number of incorrect decisions per year",
"type": "integer"
}
},
"required": [
"accuracyImprovement",
"decisionsCount",
"incorrectDecisionCost",
"incorrectDecisionsCount"
],
"type": "object"
},
"templateType": {
"description": "class ValueTracker value template type",
"enum": [
"classification"
],
"type": "string"
}
},
"required": [
"data",
"templateType"
],
"type": "object"
}
Properties
Enumerated Values
| Property |
Value |
| templateType |
classification |
ValueTrackerValueTemplateClassificationData
{
"description": "class ValueTracker value data",
"properties": {
"accuracyImprovement": {
"description": "Accuracy improvement",
"type": "number"
},
"decisionsCount": {
"description": "Estimated number of decisions per year",
"type": "integer"
},
"incorrectDecisionCost": {
"description": "Estimated cost of an individual incorrect decision",
"type": "number"
},
"incorrectDecisionsCount": {
"description": "Estimated number of incorrect decisions per year",
"type": "integer"
}
},
"required": [
"accuracyImprovement",
"decisionsCount",
"incorrectDecisionCost",
"incorrectDecisionsCount"
],
"type": "object"
}
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
{
"properties": {
"parameterName": {
"description": "Name of the parameter",
"type": "string"
},
"schema": {
"description": "Schema entry defining the type and limits of a template parameter",
"properties": {
"elementType": {
"description": "Possible types used for template variables",
"enum": [
"integer",
"float",
"number"
],
"type": "string"
},
"label": {
"description": "Label describing the represented value",
"type": "string"
},
"maximum": {
"description": "Sets Maximum value if given",
"type": [
"integer",
"null"
]
},
"minimum": {
"description": "Sets Minimum value if given",
"type": [
"integer",
"null"
]
},
"placeholder": {
"description": "Text that can be used to prefill an input filed for the value",
"type": "string"
},
"unit": {
"description": "Unit type. e.g. %",
"type": [
"string",
"null"
]
}
},
"required": [
"elementType",
"label",
"maximum",
"minimum",
"placeholder",
"unit"
],
"type": "object"
}
},
"required": [
"parameterName",
"schema"
],
"type": "object"
}
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
{
"properties": {
"data": {
"description": "class ValueTracker value data",
"properties": {
"accuracyImprovement": {
"description": "Accuracy improvement",
"type": "number"
},
"decisionsCount": {
"description": "Estimated number of decisions per year",
"type": "integer"
},
"targetValue": {
"description": "Target value",
"type": "number"
}
},
"required": [
"accuracyImprovement",
"decisionsCount",
"targetValue"
],
"type": "object"
},
"templateType": {
"description": "class ValueTracker value template type",
"enum": [
"regression"
],
"type": "string"
}
},
"required": [
"data",
"templateType"
],
"type": "object"
}
Properties
Enumerated Values
| Property |
Value |
| templateType |
regression |
ValueTrackerValueTemplateRegressionData
{
"description": "class ValueTracker value data",
"properties": {
"accuracyImprovement": {
"description": "Accuracy improvement",
"type": "number"
},
"decisionsCount": {
"description": "Estimated number of decisions per year",
"type": "integer"
},
"targetValue": {
"description": "Target value",
"type": "number"
}
},
"required": [
"accuracyImprovement",
"decisionsCount",
"targetValue"
],
"type": "object"
}
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
{
"properties": {
"description": {
"description": "Description of Value Template",
"type": "string"
},
"schema": {
"description": "Schema definition of all template parameters",
"items": {
"properties": {
"parameterName": {
"description": "Name of the parameter",
"type": "string"
},
"schema": {
"description": "Schema entry defining the type and limits of a template parameter",
"properties": {
"elementType": {
"description": "Possible types used for template variables",
"enum": [
"integer",
"float",
"number"
],
"type": "string"
},
"label": {
"description": "Label describing the represented value",
"type": "string"
},
"maximum": {
"description": "Sets Maximum value if given",
"type": [
"integer",
"null"
]
},
"minimum": {
"description": "Sets Minimum value if given",
"type": [
"integer",
"null"
]
},
"placeholder": {
"description": "Text that can be used to prefill an input filed for the value",
"type": "string"
},
"unit": {
"description": "Unit type. e.g. %",
"type": [
"string",
"null"
]
}
},
"required": [
"elementType",
"label",
"maximum",
"minimum",
"placeholder",
"unit"
],
"type": "object"
}
},
"required": [
"parameterName",
"schema"
],
"type": "object"
},
"type": "array"
},
"templateType": {
"description": "The name of the class ValueTracker value template to be retrieved",
"enum": [
"classification",
"regression"
],
"type": "string"
},
"title": {
"description": "Title of Value Template",
"type": "string"
}
},
"required": [
"description",
"schema",
"templateType",
"title"
],
"type": "object"
}
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
{
"description": "Schema entry defining the type and limits of a template parameter",
"properties": {
"elementType": {
"description": "Possible types used for template variables",
"enum": [
"integer",
"float",
"number"
],
"type": "string"
},
"label": {
"description": "Label describing the represented value",
"type": "string"
},
"maximum": {
"description": "Sets Maximum value if given",
"type": [
"integer",
"null"
]
},
"minimum": {
"description": "Sets Minimum value if given",
"type": [
"integer",
"null"
]
},
"placeholder": {
"description": "Text that can be used to prefill an input filed for the value",
"type": "string"
},
"unit": {
"description": "Unit type. e.g. %",
"type": [
"string",
"null"
]
}
},
"required": [
"elementType",
"label",
"maximum",
"minimum",
"placeholder",
"unit"
],
"type": "object"
}
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] |