Deployments¶
This page outlines the operations, endpoints, parameters, and example requests and responses for the Deployments.
GET /api/v2/deletedDeployments/¶
List deleted deployments.Only available as part of an enterprise (on-prem) installation. Requires a CAN_DELETE_APP_PROJECTS permission to execute.
Code samples¶
# You can also use wget
curl -X GET https://app.datarobot.com/api/v2/deletedDeployments/?offset=0&limit=20 \
-H "Accept: application/json" \
-H "Authorization: Bearer {access-token}"
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
offset | query | integer | true | The number of deleted deployments to skip. |
limit | query | integer | true | The number of deleted deployments to return. |
Example responses¶
200 Response
{
"count": 0,
"data": [
{
"deletedAt": "2019-08-24T14:15:22Z",
"id": "string",
"label": "string"
}
],
"next": "http://example.com",
"previous": "http://example.com"
}
Responses¶
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | The deleted deployments | DeletedDeploymentListResponse |
To perform this operation, you must be authenticated by means of one of the following methods:
BearerAuth
PATCH /api/v2/deletedDeployments/¶
Permanently erase data for deleted deployments. Only available as part of an on-premise or private/hybrid cloud deployment. Requires a CAN_DELETE_APP_PROJECTS permission to execute.
Code samples¶
# You can also use wget
curl -X PATCH https://app.datarobot.com/api/v2/deletedDeployments/ \
-H "Content-Type: application/json" \
-H "Authorization: Bearer {access-token}" \
-d '{DeploymentPermanentDelete}'
Body parameter¶
{
"action": "PermanentlyErase",
"deploymentIds": [
"string"
]
}
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
body | body | DeploymentPermanentDelete | false | none |
Responses¶
Status | Meaning | Description | Schema |
---|---|---|---|
202 | Accepted | Job submitted. See Location header. | None |
Response Headers¶
Status | Header | Type | Format | Description |
---|---|---|---|---|
202 | Location | string | URL for tracking deployment permanently erase job status. |
To perform this operation, you must be authenticated by means of one of the following methods:
BearerAuth
GET /api/v2/deployments/¶
List deployments a user can view.
Code samples¶
# You can also use wget
curl -X GET https://app.datarobot.com/api/v2/deployments/?offset=0&limit=20 \
-H "Accept: application/json" \
-H "Authorization: Bearer {access-token}"
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
offset | query | integer | true | The number of deployments to skip. Defaults to 0. |
limit | query | integer | true | The number of deployments (greater than zero, max 100) to return. Defaults to 20. |
orderBy | query | string | false | The order to sort the deployments.Defaults to order by deployment last prediction timestamp in descending order. |
search | query | string | false | Case insensitive search against deployment's label and description. |
serviceHealth | query | array[string] | false | Filters deployments by their service health status. |
modelHealth | query | array[string] | false | Filters deployments by their model health status. |
accuracyHealth | query | array[string] | false | Filters deployments by their accuracy health status. |
role | query | string | false | Filter deployments to only those that the authenticated user has the specified role for. |
status | query | array[string] | false | Filters deployments by their status |
importance | query | array[string] | false | Filters deployments by their importance |
lastPredictionTimestampStart | query | string(date-time) | false | Only include deployments that have had a prediction request on or after the specified timestamp. |
lastPredictionTimestampEnd | query | string(date-time) | false | Only include deployments that have had a prediction request before the specified timestamp. |
predictionUsageDailyAvgGreaterThan | query | integer | false | only include deployments that have had more than the specified number of predictions per day on average over the past week. |
predictionUsageDailyAvgLessThan | query | integer | false | Only include deployments that have had fewer than the specified number of predictions per day on average over the past week. |
defaultPredictionServerId | query | array[string] | false | Filter deployments to those whose default prediction server has the specified id. |
buildEnvironmentType | query | array[string] | false | Filter deployments based on the type of their current model's build environment type. |
executionEnvironmentType | query | array[string] | false | Filter deployments based on the type of their execution environment. |
predictionEnvironmentPlatform | query | array[string] | false | Filter deployments based on prediction environment platform |
createdByMe | query | string | false | Filter deployments to those created by the current user. |
createdBy | query | string | false | Filters deployments by those created by the given user. |
championModelExecutionType | query | string | false | Filter deployments by the execution type of the champion model. |
championModelTargetType | query | string | false | Filter deployments by the target type of the champion model. Example: Binary |
tagKeys | query | any | false | List of tag keys to filter for. If multiple values are specified, deployments with tags that match any of the values will be returned. |
tagValues | query | any | false | List of tag values to filter for. If multiple values are specified, deployments with tags that match any of the values will be returned. |
Enumerated Values¶
Parameter | Value |
---|---|
orderBy | [label , -label , serviceHealth , -serviceHealth , modelHealth , -modelHealth , accuracyHealth , -accuracyHealth , recentPredictions , -recentPredictions , lastPredictionTimestamp , -lastPredictionTimestamp , currentModelDeployedTimestamp , -currentModelDeployedTimestamp , createdAtTimestamp , -createdAtTimestamp , importance , -importance , fairnessHealth , -fairnessHealth , customMetricsHealth , -customMetricsHealth , actualsTimelinessHealth , -actualsTimelinessHealth , predictionsTimelinessHealth , -predictionsTimelinessHealth ] |
serviceHealth | [failing , not_started , passing , unavailable , unknown , warning ] |
modelHealth | [failing , not_started , passing , unavailable , unknown , warning ] |
accuracyHealth | [failing , not_started , passing , unavailable , unknown , warning ] |
role | [OWNER , USER ] |
status | [active , archived , errored , inactive , launching , replacingModel , stopping ] |
importance | [CRITICAL , HIGH , MODERATE , LOW ] |
buildEnvironmentType | [DataRobot , Python , R , Java , Julia , Legacy , Other ] |
executionEnvironmentType | [datarobot , external ] |
predictionEnvironmentPlatform | [aws , gcp , azure , onPremise , datarobot , datarobotServerless , openShift , other , snowflake , sapAiCore ] |
createdByMe | [false , False , true , True ] |
championModelExecutionType | [custom_inference_model , external , dedicated ] |
Example responses¶
200 Response
{
"count": 0,
"data": [
{
"accuracyHealth": {
"endDate": "2019-08-24T14:15:22Z",
"message": "string",
"startDate": "2019-08-24T14:15:22Z",
"status": "failing"
},
"approvalStatus": "PENDING",
"capabilities": {
"supportsAutomaticActuals": true,
"supportsChallengerModels": true,
"supportsFeatureDriftTracking": true,
"supportsFeatureTypeInfoValidation": true,
"supportsHumilityRecommendedRules": true,
"supportsHumilityRules": true,
"supportsHumilityRulesDefaultCalculations": true,
"supportsModelReplacement": true,
"supportsPortablePredictionServer": true,
"supportsPredictionIntervals": true,
"supportsPredictionWarning": true,
"supportsRetraining": true,
"supportsScoringCodeDownload": true,
"supportsSecondaryDatasets": true,
"supportsSegmentedAnalysisDriftAndAccuracy": true,
"supportsShapBasedPredictionExplanations": true,
"supportsTargetDriftTracking": true
},
"createdAt": "2019-08-24T14:15:22Z",
"defaultPredictionServer": {
"datarobot-key": "string",
"id": "string",
"url": "string"
},
"description": "string",
"governance": {
"approvalStatus": "PENDING",
"hasOpenedChangeRequests": true
},
"hasError": true,
"id": "string",
"importance": "CRITICAL",
"label": "string",
"model": {
"buildEnvironmentType": "string",
"customModelImage": {
"customModelId": "string",
"customModelName": "string",
"customModelVersionId": "string",
"customModelVersionLabel": "string",
"executionEnvironmentId": "string",
"executionEnvironmentName": "string",
"executionEnvironmentVersionId": "string",
"executionEnvironmentVersionLabel": "string"
},
"deployedAt": "2019-08-24T14:15:22Z",
"id": "string",
"isDeprecated": true,
"projectId": "string",
"projectName": "string",
"targetName": "string",
"targetType": "string",
"type": "string",
"unstructuredModelKind": true,
"unsupervisedMode": true,
"unsupervisedType": "anomaly"
},
"modelHealth": {
"endDate": "2019-08-24T14:15:22Z",
"message": "string",
"startDate": "2019-08-24T14:15:22Z",
"status": "failing"
},
"modelPackage": {
"id": "string",
"name": "string",
"registeredModelId": "string"
},
"modelPackageInitialDownload": {
"timestamp": "2019-08-24T14:15:22Z"
},
"openedChangeRequests": [
"string"
],
"owners": {
"count": 0,
"preview": [
{
"email": "string",
"firstName": "string",
"id": "string",
"lastName": "string"
}
]
},
"permissions": [
"CAN_ADD_CHALLENGERS"
],
"predictionEnvironment": {
"id": "string",
"isManagedByManagementAgent": true,
"name": "string",
"platform": "aws",
"plugin": "string",
"supportedModelFormats": [
"datarobot"
]
},
"predictionUsage": {
"dailyRates": [
0
],
"lastTimestamp": "2019-08-24T14:15:22Z"
},
"scoringCodeInitialDownload": {
"timestamp": "2019-08-24T14:15:22Z"
},
"serviceHealth": {
"endDate": "2019-08-24T14:15:22Z",
"startDate": "2019-08-24T14:15:22Z",
"status": "failing"
},
"settings": {
"batchMonitoringEnabled": true,
"humbleAiEnabled": true,
"predictionIntervalsEnabled": true,
"predictionWarningEnabled": true
},
"status": "active",
"tags": [
{
"id": "string",
"name": "string",
"value": "string"
}
],
"userProvidedId": "string"
}
],
"next": "http://example.com",
"previous": "http://example.com",
"totalCount": 0
}
Responses¶
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | The deployments | DeploymentListResponse |
To perform this operation, you must be authenticated by means of one of the following methods:
BearerAuth
POST /api/v2/deployments/fromLearningModel/¶
Create a deployment from a DataRobot model.
Code samples¶
# You can also use wget
curl -X POST https://app.datarobot.com/api/v2/deployments/fromLearningModel/ \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {access-token}" \
-d '{DeploymentCreateFromLearningModel}'
Body parameter¶
{
"defaultPredictionServerId": "string",
"description": null,
"grantInitialDeploymentRolesFromProject": true,
"importance": "CRITICAL",
"label": "string",
"modelId": "string",
"predictionThreshold": 1,
"status": "active"
}
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
body | body | DeploymentCreateFromLearningModel | false | none |
Example responses¶
202 Response
{
"id": "string"
}
Responses¶
Status | Meaning | Description | Schema |
---|---|---|---|
202 | Accepted | Deployment successfully created. | DeploymentCreateResponse |
403 | Forbidden | User does not have permission to create a deployment. | None |
409 | Conflict | User's organization has reached the maximum number of deployments. | None |
422 | Unprocessable Entity | Unable to process the deployment creation request. | None |
To perform this operation, you must be authenticated by means of one of the following methods:
BearerAuth
DELETE /api/v2/deployments/{deploymentId}/¶
Delete a deployment.
Code samples¶
# You can also use wget
curl -X DELETE https://app.datarobot.com/api/v2/deployments/{deploymentId}/ \
-H "Authorization: Bearer {access-token}"
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
ignoreManagementAgent | query | string | false | Do not wait for management agent to delete the deployment first. |
deploymentId | path | string | true | Unique identifier of the deployment. |
Enumerated Values¶
Parameter | Value |
---|---|
ignoreManagementAgent | [false , False , true , True ] |
Responses¶
Status | Meaning | Description | Schema |
---|---|---|---|
204 | No Content | Deployment successfully deleted. | None |
422 | Unprocessable Entity | Unable to process the request. | None |
To perform this operation, you must be authenticated by means of one of the following methods:
BearerAuth
GET /api/v2/deployments/{deploymentId}/¶
Retrieve a deployment.
Code samples¶
# You can also use wget
curl -X GET https://app.datarobot.com/api/v2/deployments/{deploymentId}/ \
-H "Accept: application/json" \
-H "Authorization: Bearer {access-token}"
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
deploymentId | path | string | true | Unique identifier of the deployment. |
Example responses¶
200 Response
{
"accuracyHealth": {
"endDate": "2019-08-24T14:15:22Z",
"message": "string",
"startDate": "2019-08-24T14:15:22Z",
"status": "failing"
},
"approvalStatus": "PENDING",
"capabilities": {
"supportsAutomaticActuals": true,
"supportsChallengerModels": true,
"supportsFeatureDriftTracking": true,
"supportsFeatureTypeInfoValidation": true,
"supportsHumilityRecommendedRules": true,
"supportsHumilityRules": true,
"supportsHumilityRulesDefaultCalculations": true,
"supportsModelReplacement": true,
"supportsPortablePredictionServer": true,
"supportsPredictionIntervals": true,
"supportsPredictionWarning": true,
"supportsRetraining": true,
"supportsScoringCodeDownload": true,
"supportsSecondaryDatasets": true,
"supportsSegmentedAnalysisDriftAndAccuracy": true,
"supportsShapBasedPredictionExplanations": true,
"supportsTargetDriftTracking": true
},
"createdAt": "2019-08-24T14:15:22Z",
"defaultPredictionServer": {
"datarobot-key": "string",
"id": "string",
"url": "string"
},
"description": "string",
"governance": {
"approvalStatus": "PENDING",
"hasOpenedChangeRequests": true
},
"hasError": true,
"id": "string",
"importance": "CRITICAL",
"label": "string",
"model": {
"buildEnvironmentType": "string",
"customModelImage": {
"customModelId": "string",
"customModelName": "string",
"customModelVersionId": "string",
"customModelVersionLabel": "string",
"executionEnvironmentId": "string",
"executionEnvironmentName": "string",
"executionEnvironmentVersionId": "string",
"executionEnvironmentVersionLabel": "string"
},
"deployedAt": "2019-08-24T14:15:22Z",
"id": "string",
"isDeprecated": true,
"projectId": "string",
"projectName": "string",
"targetName": "string",
"targetType": "string",
"type": "string",
"unstructuredModelKind": true,
"unsupervisedMode": true,
"unsupervisedType": "anomaly"
},
"modelHealth": {
"endDate": "2019-08-24T14:15:22Z",
"message": "string",
"startDate": "2019-08-24T14:15:22Z",
"status": "failing"
},
"modelPackage": {
"id": "string",
"name": "string",
"registeredModelId": "string"
},
"modelPackageInitialDownload": {
"timestamp": "2019-08-24T14:15:22Z"
},
"openedChangeRequests": [
"string"
],
"owners": {
"count": 0,
"preview": [
{
"email": "string",
"firstName": "string",
"id": "string",
"lastName": "string"
}
]
},
"permissions": [
"CAN_ADD_CHALLENGERS"
],
"predictionEnvironment": {
"id": "string",
"isManagedByManagementAgent": true,
"name": "string",
"platform": "aws",
"plugin": "string",
"supportedModelFormats": [
"datarobot"
]
},
"predictionUsage": {
"dailyRates": [
0
],
"lastTimestamp": "2019-08-24T14:15:22Z"
},
"scoringCodeInitialDownload": {
"timestamp": "2019-08-24T14:15:22Z"
},
"serviceHealth": {
"endDate": "2019-08-24T14:15:22Z",
"startDate": "2019-08-24T14:15:22Z",
"status": "failing"
},
"settings": {
"batchMonitoringEnabled": true,
"humbleAiEnabled": true,
"predictionIntervalsEnabled": true,
"predictionWarningEnabled": true
},
"status": "active",
"tags": [
{
"id": "string",
"name": "string",
"value": "string"
}
],
"userProvidedId": "string"
}
Responses¶
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | The deployment | DeploymentRetrieveResponse |
To perform this operation, you must be authenticated by means of one of the following methods:
BearerAuth
PATCH /api/v2/deployments/{deploymentId}/¶
Update a deployment's label and description.
Code samples¶
# You can also use wget
curl -X PATCH https://app.datarobot.com/api/v2/deployments/{deploymentId}/ \
-H "Content-Type: application/json" \
-H "Authorization: Bearer {access-token}" \
-d '{undefined}'
Body parameter¶
{
"description": "string",
"importance": "CRITICAL",
"label": "string"
}
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
deploymentId | path | string | true | Unique identifier of the deployment. |
body | body | DeploymentUpdate | false | none |
Responses¶
Status | Meaning | Description | Schema |
---|---|---|---|
204 | No Content | Deployment successfully updated | None |
To perform this operation, you must be authenticated by means of one of the following methods:
BearerAuth
GET /api/v2/deployments/{deploymentId}/accuracy/¶
Retrieve accuracy metric for a certain time period.
Code samples¶
# You can also use wget
curl -X GET https://app.datarobot.com/api/v2/deployments/{deploymentId}/accuracy/ \
-H "Accept: application/json" \
-H "Authorization: Bearer {access-token}"
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
start | query | string(date-time) | false | Start of the period to retrieve monitoring data, defaults to 7 days ago from the end of the period. Note: this field only accepts top of the hour RFC3339 datetime strings, for example: 2019-08-01T00:00:00Z . |
end | query | string(date-time) | false | End of the period to retrieve monitoring data, defaults to the next top of the hour. Note: this field only accepts top of the hour RFC3339 datetime strings, for example: 2019-08-01T00:00:00Z . |
modelId | query | string | false | The id of the model for which metrics are being retrieved. |
batchId | query | any | false | The id of the batch for which metrics are being retrieved. |
segmentAttribute | query | string | false | The name of the segment on which segment analysis is being performed. |
segmentValue | query | string | false | The value of the segmentAttribute to segment on. |
targetClasses | query | string | false | Comma separated list of target classes to filter out response |
targetClass | query | any | false | Target class to filter out results. |
deploymentId | path | string | true | Unique identifier of the deployment. |
Example responses¶
200 Response
{
"batchIds": [
"string"
],
"metrics": "\n {\"metrics\": {\n \"LogLoss\": {\n \"baselineValue\": 0.454221484838069,\n \"value\": 0.880778024500618,\n \"percentChange\": -93.91\n },\n \"AUC\": {\n \"baselineValue\": 0.8690358459556535,\n \"value\": 0.5294117647058824,\n \"percentChange\": -39.08\n },\n \"Kolmogorov-Smirnov\": {\n \"baselineValue\": 0.5753202944706626,\n \"value\": 0.4117647058823529,\n \"percentChange\": -28.43\n },\n \"Rate@Top10%\": {\n \"baselineValue\": 0.9603223806571606,\n \"value\": 1.0,\n \"percentChange\": 4.13\n },\n \"Gini Norm\": {\n \"baselineValue\": 0.7380716919113071,\n \"value\": 0.05882352941176472,\n \"percentChange\": -92.03\n }\n }\n ",
"modelId": "string",
"period": {
"end": "2019-08-24T14:15:22Z",
"start": "2019-08-24T14:15:22Z"
},
"segmentAttribute": "string",
"segmentValue": "",
"targetClasses": "string"
}
Responses¶
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Deployment accuracy metrics are retrieved. | AccuracyResponse |
To perform this operation, you must be authenticated by means of one of the following methods:
BearerAuth
GET /api/v2/deployments/{deploymentId}/accuracyOverBatch/¶
Retrieve accuracy metric baseline, and metric value calculated for each batch.
Code samples¶
# You can also use wget
curl -X GET https://app.datarobot.com/api/v2/deployments/{deploymentId}/accuracyOverBatch/ \
-H "Accept: application/json" \
-H "Authorization: Bearer {access-token}"
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
segmentAttribute | query | string | false | The name of the segment on which segment analysis is being performed. |
segmentValue | query | string | false | The value of the segmentAttribute to segment on. |
modelId | query | string | false | The id of the model for which metrics are being retrieved. |
batchId | query | any | false | The id of the batch for which metrics are being retrieved. |
metric | query | string | false | Accuracy metric being requested. |
deploymentId | path | string | true | Unique identifier of the deployment. |
Enumerated Values¶
Parameter | Value |
---|---|
metric | [AUC , Accuracy , Balanced Accuracy , F1 , FPR , FVE Binomial , FVE Gamma , FVE Poisson , FVE Tweedie , Gamma Deviance , Gini Norm , Kolmogorov-Smirnov , LogLoss , MAE , MAPE , MCC , NPV , PPV , Poisson Deviance , R Squared , RMSE , RMSLE , Rate@Top10% , Rate@Top5% , TNR , TPR , Tweedie Deviance ] |
Example responses¶
200 Response
{
"baselines": [
{
"metric": "string",
"modelId": "string",
"perClass": [
{
"className": "string",
"value": 0
}
],
"sampleSize": 0,
"value": 0
}
],
"buckets": [
{
"batchId": "string",
"batchName": "string",
"metric": "string",
"modelId": "string",
"perClass": [
{
"className": "string",
"value": 0
}
],
"period": {
"end": "2019-08-24T14:15:22Z",
"start": "2019-08-24T14:15:22Z"
},
"sampleSize": 0,
"value": 0
}
]
}
Responses¶
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Retrieve accuracy metrics over batches for a deployment. | AccuracyOverBatchResponse |
To perform this operation, you must be authenticated by means of one of the following methods:
BearerAuth
GET /api/v2/deployments/{deploymentId}/accuracyOverSpace/¶
Retrieve accuracy metric baseline, and metric value calculated for each geospatial h3 hexagon.
Code samples¶
# You can also use wget
curl -X GET https://app.datarobot.com/api/v2/deployments/{deploymentId}/accuracyOverSpace/ \
-H "Accept: application/json" \
-H "Authorization: Bearer {access-token}"
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
start | query | string(date-time) | false | Start of the period to retrieve monitoring data, defaults to 7 days ago from the end of the period. Note: this field only accepts top of the hour RFC3339 datetime strings, for example: 2019-08-01T00:00:00Z . |
end | query | string(date-time) | false | End of the period to retrieve monitoring data, defaults to the next top of the hour. Note: this field only accepts top of the hour RFC3339 datetime strings, for example: 2019-08-01T00:00:00Z . |
modelId | query | string | false | The ID of the model for which metrics are being retrieved. |
metric | query | string | false | Name of the metric. |
geoFeatureName | query | string | false | The name of the geospatial feature. |
deploymentId | path | string | true | Unique identifier of the deployment. |
Enumerated Values¶
Parameter | Value |
---|---|
metric | [AUC , Accuracy , Balanced Accuracy , F1 , FPR , FVE Binomial , FVE Gamma , FVE Multinomial , FVE Poisson , FVE Tweedie , Gamma Deviance , Gini Norm , Kolmogorov-Smirnov , LogLoss , MAD , MAE , MAPE , MCC , NPV , PPV , Poisson Deviance , R Squared , RMSE , RMSLE , Rate@Top10% , Rate@Top5% , TNR , TPR , Tweedie Deviance ] |
Example responses¶
200 Response
{
"baselines": [
{
"hexagon": "string",
"perClass": [
{
"className": "string",
"value": 0
}
],
"sampleSize": 0,
"value": 0
}
],
"buckets": [
{
"hexagon": "string",
"perClass": [
{
"className": "string",
"value": 0
}
],
"value": 0
}
],
"geoFeatureName": "string",
"metric": "AUC",
"modelId": "string",
"period": {
"end": "2019-08-24T14:15:22Z",
"start": "2019-08-24T14:15:22Z"
}
}
Responses¶
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Accuracy over space | AccuracyOverSpaceResponse |
To perform this operation, you must be authenticated by means of one of the following methods:
BearerAuth
GET /api/v2/deployments/{deploymentId}/accuracyOverTime/¶
Retrieve accuracy metric baseline, and metric value calculated for each time bucket dividing a longer time period.
Code samples¶
# You can also use wget
curl -X GET https://app.datarobot.com/api/v2/deployments/{deploymentId}/accuracyOverTime/ \
-H "Accept: application/json" \
-H "Authorization: Bearer {access-token}"
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
start | query | string(date-time) | false | Start of the period to retrieve monitoring data, defaults to 7 days ago from the end of the period. Note: this field only accepts top of the hour RFC3339 datetime strings, for example: 2019-08-01T00:00:00Z . |
end | query | string(date-time) | false | End of the period to retrieve monitoring data, defaults to the next top of the hour. Note: this field only accepts top of the hour RFC3339 datetime strings, for example: 2019-08-01T00:00:00Z . |
bucketSize | query | string(duration) | false | The time duration of a bucket. Needs to be multiple of one hour. Can not be longer than the total length of the period. If not set, a default value will be calculated based on the start and end time. |
modelId | query | any | false | The id of the models for which metrics are being retrieved. |
metric | query | string | false | Name of the metric. |
segmentAttribute | query | string | false | The name of the segment on which segment analysis is being performed. |
segmentValue | query | string | false | The value of the segmentAttribute to segment on. |
targetClasses | query | string | false | List of target classes to filter out response |
targetClass | query | any | false | Target class to filter out results. |
deploymentId | path | string | true | Unique identifier of the deployment. |
Enumerated Values¶
Parameter | Value |
---|---|
metric | [AUC , Accuracy , Balanced Accuracy , F1 , FPR , FVE Binomial , FVE Gamma , FVE Multinomial , FVE Poisson , FVE Tweedie , Gamma Deviance , Gini Norm , Kolmogorov-Smirnov , LogLoss , MAD , MAE , MAPE , MCC , NPV , PPV , Poisson Deviance , R Squared , RMSE , RMSLE , Rate@Top10% , Rate@Top5% , TNR , TPR , Tweedie Deviance ] |
Example responses¶
200 Response
{
"baseline": {
"period": {
"end": "2019-08-24T14:15:22Z",
"start": "2019-08-24T14:15:22Z"
},
"sampleSize": 0,
"value": 0,
"valuePerClass": "\n {\n \"class1\": 0.880778024500618,\n \"class2\": 0.5294117647058824,\n \"class3\": 0.4117647058823529\n }\n "
},
"baselines": [
{
"modelId": "string",
"perClass": [
{
"className": "string",
"value": 0
}
],
"sampleSize": 0,
"value": 0
}
],
"buckets": [
{
"modelId": "string",
"perClass": [
{
"className": "string",
"value": 0
}
],
"period": {
"end": "2019-08-24T14:15:22Z",
"start": "2019-08-24T14:15:22Z"
},
"sampleSize": 0,
"value": 0,
"valuePerClass": "\n {\n \"class1\": 0.880778024500618,\n \"class2\": 0.5294117647058824,\n \"class3\": 0.4117647058823529\n }\n "
}
],
"metric": "AUC",
"modelId": "string",
"segmentAttribute": "string",
"segmentValue": "",
"summary": {
"period": {
"end": "2019-08-24T14:15:22Z",
"start": "2019-08-24T14:15:22Z"
},
"sampleSize": 0,
"value": 0,
"valuePerClass": "\n {\n \"class1\": 0.880778024500618,\n \"class2\": 0.5294117647058824,\n \"class3\": 0.4117647058823529\n }\n "
}
}
Responses¶
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Accuracy over time. | AccuracyOverTimeResponse |
To perform this operation, you must be authenticated by means of one of the following methods:
BearerAuth
POST /api/v2/deployments/{deploymentId}/actuals/fromDataset/¶
Submit actuals values for processing using catalog item. Submission of actuals is limited to 10,000,000 actuals per hour. For time series deployments, total actuals = number of actuals * number of forecast distances. For example, submitting 10 actuals for a deployment with 50 forecast distances = 500 total actuals. For multiclass deployments, a similar calculation is made where total actuals = number of actuals * number of classes. For example, submitting 10 actuals for a deployment with 20 classes = 200 actuals.
Code samples¶
# You can also use wget
curl -X POST https://app.datarobot.com/api/v2/deployments/{deploymentId}/actuals/fromDataset/ \
-H "Content-Type: application/json" \
-H "Authorization: Bearer {access-token}" \
-d '{undefined}'
Body parameter¶
{
"actualValueColumn": "string",
"associationIdColumn": "string",
"datasetId": "string",
"datasetVersionId": "string",
"keepActualsWithoutPredictions": true,
"password": "string",
"timestampColumn": "string",
"user": "string",
"wasActedOnColumn": "string"
}
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
deploymentId | path | string | true | Unique identifier of the deployment. |
body | body | DeploymentDatasetCreate | false | none |
Responses¶
Status | Meaning | Description | Schema |
---|---|---|---|
202 | Accepted | Submitted successfully. See Location header. | None |
422 | Unprocessable Entity | Unable to process the Actuals submission request. | None |
429 | Too Many Requests | The number of actuals uploaded this hour exceeds the limit of 10000000 rows. | None |
Response Headers¶
Status | Header | Type | Format | Description |
---|---|---|---|---|
202 | Location | string | URL for tracking async job status. |
To perform this operation, you must be authenticated by means of one of the following methods:
BearerAuth
POST /api/v2/deployments/{deploymentId}/actuals/fromJSON/¶
Submit actuals values for processing. Values are not processed immediately and may take some time to propagate through deployment systems. Submission of actuals is limited to 10,000,000 actuals per hour. For time series deployments, total actuals = number of actuals * number of forecast distances. For example, submitting 10 actuals for a deployment with 50 forecast distances = 500 total actuals. For multiclass deployments, a similar calculation is made where total actuals = number of actuals * number of classes. For example, submitting 10 actuals for a deployment with 20 classes = 200 actuals.
Code samples¶
# You can also use wget
curl -X POST https://app.datarobot.com/api/v2/deployments/{deploymentId}/actuals/fromJSON/ \
-H "Content-Type: application/json" \
-H "Authorization: Bearer {access-token}" \
-d '{undefined}'
Body parameter¶
{
"data": [
{
"actualValue": 0,
"associationId": "string",
"timestamp": "2019-08-24T14:15:22Z",
"wasActedOn": true
}
],
"keepActualsWithoutPredictions": true
}
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
deploymentId | path | string | true | Unique identifier of the deployment. |
body | body | DeploymentActuals | false | none |
Responses¶
Status | Meaning | Description | Schema |
---|---|---|---|
202 | Accepted | Submitted successfully. See Location header. | None |
422 | Unprocessable Entity | Unable to process the Actuals submission request. | None |
429 | Too Many Requests | The number of actuals uploaded this hour exceeds the limit of 10000000 rows. | None |
Response Headers¶
Status | Header | Type | Format | Description |
---|---|---|---|---|
202 | Location | string | URL for tracking async job status. |
To perform this operation, you must be authenticated by means of one of the following methods:
BearerAuth
GET /api/v2/deployments/{deploymentId}/actualsDataExports/¶
Retrieve a list of asynchronous actuals data exports.
Code samples¶
# You can also use wget
curl -X GET https://app.datarobot.com/api/v2/deployments/{deploymentId}/actualsDataExports/ \
-H "Accept: application/json" \
-H "Authorization: Bearer {access-token}"
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
offset | query | integer | false | Offset this number of objects to retrieve. |
limit | query | integer | false | At most this number of objects to retrieve. |
status | query | string | false | An actuals data export state overwrite value. |
deploymentId | path | string | true | Unique identifier of the deployment. |
Enumerated Values¶
Parameter | Value |
---|---|
status | [CANCELLED , CREATED , FAILED , SCHEDULED , SUCCEEDED ] |
Example responses¶
200 Response
{
"count": 0,
"data": [
{
"createdAt": "2019-08-24T14:15:22Z",
"createdBy": {
"id": "string"
},
"data": [
{
"id": "string",
"name": "string"
}
],
"error": {
"message": "string"
},
"id": "string",
"modelId": "string",
"onlyMatchedPredictions": true,
"period": {
"end": "2019-08-24T14:15:22Z",
"start": "2019-08-24T14:15:22Z"
},
"status": "CANCELLED"
}
],
"next": "string",
"previous": "string",
"totalCount": 0
}
Responses¶
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Success | ActualsExportListResponse |
403 | Forbidden | User does not have permission to access a particular deployment. | None |
404 | Not Found | Resource not found. | None |
422 | Unprocessable Entity | Unable to process the actuals data exports list retrieval due to invalid parameter values. | None |
To perform this operation, you must be authenticated by means of one of the following methods:
BearerAuth
POST /api/v2/deployments/{deploymentId}/actualsDataExports/¶
Create a deployment actuals data export.
Code samples¶
# You can also use wget
curl -X POST https://app.datarobot.com/api/v2/deployments/{deploymentId}/actualsDataExports/ \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {access-token}" \
-d '{undefined}'
Body parameter¶
{
"end": "2019-08-24T14:15:22Z",
"modelId": "string",
"onlyMatchedPredictions": true,
"start": "2019-08-24T14:15:22Z"
}
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
deploymentId | path | string | true | Unique identifier of the deployment. |
body | body | ActualsExportCreatePayload | false | none |
Example responses¶
202 Response
{
"createdAt": "2019-08-24T14:15:22Z",
"createdBy": {
"id": "string"
},
"data": [
{
"id": "string",
"name": "string"
}
],
"error": {
"message": "string"
},
"id": "string",
"modelId": "string",
"onlyMatchedPredictions": true,
"period": {
"end": "2019-08-24T14:15:22Z",
"start": "2019-08-24T14:15:22Z"
},
"status": "CANCELLED"
}
Responses¶
Status | Meaning | Description | Schema |
---|---|---|---|
202 | Accepted | Actuals data export successfully created. | ActualsDataExportEntity |
403 | Forbidden | User does not have permission to create an actuals data export. | None |
404 | Not Found | Resource not found. | None |
422 | Unprocessable Entity | Unable to process the actuals data export creation request. | None |
To perform this operation, you must be authenticated by means of one of the following methods:
BearerAuth
DELETE /api/v2/deployments/{deploymentId}/actualsDataExports/{exportId}/¶
Delete an actual export.
Code samples¶
# You can also use wget
curl -X DELETE https://app.datarobot.com/api/v2/deployments/{deploymentId}/actualsDataExports/{exportId}/ \
-H "Authorization: Bearer {access-token}"
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
deploymentId | path | string | true | ID of the deployment. |
exportId | path | string | true | ID of the actuals data export job. |
Responses¶
Status | Meaning | Description | Schema |
---|---|---|---|
204 | No Content | An actual export was successfully deleted. | None |
403 | Forbidden | User does not have permission to delete an actual export. | None |
404 | Not Found | Actual export was not found. | None |
To perform this operation, you must be authenticated by means of one of the following methods:
BearerAuth
GET /api/v2/deployments/{deploymentId}/actualsDataExports/{exportId}/¶
Retrieve a single actuals data export.
Code samples¶
# You can also use wget
curl -X GET https://app.datarobot.com/api/v2/deployments/{deploymentId}/actualsDataExports/{exportId}/ \
-H "Accept: application/json" \
-H "Authorization: Bearer {access-token}"
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
deploymentId | path | string | true | ID of the deployment. |
exportId | path | string | true | ID of the actuals data export job. |
Example responses¶
200 Response
{
"createdAt": "2019-08-24T14:15:22Z",
"createdBy": {
"id": "string"
},
"data": [
{
"id": "string",
"name": "string"
}
],
"error": {
"message": "string"
},
"id": "string",
"modelId": "string",
"onlyMatchedPredictions": true,
"period": {
"end": "2019-08-24T14:15:22Z",
"start": "2019-08-24T14:15:22Z"
},
"status": "CANCELLED"
}
Responses¶
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | A given actuals data export user can view is retrieved. | ActualsDataExportEntity |
403 | Forbidden | User does not have permission to access a particular deployment or actuals data export. | None |
404 | Not Found | Resource not found. | None |
To perform this operation, you must be authenticated by means of one of the following methods:
BearerAuth
PATCH /api/v2/deployments/{deploymentId}/actualsDataExports/{exportId}/¶
Update actuals data export.
Code samples¶
# You can also use wget
curl -X PATCH https://app.datarobot.com/api/v2/deployments/{deploymentId}/actualsDataExports/{exportId}/ \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {access-token}" \
-d '{undefined}'
Body parameter¶
{
"status": "CANCELLED"
}
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
deploymentId | path | string | true | ID of the deployment. |
exportId | path | string | true | ID of the actuals data export job. |
body | body | ActualsDataUpdate | false | none |
Example responses¶
204 Response
{
"createdAt": "2019-08-24T14:15:22Z",
"createdBy": {
"id": "string"
},
"data": [
{
"id": "string",
"name": "string"
}
],
"error": {
"message": "string"
},
"id": "string",
"modelId": "string",
"onlyMatchedPredictions": true,
"period": {
"end": "2019-08-24T14:15:22Z",
"start": "2019-08-24T14:15:22Z"
},
"status": "CANCELLED"
}
Responses¶
Status | Meaning | Description | Schema |
---|---|---|---|
204 | No Content | Actuals data export updated. | ActualsDataExportEntity |
403 | Forbidden | User does not have permission to update the actuals data export. | None |
404 | Not Found | Requested resource does not exist or the user does not have permission to view it. | None |
422 | Unprocessable Entity | Unable to process the actuals data export update. | None |
To perform this operation, you must be authenticated by means of one of the following methods:
BearerAuth
GET /api/v2/deployments/{deploymentId}/batchServiceStats/¶
Retrieve all deployment service health metrics over a set of batches.
Code samples¶
# You can also use wget
curl -X GET https://app.datarobot.com/api/v2/deployments/{deploymentId}/batchServiceStats/ \
-H "Accept: application/json" \
-H "Authorization: Bearer {access-token}"
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
executionTimeQuantile | query | number | false | Quantile for executionTime metric. |
responseTimeQuantile | query | number | false | Quantile for responseTime metric. |
slowRequestsThreshold | query | integer | false | Threshold for slowRequests metric. |
segmentAttribute | query | string | false | The name of a segment attribute used for segment analysis. |
segmentValue | query | string | false | The value of the segmentAttribute to segment on. |
batchId | query | any | false | The id of the batch for which metrics are being retrieved. |
modelId | query | string | false | The id of the model for which metrics are being retrieved. |
deploymentId | path | string | true | Unique identifier of the deployment. |
Enumerated Values¶
Parameter | Value |
---|---|
segmentAttribute | [DataRobot-Consumer , DataRobot-Remote-IP , DataRobot-Host-IP ] |
Example responses¶
200 Response
{
"batches": [
{
"earliestPredictionTimestamp": "2019-08-24T14:15:22Z",
"id": "string",
"latestPredictionTimestamp": "2019-08-24T14:15:22Z",
"name": "string"
}
],
"metrics": {
"cacheHitRatio": 0,
"executionTime": 0,
"numConsumers": 0,
"responseTime": 0,
"serverErrorRate": 0,
"slowRequests": 0,
"totalPredictions": 0,
"totalRequests": 0,
"userErrorRate": 0
},
"segmentAttribute": "string",
"segmentValue": ""
}
Responses¶
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Service health metric data retrieved. | ServiceStatsForBatchRetrieveResponse |
To perform this operation, you must be authenticated by means of one of the following methods:
BearerAuth
GET /api/v2/deployments/{deploymentId}/capabilities/¶
Retrieve the capabilities for the deployment.
Code samples¶
# You can also use wget
curl -X GET https://app.datarobot.com/api/v2/deployments/{deploymentId}/capabilities/ \
-H "Accept: application/json" \
-H "Authorization: Bearer {access-token}"
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
deploymentId | path | string | true | Unique identifier of the deployment. |
Example responses¶
200 Response
{
"data": [
{
"messages": [
"string"
],
"name": "string",
"supported": true
}
]
}
Responses¶
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | none | DeploymentCapabilitiesRetrieveResponse |
To perform this operation, you must be authenticated by means of one of the following methods:
BearerAuth
POST /api/v2/deployments/{deploymentId}/challengerPredictions/¶
Score main model prediction requests against challenger model requests.
Code samples¶
# You can also use wget
curl -X POST https://app.datarobot.com/api/v2/deployments/{deploymentId}/challengerPredictions/ \
-H "Content-Type: application/json" \
-H "Authorization: Bearer {access-token}" \
-d '{undefined}'
Body parameter¶
{
"timestamp": "2019-08-24T14:15:22Z"
}
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
deploymentId | path | string | true | Unique identifier of the deployment. |
body | body | ChallengerScore | false | none |
Responses¶
Status | Meaning | Description | Schema |
---|---|---|---|
202 | Accepted | Job submitted. See Location header. | None |
422 | Unprocessable Entity | Unable to process the challenger scoring request. | None |
429 | Too Many Requests | Another challenger scoring job is running. See the Location header to track the running job. | None |
Response Headers¶
Status | Header | Type | Format | Description |
---|---|---|---|---|
202 | Location | string | URL to poll to track challenger scoring progress. |
To perform this operation, you must be authenticated by means of one of the following methods:
BearerAuth
GET /api/v2/deployments/{deploymentId}/challengerReplaySettings/¶
Retrieve challenger replay settings.
Code samples¶
# You can also use wget
curl -X GET https://app.datarobot.com/api/v2/deployments/{deploymentId}/challengerReplaySettings/ \
-H "Accept: application/json" \
-H "Authorization: Bearer {access-token}"
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
deploymentId | path | string | true | Unique identifier of the deployment. |
Example responses¶
200 Response
{
"enabled": true,
"schedule": {
"dayOfMonth": [
"*"
],
"dayOfWeek": [
"*"
],
"hour": [
"*"
],
"minute": [
"*"
],
"month": [
"*"
]
}
}
Responses¶
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Challenger replay settings. | ChallengersReplaySettings |
To perform this operation, you must be authenticated by means of one of the following methods:
BearerAuth
PATCH /api/v2/deployments/{deploymentId}/challengerReplaySettings/¶
Update challenger replay settings.
Code samples¶
# You can also use wget
curl -X PATCH https://app.datarobot.com/api/v2/deployments/{deploymentId}/challengerReplaySettings/ \
-H "Content-Type: application/json" \
-H "Authorization: Bearer {access-token}" \
-d '{undefined}'
Body parameter¶
{
"enabled": true,
"schedule": {
"dayOfMonth": [
"*"
],
"dayOfWeek": [
"*"
],
"hour": [
"*"
],
"minute": [
"*"
],
"month": [
"*"
]
}
}
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
deploymentId | path | string | true | Unique identifier of the deployment. |
body | body | ChallengersReplaySettings | false | none |
Responses¶
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Challenger replay settings updated. | None |
To perform this operation, you must be authenticated by means of one of the following methods:
BearerAuth
GET /api/v2/deployments/{deploymentId}/challengers/¶
List challenger models for deployment.
Code samples¶
# You can also use wget
curl -X GET https://app.datarobot.com/api/v2/deployments/{deploymentId}/challengers/ \
-H "Accept: application/json" \
-H "Authorization: Bearer {access-token}"
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
deploymentId | path | string | true | Unique identifier of the deployment. |
Example responses¶
200 Response
{
"data": [
{
"id": "string",
"model": {
"datasetName": "string",
"description": "string",
"executionType": "string",
"id": "string",
"isDeprecated": true,
"name": "string",
"projectId": "string",
"projectName": "string"
},
"modelPackage": {
"id": "string",
"name": "string",
"registeredModelId": "string"
},
"name": "string",
"predictionEnvironment": {
"id": "string",
"name": "string"
}
}
]
}
Responses¶
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | The challenger models | ChallengerListResponse |
To perform this operation, you must be authenticated by means of one of the following methods:
BearerAuth
POST /api/v2/deployments/{deploymentId}/challengers/¶
Create new challenger model.
Code samples¶
# You can also use wget
curl -X POST https://app.datarobot.com/api/v2/deployments/{deploymentId}/challengers/ \
-H "Content-Type: application/json" \
-H "Authorization: Bearer {access-token}" \
-d '{undefined}'
Body parameter¶
{
"modelPackageId": "string",
"name": "string",
"predictionEnvironmentId": "string"
}
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
deploymentId | path | string | true | Unique identifier of the deployment. |
body | body | ChallengerCreate | false | none |
Responses¶
Status | Meaning | Description | Schema |
---|---|---|---|
202 | Accepted | Job submitted successfully. See Location header. | None |
422 | Unprocessable Entity | Unable to process the challenger creation request. | None |
Response Headers¶
Status | Header | Type | Format | Description |
---|---|---|---|---|
202 | Location | string | URL to poll to track challenger creation has finished. |
To perform this operation, you must be authenticated by means of one of the following methods:
BearerAuth
DELETE /api/v2/deployments/{deploymentId}/challengers/{challengerId}/¶
Delete challenger model.
Code samples¶
# You can also use wget
curl -X DELETE https://app.datarobot.com/api/v2/deployments/{deploymentId}/challengers/{challengerId}/ \
-H "Authorization: Bearer {access-token}"
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
deploymentId | path | string | true | Unique identifier of the deployment. |
challengerId | path | string | true | Unique identifier of the challenger. |
Responses¶
Status | Meaning | Description | Schema |
---|---|---|---|
204 | No Content | Model successfully deleted. | None |
To perform this operation, you must be authenticated by means of one of the following methods:
BearerAuth
GET /api/v2/deployments/{deploymentId}/challengers/{challengerId}/¶
Retrieve challenger model.
Code samples¶
# You can also use wget
curl -X GET https://app.datarobot.com/api/v2/deployments/{deploymentId}/challengers/{challengerId}/ \
-H "Accept: application/json" \
-H "Authorization: Bearer {access-token}"
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
deploymentId | path | string | true | Unique identifier of the deployment. |
challengerId | path | string | true | Unique identifier of the challenger. |
Example responses¶
200 Response
{
"id": "string",
"model": {
"datasetName": "string",
"description": "string",
"executionType": "string",
"id": "string",
"isDeprecated": true,
"name": "string",
"projectId": "string",
"projectName": "string"
},
"modelPackage": {
"id": "string",
"name": "string",
"registeredModelId": "string"
},
"name": "string",
"predictionEnvironment": {
"id": "string",
"name": "string"
}
}
Responses¶
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | The challenger model | ChallengerResponse |
To perform this operation, you must be authenticated by means of one of the following methods:
BearerAuth
PATCH /api/v2/deployments/{deploymentId}/challengers/{challengerId}/¶
Update challenger model.
Code samples¶
# You can also use wget
curl -X PATCH https://app.datarobot.com/api/v2/deployments/{deploymentId}/challengers/{challengerId}/ \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {access-token}" \
-d '{undefined}'
Body parameter¶
{
"name": "string",
"predictionEnvironmentId": "string"
}
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
deploymentId | path | string | true | Unique identifier of the deployment. |
challengerId | path | string | true | Unique identifier of the challenger. |
body | body | ChallengerUpdate | false | none |
Example responses¶
200 Response
{
"id": "string",
"model": {
"datasetName": "string",
"description": "string",
"executionType": "string",
"id": "string",
"isDeprecated": true,
"name": "string",
"projectId": "string",
"projectName": "string"
},
"modelPackage": {
"id": "string",
"name": "string",
"registeredModelId": "string"
},
"name": "string",
"predictionEnvironment": {
"id": "string",
"name": "string"
}
}
Responses¶
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Model successfully updated. | ChallengerResponse |
To perform this operation, you must be authenticated by means of one of the following methods:
BearerAuth
GET /api/v2/deployments/{deploymentId}/championModelPackage/¶
Retrieve information about the champion model package
Code samples¶
# You can also use wget
curl -X GET https://app.datarobot.com/api/v2/deployments/{deploymentId}/championModelPackage/ \
-H "Accept: application/json" \
-H "Authorization: Bearer {access-token}"
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
deploymentId | path | string | true | Unique identifier of the deployment. |
Example responses¶
200 Response
{
"buildStatus": "inProgress",
"capabilities": {
"supportsAutomaticActuals": true,
"supportsChallengerModels": true,
"supportsFeatureDriftTracking": true,
"supportsHumilityRecommendedRules": true,
"supportsHumilityRules": true,
"supportsHumilityRulesDefaultCalculations": true,
"supportsPredictionWarning": true,
"supportsRetraining": true,
"supportsScoringCodeDownload": true,
"supportsSecondaryDatasets": true,
"supportsSegmentedAnalysisDriftAndAccuracy": true,
"supportsShapBasedPredictionExplanations": true,
"supportsTargetDriftTracking": true
},
"datasets": {
"baselineSegmentedBy": [
"string"
],
"datasetName": "string",
"holdoutDataCatalogId": "string",
"holdoutDataCatalogVersionId": "string",
"holdoutDataCreatedAt": "string",
"holdoutDataCreatorEmail": "string",
"holdoutDataCreatorId": null,
"holdoutDataCreatorName": "string",
"holdoutDatasetName": "string",
"targetHistogramBaseline": "predictions",
"trainingDataCatalogId": "string",
"trainingDataCatalogVersionId": "string",
"trainingDataCreatedAt": "string",
"trainingDataCreatorEmail": "string",
"trainingDataCreatorId": null,
"trainingDataCreatorName": "string",
"trainingDataSize": 0
},
"id": "string",
"importMeta": {
"containsFearPipeline": true,
"containsFeaturelists": true,
"containsLeaderboardMeta": true,
"containsProjectMeta": true,
"creatorFullName": "string",
"creatorId": "string",
"creatorUsername": "string",
"dateCreated": "string",
"originalFileName": "string"
},
"isArchived": true,
"isDeprecated": true,
"mlpkgFileContents": {
"allTimeSeriesPredictionIntervals": true
},
"modelDescription": {
"buildEnvironmentType": "DataRobot",
"description": "string",
"location": "string",
"modelCreatedAt": "string",
"modelCreatorEmail": "string",
"modelCreatorId": null,
"modelCreatorName": "string",
"modelName": "string"
},
"modelExecutionType": "dedicated",
"modelId": "string",
"modelKind": {
"isAnomalyDetectionModel": true,
"isCombinedModel": true,
"isFeatureDiscovery": true,
"isMultiseries": true,
"isTimeSeries": true,
"isUnsupervisedLearning": true
},
"name": "string",
"sourceMeta": {
"customModelDetails": {
"createdAt": "string",
"creatorEmail": "string",
"creatorId": "string",
"creatorName": "string",
"id": "string",
"versionLabel": "string"
},
"environmentUrl": "http://example.com",
"fips_140_2Enabled": true,
"projectCreatedAt": "string",
"projectCreatorEmail": "string",
"projectCreatorId": null,
"projectCreatorName": "string",
"projectId": "string",
"projectName": "string",
"scoringCode": {
"dataRobotPredictionVersion": "string",
"location": "local_leaderboard"
},
"useCaseDetails": {
"createdAt": "string",
"creatorEmail": "string",
"creatorId": "string",
"creatorName": "string",
"id": "string",
"name": "string"
}
},
"target": {
"classCount": 0,
"classNames": [
"string"
],
"name": "string",
"predictionProbabilitiesColumn": "string",
"predictionThreshold": 1,
"type": "Binary"
},
"timeseries": {
"datetimeColumnFormat": "string",
"datetimeColumnName": "string",
"effectiveFeatureDerivationWindowEnd": 0,
"effectiveFeatureDerivationWindowStart": 0,
"featureDerivationWindowEnd": 0,
"featureDerivationWindowStart": 0,
"forecastDistanceColumnName": "string",
"forecastDistances": [
0
],
"forecastDistancesTimeUnit": "MICROSECOND",
"forecastPointColumnName": "string",
"isCrossSeries": true,
"isNewSeriesSupport": true,
"isTraditionalTimeSeries": true,
"seriesColumnName": "string"
},
"updatedBy": {
"email": "string",
"id": "string",
"name": "string"
},
"userProvidedId": "string"
}
Responses¶
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Information retrieved successfully. | ModelPackageRetrieveResponseBase |
To perform this operation, you must be authenticated by means of one of the following methods:
BearerAuth
GET /api/v2/deployments/{deploymentId}/customMetrics/¶
Retrieve a list of custom metrics.
Code samples¶
# You can also use wget
curl -X GET https://app.datarobot.com/api/v2/deployments/{deploymentId}/customMetrics/ \
-H "Accept: application/json" \
-H "Authorization: Bearer {access-token}"
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
offset | query | integer | false | Offset this number of objects to retrieve |
limit | query | integer | false | At most this number of objects to retrieve |
deploymentId | path | string | true | Unique identifier of the deployment. |
Example responses¶
200 Response
{
"count": 0,
"data": [
{
"baselineValues": [
{
"value": 0
}
],
"createdAt": "2019-08-24T14:15:22Z",
"createdBy": {
"id": "string"
},
"description": "string",
"directionality": "higherIsBetter",
"displayChart": true,
"id": "string",
"isModelSpecific": true,
"name": "string",
"sampleCount": {
"columnName": "string"
},
"timeStep": "hour",
"timestamp": {
"columnName": "string",
"timeFormat": "%m/%d/%Y"
},
"type": "average",
"units": "string",
"value": {
"columnName": "string"
}
}
],
"next": "string",
"previous": "string",
"totalCount": 0
}
Responses¶
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Success | MetricListResponse |
403 | Forbidden | User does not have permission to access a particular deployment or create a custom metric. | None |
To perform this operation, you must be authenticated by means of one of the following methods:
BearerAuth
POST /api/v2/deployments/{deploymentId}/customMetrics/¶
Create a deployment custom metric.
Code samples¶
# You can also use wget
curl -X POST https://app.datarobot.com/api/v2/deployments/{deploymentId}/customMetrics/ \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {access-token}" \
-d '{undefined}'
Body parameter¶
{
"baselineValues": [
{
"value": 0
}
],
"description": "string",
"directionality": "higherIsBetter",
"isModelSpecific": true,
"name": "string",
"sampleCount": {
"columnName": "string"
},
"timeStep": "hour",
"timestamp": {
"columnName": "string",
"timeFormat": "%m/%d/%Y"
},
"type": "average",
"units": "string",
"value": {
"columnName": "string"
}
}
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
deploymentId | path | string | true | Unique identifier of the deployment. |
body | body | MetricCreatePayload | false | none |
Example responses¶
201 Response
{
"baselineValues": [
{
"value": 0
}
],
"createdAt": "2019-08-24T14:15:22Z",
"createdBy": {
"id": "string"
},
"description": "string",
"directionality": "higherIsBetter",
"displayChart": true,
"id": "string",
"isModelSpecific": true,
"name": "string",
"sampleCount": {
"columnName": "string"
},
"timeStep": "hour",
"timestamp": {
"columnName": "string",
"timeFormat": "%m/%d/%Y"
},
"type": "average",
"units": "string",
"value": {
"columnName": "string"
}
}
Responses¶
Status | Meaning | Description | Schema |
---|---|---|---|
201 | Created | Custom metric is successfully created. | MetricEntity |
403 | Forbidden | User does not have permission to create a custom metric. | None |
To perform this operation, you must be authenticated by means of one of the following methods:
BearerAuth
POST /api/v2/deployments/{deploymentId}/customMetrics/fromCustomJob/¶
Create a deployment custom metric from an existing custom job.
Code samples¶
# You can also use wget
curl -X POST https://app.datarobot.com/api/v2/deployments/{deploymentId}/customMetrics/fromCustomJob/ \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {access-token}" \
-d '{undefined}'
Body parameter¶
{
"baselineValues": [
{
"value": 0
}
],
"customJobId": "string",
"description": "",
"name": "string",
"sampleCount": {
"columnName": "string"
},
"schedule": {
"dayOfMonth": [
"*"
],
"dayOfWeek": [
"*"
],
"hour": [
"*"
],
"minute": [
"*"
],
"month": [
"*"
]
},
"timestamp": {
"columnName": "string",
"timeFormat": "%m/%d/%Y"
},
"value": {
"columnName": "string"
}
}
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
deploymentId | path | string | true | Unique identifier of the deployment. |
body | body | MetricCreateFromCustomJob | false | none |
Example responses¶
201 Response
{
"baselineValues": [
{
"value": 0
}
],
"createdAt": "2019-08-24T14:15:22Z",
"deployment": {
"createdAt": "2019-08-24T14:15:22Z",
"creatorFirstName": "string",
"creatorGravatarHash": "string",
"creatorLastName": "string",
"creatorUsername": "string",
"id": "string",
"name": "string"
},
"description": "",
"directionality": "higherIsBetter",
"id": "string",
"isModelSpecific": true,
"name": "string",
"sampleCount": {
"columnName": "string"
},
"schedule": {
"dayOfMonth": [
"*"
],
"dayOfWeek": [
"*"
],
"hour": [
"*"
],
"minute": [
"*"
],
"month": [
"*"
]
},
"timeStep": "hour",
"timestamp": {
"columnName": "string",
"timeFormat": "%m/%d/%Y"
},
"type": "average",
"units": "string",
"value": {
"columnName": "string"
}
}
Responses¶
Status | Meaning | Description | Schema |
---|---|---|---|
201 | Created | Custom metric is successfully created. | MetricCreateFromCustomJobResponse |
403 | Forbidden | User does not have permission to create a custom metric. | None |
To perform this operation, you must be authenticated by means of one of the following methods:
BearerAuth
DELETE /api/v2/deployments/{deploymentId}/customMetrics/{customMetricId}/¶
Delete a custom metric.
Code samples¶
# You can also use wget
curl -X DELETE https://app.datarobot.com/api/v2/deployments/{deploymentId}/customMetrics/{customMetricId}/ \
-H "Authorization: Bearer {access-token}"
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
deploymentId | path | string | true | ID of the deployment |
customMetricId | path | string | true | ID of the custom metric |
Responses¶
Status | Meaning | Description | Schema |
---|---|---|---|
204 | No Content | A custom metric was successfully deleted. | None |
403 | Forbidden | User does not have permission to delete a custom metric. | None |
404 | Not Found | Custom metric was not found. | None |
To perform this operation, you must be authenticated by means of one of the following methods:
BearerAuth
GET /api/v2/deployments/{deploymentId}/customMetrics/{customMetricId}/¶
Retrieve a single custom metric metadata.
Code samples¶
# You can also use wget
curl -X GET https://app.datarobot.com/api/v2/deployments/{deploymentId}/customMetrics/{customMetricId}/ \
-H "Accept: application/json" \
-H "Authorization: Bearer {access-token}"
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
deploymentId | path | string | true | ID of the deployment |
customMetricId | path | string | true | ID of the custom metric |
Example responses¶
200 Response
{
"baselineValues": [
{
"value": 0
}
],
"createdAt": "2019-08-24T14:15:22Z",
"createdBy": {
"id": "string"
},
"description": "string",
"directionality": "higherIsBetter",
"displayChart": true,
"id": "string",
"isModelSpecific": true,
"name": "string",
"sampleCount": {
"columnName": "string"
},
"timeStep": "hour",
"timestamp": {
"columnName": "string",
"timeFormat": "%m/%d/%Y"
},
"type": "average",
"units": "string",
"value": {
"columnName": "string"
}
}
Responses¶
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | A given custom metric metadata. | MetricEntity |
403 | Forbidden | User does not have permission to access a particular deployment or custom metric metadata. | None |
To perform this operation, you must be authenticated by means of one of the following methods:
BearerAuth
PATCH /api/v2/deployments/{deploymentId}/customMetrics/{customMetricId}/¶
Update given custom metric settings.
Code samples¶
# You can also use wget
curl -X PATCH https://app.datarobot.com/api/v2/deployments/{deploymentId}/customMetrics/{customMetricId}/ \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {access-token}" \
-d '{undefined}'
Body parameter¶
{
"baselineValues": [
{
"value": 0
}
],
"batch": {
"columnName": "string"
},
"description": "string",
"directionality": "higherIsBetter",
"name": "string",
"sampleCount": {
"columnName": "string"
},
"timestamp": {
"columnName": "string",
"timeFormat": "%m/%d/%Y"
},
"type": "average",
"units": "string",
"value": {
"columnName": "string"
}
}
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
deploymentId | path | string | true | ID of the deployment |
customMetricId | path | string | true | ID of the custom metric |
body | body | MetricUpdatePayload | false | none |
Example responses¶
200 Response
{
"baselineValues": [
{
"value": 0
}
],
"createdAt": "2019-08-24T14:15:22Z",
"createdBy": {
"id": "string"
},
"description": "string",
"directionality": "higherIsBetter",
"displayChart": true,
"id": "string",
"isModelSpecific": true,
"name": "string",
"sampleCount": {
"columnName": "string"
},
"timeStep": "hour",
"timestamp": {
"columnName": "string",
"timeFormat": "%m/%d/%Y"
},
"type": "average",
"units": "string",
"value": {
"columnName": "string"
}
}
Responses¶
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Custom metric settings updated. | MetricEntity |
403 | Forbidden | User does not have permission to update the custom metric. | None |
To perform this operation, you must be authenticated by means of one of the following methods:
BearerAuth
GET /api/v2/deployments/{deploymentId}/customMetrics/{customMetricId}/batchSummary/¶
Retrieve the summary of deployment batch custom metric.
Code samples¶
# You can also use wget
curl -X GET https://app.datarobot.com/api/v2/deployments/{deploymentId}/customMetrics/{customMetricId}/batchSummary/ \
-H "Accept: application/json" \
-H "Authorization: Bearer {access-token}"
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
start | query | string(date-time) | false | Start of the period to retrieve monitoring stats, defaults to 7 days ago from the end of the period. |
end | query | string(date-time) | false | End of the period to retrieve monitoring stats, defaults to the next top of the hour from now. |
modelPackageId | query | string | false | The model package ID of related champion/challenger to retrieve custom metric values for. |
modelId | query | string | false | The model ID of related champion/challenger to retrieve custom metric values for. |
batchId | query | any | false | The id of the batch for which metrics are being retrieved. |
deploymentId | path | string | true | ID of the deployment |
customMetricId | path | string | true | ID of the custom metric |
Example responses¶
200 Response
{
"metric": {
"baselineValue": 0,
"id": "string",
"name": "string",
"percentChange": 0,
"sampleCount": 0,
"unknownCategoriesCount": 0,
"value": 0
}
}
Responses¶
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Summary retrieved successfully. | CustomMetricBatchSummary |
403 | Forbidden | User does not have permission to read the custom metric summary. | None |
To perform this operation, you must be authenticated by means of one of the following methods:
BearerAuth
POST /api/v2/deployments/{deploymentId}/customMetrics/{customMetricId}/fromDataset/¶
Upload custom metric values from dataset.
Code samples¶
# You can also use wget
curl -X POST https://app.datarobot.com/api/v2/deployments/{deploymentId}/customMetrics/{customMetricId}/fromDataset/ \
-H "Content-Type: application/json" \
-H "Authorization: Bearer {access-token}" \
-d '{undefined}'
Body parameter¶
{
"associationId": {
"columnName": "string"
},
"batch": {
"columnName": "string"
},
"datasetId": "string",
"modelId": null,
"modelPackageId": null,
"sampleCount": {
"columnName": "string"
},
"segments": [
{
"column": "string",
"name": "string"
}
],
"timestamp": {
"columnName": "string",
"timeFormat": "%m/%d/%Y"
},
"value": {
"columnName": "string"
}
}
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
deploymentId | path | string | true | ID of the deployment |
customMetricId | path | string | true | ID of the custom metric |
body | body | MetricValuesFromDatasetPayload | false | none |
Responses¶
Status | Meaning | Description | Schema |
---|---|---|---|
202 | Accepted | Custom metric values import started | None |
403 | Forbidden | User does not have permission to import custom metric values. | None |
To perform this operation, you must be authenticated by means of one of the following methods:
BearerAuth
POST /api/v2/deployments/{deploymentId}/customMetrics/{customMetricId}/fromJSON/¶
Upload custom metric values from JSON.
Code samples¶
# You can also use wget
curl -X POST https://app.datarobot.com/api/v2/deployments/{deploymentId}/customMetrics/{customMetricId}/fromJSON/ \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {access-token}" \
-d '{undefined}'
Body parameter¶
{
"buckets": [
{
"sampleSize": 1,
"timestamp": "2019-08-24T14:15:22Z",
"value": 0
}
],
"dryRun": false,
"modelId": null,
"modelPackageId": null
}
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
deploymentId | path | string | true | ID of the deployment |
customMetricId | path | string | true | ID of the custom metric |
body | body | MetricValuesFromJSONPayload | false | none |
Example responses¶
202 Response
{
"baselineValues": [
{
"value": 0
}
],
"createdAt": "2019-08-24T14:15:22Z",
"createdBy": {
"id": "string"
},
"description": "string",
"directionality": "higherIsBetter",
"displayChart": true,
"id": "string",
"isModelSpecific": true,
"name": "string",
"sampleCount": {
"columnName": "string"
},
"timeStep": "hour",
"timestamp": {
"columnName": "string",
"timeFormat": "%m/%d/%Y"
},
"type": "average",
"units": "string",
"value": {
"columnName": "string"
}
}
Responses¶
Status | Meaning | Description | Schema |
---|---|---|---|
202 | Accepted | Custom metric values import started | MetricEntity |
403 | Forbidden | User does not have permission to import custom metric values. | None |
To perform this operation, you must be authenticated by means of one of the following methods:
BearerAuth
GET /api/v2/deployments/{deploymentId}/customMetrics/{customMetricId}/summary/¶
Retrieve the summary of deployment custom metric.
Code samples¶
# You can also use wget
curl -X GET https://app.datarobot.com/api/v2/deployments/{deploymentId}/customMetrics/{customMetricId}/summary/ \
-H "Accept: application/json" \
-H "Authorization: Bearer {access-token}"
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
start | query | string(date-time) | false | Start of the period to retrieve monitoring stats, defaults to 7 days ago from the end of the period. |
end | query | string(date-time) | false | End of the period to retrieve monitoring stats, defaults to the next top of the hour from now. |
modelPackageId | query | string | false | The model package ID of related champion/challenger to retrieve custom metric values for. |
modelId | query | string | false | The model ID of related champion/challenger to retrieve custom metric values for. |
batchId | query | any | false | The id of the batch for which metrics are being retrieved. |
deploymentId | path | string | true | ID of the deployment |
customMetricId | path | string | true | ID of the custom metric |
Example responses¶
200 Response
{
"metric": {
"baselineValue": 0,
"id": "string",
"name": "string",
"percentChange": 0,
"sampleCount": 0,
"unknownCategoriesCount": 0,
"value": 0
},
"period": {
"end": "2019-08-24T14:15:22Z",
"start": "2019-08-24T14:15:22Z"
}
}
Responses¶
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Summary retrieved successfully. | CustomMetricSummary |
403 | Forbidden | User does not have permission to read the custom metric summary. | None |
To perform this operation, you must be authenticated by means of one of the following methods:
BearerAuth
GET /api/v2/deployments/{deploymentId}/customMetrics/{customMetricId}/valuesOverBatch/¶
Retrieve custom metric values over batch.
Code samples¶
# You can also use wget
curl -X GET https://app.datarobot.com/api/v2/deployments/{deploymentId}/customMetrics/{customMetricId}/valuesOverBatch/ \
-H "Accept: application/json" \
-H "Authorization: Bearer {access-token}"
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
modelPackageId | query | string | false | The model package ID of related champion/challenger to retrieve batch custom metric values for. |
modelId | query | string | false | The model ID of related champion/challenger to retrieve batch custom metric values for. |
batchId | query | any | false | The id of the batch for which metrics are being retrieved. |
deploymentId | path | string | true | ID of the deployment |
customMetricId | path | string | true | ID of the custom metric |
Example responses¶
200 Response
{
"buckets": [
{
"batch": {
"createdAt": "2019-08-24T14:15:22Z",
"id": "string",
"lastPredictionTimestamp": "2019-08-24T14:15:22Z",
"name": "string"
},
"categories": [
{
"categoryName": "string",
"count": 0
}
],
"sampleSize": 0,
"unknownCategoriesCount": 0,
"value": 0
}
],
"metric": {
"baselineValues": [
{
"value": 0
}
],
"createdAt": "2019-08-24T14:15:22Z",
"createdBy": {
"id": "string"
},
"description": "string",
"directionality": "higherIsBetter",
"displayChart": true,
"id": "string",
"isModelSpecific": true,
"name": "string",
"sampleCount": {
"columnName": "string"
},
"timeStep": "hour",
"timestamp": {
"columnName": "string",
"timeFormat": "%m/%d/%Y"
},
"type": "average",
"units": "string",
"value": {
"columnName": "string"
}
}
}
Responses¶
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Data retrieved successfully | MetricValuesOverBatchResponse |
403 | Forbidden | User does not have permission to read custom metric values. | None |
To perform this operation, you must be authenticated by means of one of the following methods:
BearerAuth
GET /api/v2/deployments/{deploymentId}/customMetrics/{customMetricId}/valuesOverTime/¶
Retrieve custom metric values over time.
Code samples¶
# You can also use wget
curl -X GET https://app.datarobot.com/api/v2/deployments/{deploymentId}/customMetrics/{customMetricId}/valuesOverTime/ \
-H "Accept: application/json" \
-H "Authorization: Bearer {access-token}"
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
start | query | string(date-time) | false | Start of the period to retrieve monitoring stats, defaults to 7 days ago from the end of the period. |
end | query | string(date-time) | false | End of the period to retrieve monitoring stats, defaults to the next top of the hour from now. |
modelPackageId | query | string | false | The model package ID of related champion/challenger to retrieve custom metric values for. |
modelId | query | string | false | The model ID of related champion/challenger to retrieve custom metric values for. |
bucketSize | query | string(duration) | false | Time duration of a bucket, default to seven days. |
deploymentId | path | string | true | ID of the deployment |
customMetricId | path | string | true | ID of the custom metric |
Example responses¶
200 Response
{
"buckets": [
{
"categories": [
{
"categoryName": "string",
"count": 0
}
],
"period": {
"end": "2019-08-24T14:15:22Z",
"start": "2019-08-24T14:15:22Z"
},
"sampleSize": 0,
"unknownCategoriesCount": 0,
"value": 0
}
],
"metric": {
"baselineValues": [
{
"value": 0
}
],
"createdAt": "2019-08-24T14:15:22Z",
"createdBy": {
"id": "string"
},
"description": "string",
"directionality": "higherIsBetter",
"displayChart": true,
"id": "string",
"isModelSpecific": true,
"name": "string",
"sampleCount": {
"columnName": "string"
},
"timeStep": "hour",
"timestamp": {
"columnName": "string",
"timeFormat": "%m/%d/%Y"
},
"type": "average",
"units": "string",
"value": {
"columnName": "string"
}
},
"summary": {
"end": "2019-08-24T14:15:22Z",
"start": "2019-08-24T14:15:22Z"
}
}
Responses¶
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Data retrieved successfully | MetricValuesOverTimeResponse |
403 | Forbidden | User does not have permission to read custom metric values. | None |
To perform this operation, you must be authenticated by means of one of the following methods:
BearerAuth
GET /api/v2/deployments/{deploymentId}/customMetricsBatchSummary/¶
Retrieve the bulk summary of deployment batch custom metrics.
Code samples¶
# You can also use wget
curl -X GET https://app.datarobot.com/api/v2/deployments/{deploymentId}/customMetricsBatchSummary/ \
-H "Accept: application/json" \
-H "Authorization: Bearer {access-token}"
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
start | query | string(date-time) | false | Start of the period to retrieve monitoring stats, defaults to 7 days ago from the end of the period. |
end | query | string(date-time) | false | End of the period to retrieve monitoring stats, defaults to the next top of the hour from now. |
modelPackageId | query | string | false | The model package ID of related champion/challenger to retrieve custom metric values for. |
modelId | query | string | false | The model ID of related champion/challenger to retrieve custom metric values for. |
batchId | query | any | false | The id of the batch for which metrics are being retrieved. |
deploymentId | path | string | true | Unique identifier of the deployment. |
Example responses¶
200 Response
{
"metrics": []
}
Responses¶
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Bulk summary retrieved successfully. | CustomMetricsBulkBatchSummary |
403 | Forbidden | User does not have permission to read the custom metrics summary. | None |
To perform this operation, you must be authenticated by means of one of the following methods:
BearerAuth
GET /api/v2/deployments/{deploymentId}/customMetricsSummary/¶
Retrieve the bulk summary of deployment custom metrics.
Code samples¶
# You can also use wget
curl -X GET https://app.datarobot.com/api/v2/deployments/{deploymentId}/customMetricsSummary/ \
-H "Accept: application/json" \
-H "Authorization: Bearer {access-token}"
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
start | query | string(date-time) | false | Start of the period to retrieve monitoring stats, defaults to 7 days ago from the end of the period. |
end | query | string(date-time) | false | End of the period to retrieve monitoring stats, defaults to the next top of the hour from now. |
modelPackageId | query | string | false | The model package ID of related champion/challenger to retrieve custom metric values for. |
modelId | query | string | false | The model ID of related champion/challenger to retrieve custom metric values for. |
batchId | query | any | false | The id of the batch for which metrics are being retrieved. |
deploymentId | path | string | true | Unique identifier of the deployment. |
Example responses¶
200 Response
{
"details": {
"earliestDate": "2019-08-24T14:15:22Z",
"latestDate": "2019-08-24T14:15:22Z"
},
"metrics": [],
"period": {
"end": "2019-08-24T14:15:22Z",
"start": "2019-08-24T14:15:22Z"
}
}
Responses¶
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Bulk summary retrieved successfully. | CustomMetricsBulkSummary |
403 | Forbidden | User does not have permission to read the custom metrics summary. | None |
To perform this operation, you must be authenticated by means of one of the following methods:
BearerAuth
GET /api/v2/deployments/{deploymentId}/dataQualityView/¶
Retrieve metadata of the data to be exported.
Code samples¶
# You can also use wget
curl -X GET https://app.datarobot.com/api/v2/deployments/{deploymentId}/dataQualityView/?start=2019-08-24T14%3A15%3A22Z&end=2019-08-24T14%3A15%3A22Z \
-H "Accept: application/json" \
-H "Authorization: Bearer {access-token}"
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
offset | query | integer | false | Specifies the number of rows to skip before starting to return rows from the query. |
limit | query | integer | false | Specifies the number of rows to return after the offset. |
start | query | string(date-time) | true | Start of the period of prediction data to collect. |
end | query | string(date-time) | true | End of the period of prediction data to collect. |
modelId | query | string | false | The ID of the model. |
predictionPattern | query | string | false | The keywords to search in a predicted value, for text generation target types. |
promptPattern | query | string | false | The keywords to search in a prompt value, for text generation target types. |
actualPattern | query | string | false | The keywords to search in an actual value, for text generation target types. |
orderBy | query | string | false | Field by which to order the text generation target types. |
orderMetric | query | string | false | Metric name or ID used for metric ordering. |
filterMetric | query | string | false | Metric name or ID used for metric filtering. |
filterValue | query | string | false | Metric value required to match value with filter metric name. |
deploymentId | path | string | true | Unique identifier of the deployment. |
Enumerated Values¶
Parameter | Value |
---|---|
orderBy | [timestamp , associationId , customMetrics , -timestamp , -associationId , -customMetrics ] |
Example responses¶
200 Response
{
"count": 0,
"data": [
{
"actualValue": "string",
"associationId": "string",
"context": [
{
"context": "string",
"link": "string"
}
],
"metrics": [
{
"id": "string",
"metadata": null,
"name": "string",
"value": 0
}
],
"predictedValue": "string",
"prompt": "string",
"timestamp": "2019-08-24T14:15:22Z"
}
],
"next": "string",
"previous": "string",
"totalCount": 0
}
Responses¶
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | none | DataQualityResponse |
To perform this operation, you must be authenticated by means of one of the following methods:
BearerAuth
GET /api/v2/deployments/{deploymentId}/fairnessScoresOverTime/¶
Retrieve fairness scores for all features, or for different classes of a single feature changes over a specific time period.
Code samples¶
# You can also use wget
curl -X GET https://app.datarobot.com/api/v2/deployments/{deploymentId}/fairnessScoresOverTime/ \
-H "Accept: application/json" \
-H "Authorization: Bearer {access-token}"
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
start | query | string(date-time) | false | Start of the period to retrieve monitoring data, defaults to 7 days ago from the end of the period. Note: this field only accepts top of the hour RFC3339 datetime strings, for example: 2019-08-01T00:00:00Z . |
end | query | string(date-time) | false | End of the period to retrieve monitoring data, defaults to the next top of the hour. Note: this field only accepts top of the hour RFC3339 datetime strings, for example: 2019-08-01T00:00:00Z . |
bucketSize | query | string | false | Time duration of buckets |
modelId | query | string | false | The ID of the model to retrieve the statistics for. |
fairnessMetric | query | string | false | The name of the fairness metric to compute fairness over time. |
protectedFeature | query | string | false | Name of the protected feature. When present, will return per class fairness score of the protected feature, otherwise returning fairness score of all protected features. |
orderBy | query | string | false | The type of FairnessScore to order the response by. |
includePrivilegedClass | query | string | false | Always include privileged class in response. |
onlyStatisticallySignificant | query | string | false | Include only statistically significant attributes. |
limit | query | integer | false | Max number of features in response. |
offset | query | integer | false | Number of features to offset in response. |
deploymentId | path | string | true | Unique identifier of the deployment. |
Enumerated Values¶
Parameter | Value |
---|---|
bucketSize | [PT1H , P1D , P7D , P1M ] |
fairnessMetric | [proportionalParity , equalParity , favorableClassBalance , unfavorableClassBalance , trueUnfavorableRateParity , trueFavorableRateParity , favorablePredictiveValueParity , unfavorablePredictiveValueParity ] |
orderBy | [absoluteFairnessScore , relativeFairnessScore , -absoluteFairnessScore , -relativeFairnessScore ] |
includePrivilegedClass | [false , False , true , True ] |
onlyStatisticallySignificant | [false , False , true , True ] |
Example responses¶
200 Response
{
"buckets": [
{
"metricName": "proportionalParity",
"period": {
"end": "2019-08-24T14:15:22Z",
"start": "2019-08-24T14:15:22Z"
},
"scores": [
{
"absoluteValue": 0,
"classesCount": 0,
"healthyClassesCount": 0,
"healthyCount": 0,
"isStatisticallySignificant": true,
"label": "string",
"message": "string",
"privilegedClass": "string",
"sampleSize": 0,
"totalCount": 1,
"value": 1
}
]
}
],
"fairnessThreshold": 1,
"favorableTargetOutcome": true,
"modelId": "string",
"modelPackageId": "string",
"protectedFeature": "string",
"summary": {
"metricName": "proportionalParity",
"period": {
"end": "2019-08-24T14:15:22Z",
"start": "2019-08-24T14:15:22Z"
},
"scores": [
{
"absoluteValue": 0,
"classesCount": 0,
"healthyClassesCount": 0,
"healthyCount": 0,
"isStatisticallySignificant": true,
"label": "string",
"message": "string",
"privilegedClass": "string",
"sampleSize": 0,
"totalCount": 1,
"value": 1
}
]
}
}
Responses¶
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Fairness summary and over time. | FairnessOverTimeResponse |
To perform this operation, you must be authenticated by means of one of the following methods:
BearerAuth
GET /api/v2/deployments/{deploymentId}/featureDrift/¶
Retrieve drift scores for features of the deployment.
Code samples¶
# You can also use wget
curl -X GET https://app.datarobot.com/api/v2/deployments/{deploymentId}/featureDrift/ \
-H "Accept: application/json" \
-H "Authorization: Bearer {access-token}"
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
start | query | string(date-time) | false | Start of the period to retrieve monitoring data, defaults to 7 days ago from the end of the period. Note: this field only accepts top of the hour RFC3339 datetime strings, for example: 2019-08-01T00:00:00Z . |
end | query | string(date-time) | false | End of the period to retrieve monitoring data, defaults to the next top of the hour. Note: this field only accepts top of the hour RFC3339 datetime strings, for example: 2019-08-01T00:00:00Z . |
modelId | query | string | false | ID of the model in the deployment. If not set, defaults to the deployment current model. |
metric | query | string | false | Name of the metric used to calculate the drift. Can be one of psi, kl_divergence, dissimilarity, hellinger, and js_divergence. Defaults to psi. |
offset | query | integer | false | The number of features to skip, defaults to 0. |
limit | query | integer | false | The number of features to return, defaults to 25. |
segmentAttribute | query | string | false | The name of a segment attribute used for segment analysis. |
segmentValue | query | string | false | The value of the segmentAttribute to segment on. |
batchId | query | any | false | The id of the batch for which metrics are being retrieved. |
deploymentId | path | string | true | Unique identifier of the deployment. |
Enumerated Values¶
Parameter | Value |
---|---|
metric | [psi , kl_divergence , dissimilarity , hellinger , js_divergence ] |
Example responses¶
200 Response
{
"batchId": [],
"count": 0,
"data": [
{
"baselineSampleSize": 0,
"driftScore": 0,
"featureImpact": 0,
"name": "string",
"sampleSize": 0,
"type": "numeric"
}
],
"metric": "psi",
"modelId": "string",
"next": "string",
"period": {
"end": "2019-08-24T14:15:22Z",
"start": "2019-08-24T14:15:22Z"
},
"previous": "string",
"segmentAttribute": "string",
"segmentValue": "string"
}
Responses¶
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Features drift over specified time period retrieved. | FeatureDriftResponse |
To perform this operation, you must be authenticated by means of one of the following methods:
BearerAuth
GET /api/v2/deployments/{deploymentId}/featureDriftOverBatch/¶
Retrieve drift over batch info for a feature of the deployment.
Code samples¶
# You can also use wget
curl -X GET https://app.datarobot.com/api/v2/deployments/{deploymentId}/featureDriftOverBatch/?featureNames=string \
-H "Accept: application/json" \
-H "Authorization: Bearer {access-token}"
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
segmentAttribute | query | string | false | The name of the segment on which segment analysis is being performed. |
segmentValue | query | string | false | The value of the segmentAttribute to segment on. |
batchId | query | any | false | The id of the batch for which metrics are being retrieved. |
featureNames | query | any | true | List of feature names, limited to two per request. |
driftMetric | query | string | false | The metric used to calculate data drift scores. |
modelId | query | string | false | The id of the model for which metrics are being retrieved. |
deploymentId | path | string | true | Unique identifier of the deployment. |
Enumerated Values¶
Parameter | Value |
---|---|
driftMetric | [psi , kl_divergence , dissimilarity , hellinger , js_divergence ] |
Example responses¶
200 Response
{
"buckets": [
{
"baselineSampleSize": 0,
"batch": {
"earliestPredictionTimestamp": "2019-08-24T14:15:22Z",
"id": "string",
"latestPredictionTimestamp": "2019-08-24T14:15:22Z",
"name": "string"
},
"driftScore": 0,
"featureImpact": 0,
"featureName": "string",
"sampleSize": 0
}
],
"driftMetric": "psi"
}
Responses¶
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Drift over batch info for a feature of the deployment. | FeatureDriftOverBatchResponse |
To perform this operation, you must be authenticated by means of one of the following methods:
BearerAuth
GET /api/v2/deployments/{deploymentId}/featureDriftOverSpace/¶
Retrieve drift scores for a feature of the deployment over the geospatial feature data.
Notice: Endpoint is currently in [PUBLIC_PREVIEW]. Do not use it in production workflows to reduce risk. See details:
This endpoint depends on the following features that are subject to change.
Feature Flag | Maturity | Enabled by default | Description |
---|---|---|---|
MMM_GEOSPATIAL_FEATURES_MONITORING | PUBLIC_PREVIEW | true | Enables monitoring geospatial features. |
Code samples¶
# You can also use wget
curl -X GET https://app.datarobot.com/api/v2/deployments/{deploymentId}/featureDriftOverSpace/ \
-H "Accept: application/json" \
-H "Authorization: Bearer {access-token}"
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
start | query | string(date-time) | false | Start of the period to retrieve monitoring data, defaults to 7 days ago from the end of the period. Note: this field only accepts top of the hour RFC3339 datetime strings, for example: 2019-08-01T00:00:00Z . |
end | query | string(date-time) | false | End of the period to retrieve monitoring data, defaults to the next top of the hour. Note: this field only accepts top of the hour RFC3339 datetime strings, for example: 2019-08-01T00:00:00Z . |
geoFeatureName | query | string | false | The name of the geospatial feature. Segmented analysis must be enabled for the feature specified. |
featureName | query | string | false | The name of the feature to retrieve drift scores for. Defaults to the target or, if there is no target, the most important feature. |
modelId | query | string | false | The ID of the model that feature drift is being retrieved from. |
metric | query | string | false | The metric used to calculate drift score. |
deploymentId | path | string | true | Unique identifier of the deployment. |
Enumerated Values¶
Parameter | Value |
---|---|
metric | [psi , klDivergence , dissimilarity , hellinger , jsDivergence ] |
Example responses¶
200 Response
{
"data": [
{
"baselineSampleSize": 0,
"driftScore": 0,
"hexagon": "string",
"sampleSize": 0
}
],
"featureName": "string",
"geoFeatureName": "string",
"period": {
"end": "2019-08-24T14:15:22Z",
"start": "2019-08-24T14:15:22Z"
}
}
Responses¶
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | The retrieved drift scores for the specified feature over the specified geospatial feature data. | FeatureDriftOverSpaceResponse |
To perform this operation, you must be authenticated by means of one of the following methods:
BearerAuth
GET /api/v2/deployments/{deploymentId}/featureDriftOverTime/¶
Retrieve drift over time info for a feature of the deployment.
Code samples¶
# You can also use wget
curl -X GET https://app.datarobot.com/api/v2/deployments/{deploymentId}/featureDriftOverTime/?featureNames=string \
-H "Accept: application/json" \
-H "Authorization: Bearer {access-token}"
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
start | query | string(date-time) | false | Start of the period to retrieve monitoring data, defaults to 7 days ago from the end of the period. Note: this field only accepts top of the hour RFC3339 datetime strings, for example: 2019-08-01T00:00:00Z . |
end | query | string(date-time) | false | End of the period to retrieve monitoring data, defaults to the next top of the hour. Note: this field only accepts top of the hour RFC3339 datetime strings, for example: 2019-08-01T00:00:00Z . |
bucketSize | query | string(duration) | false | The time duration of a bucket. Needs to be multiple of one hour. Can not be longer than the total length of the period. If not set, a default value will be calculated based on the start and end time. |
modelId | query | string | false | The id of the model for which the features drift is being retrieved. |
featureNames | query | any | true | List of feature names, limited to two per request. |
metric | query | string | false | Name of the metric used to calculate the drift. Can be one of psi, kl_divergence, dissimilarity, hellinger, and js_divergence. Defaults to psi. |
segmentAttribute | query | string | false | The name of the segment on which segment analysis is being performed. |
segmentValue | query | string | false | The value of the segmentAttribute to segment on. |
deploymentId | path | string | true | Unique identifier of the deployment. |
Enumerated Values¶
Parameter | Value |
---|---|
metric | [psi , kl_divergence , dissimilarity , hellinger , js_divergence ] |
Example responses¶
200 Response
{
"buckets": [
{
"baselineSampleSize": 0,
"driftScore": 0,
"featureImpact": 0,
"featureName": "string",
"period": {
"end": "2019-08-24T14:15:22Z",
"start": "2019-08-24T14:15:22Z"
},
"sampleSize": 0
}
],
"features": [
{
"featureName": "string",
"featureType": "numeric"
}
],
"metric": "string",
"summaries": [
{
"featureImpact": 0,
"featureName": "string"
}
]
}
Responses¶
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Feature drift over time info of the deployment retrieved. | FeatureDriftOverTimeResponse |
400 | Bad Request | Request invalid, refer to messages for detail. | None |
403 | Forbidden | Model Deployments and/or Monitoring are not enabled. | None |
404 | Not Found | Either the deployment does not exist or user does not have permission to view the deployment. | None |
To perform this operation, you must be authenticated by means of one of the following methods:
BearerAuth
GET /api/v2/deployments/{deploymentId}/features/¶
Retrieve features contained within the universe dataset associated with a specific deployment. By default, this returns all raw features required for predictions.
Code samples¶
# You can also use wget
curl -X GET https://app.datarobot.com/api/v2/deployments/{deploymentId}/features/?offset=0&limit=50 \
-H "Accept: application/json" \
-H "Authorization: Bearer {access-token}"
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
offset | query | integer | true | The number of features to skip, defaults to 0. |
limit | query | integer | true | The number of features to return, defaults to 0. |
includeNonPredictionFeatures | query | string | false | When True will return all raw features in the universe dataset associated with the deployment, and when False will return only those raw features used to make predictions on the deployment. |
forSegmentedAnalysis | query | string | false | When True, features returned will be filtered to those usable for segmented analysis. |
search | query | string | false | Case insensitive search against names of the deployment's features. |
orderBy | query | string | false | The sort order to apply to the list of features. Prefix the attribute name with a dash to sort in descending order, e.g., "-name". |
deploymentId | path | string | true | Unique identifier of the deployment. |
Enumerated Values¶
Parameter | Value |
---|---|
includeNonPredictionFeatures | [false , False , true , True ] |
forSegmentedAnalysis | [false , False , true , True ] |
orderBy | [name , -name , importance , -importance ] |
Example responses¶
200 Response
{
"count": 0,
"data": [
{
"dateFormat": "string",
"featureType": "string",
"importance": 0,
"knownInAdvance": true,
"name": "string"
}
],
"next": "http://example.com",
"previous": "http://example.com",
"totalCount": 0
}
Responses¶
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | The deployment's features | FeatureListResponse |
To perform this operation, you must be authenticated by means of one of the following methods:
BearerAuth
GET /api/v2/deployments/{deploymentId}/healthSettings/¶
Retrieve deployment health settings.
Code samples¶
# You can also use wget
curl -X GET https://app.datarobot.com/api/v2/deployments/{deploymentId}/healthSettings/ \
-H "Accept: application/json" \
-H "Authorization: Bearer {access-token}"
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
deploymentId | path | string | true | Unique identifier of the deployment. |
Example responses¶
200 Response
{
"accuracy": {
"batchCount": "1",
"failingThreshold": 0,
"measurement": "percent",
"metric": "AUC",
"warningThreshold": 0
},
"actualsTimeliness": {
"enabled": true,
"expectedFrequency": "string"
},
"customMetrics": {
"failingConditions": [
{
"compareOperator": "lt",
"metricId": "string",
"threshold": 0
}
],
"warningConditions": [
{
"compareOperator": "lt",
"metricId": "string",
"threshold": 0
}
]
},
"dataDrift": {
"batchCount": "1",
"driftThreshold": 1,
"excludedFeatures": [
"string"
],
"highImportanceFailingCount": 1,
"highImportanceWarningCount": 1,
"importanceThreshold": 1,
"lowImportanceFailingCount": 1,
"lowImportanceWarningCount": 1,
"starredFeatures": [
"string"
],
"timeInterval": "T2H"
},
"fairness": {
"protectedClassFailingCount": 1,
"protectedClassWarningCount": 1
},
"predictionsTimeliness": {
"enabled": true,
"expectedFrequency": "string"
},
"service": {
"batchCount": "1"
}
}
Responses¶
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Deployment health settings. | HealthSettings |
To perform this operation, you must be authenticated by means of one of the following methods:
BearerAuth
PATCH /api/v2/deployments/{deploymentId}/healthSettings/¶
Update deployment health settings.
Code samples¶
# You can also use wget
curl -X PATCH https://app.datarobot.com/api/v2/deployments/{deploymentId}/healthSettings/ \
-H "Content-Type: application/json" \
-H "Authorization: Bearer {access-token}" \
-d '{undefined}'
Body parameter¶
{
"accuracy": {
"batchCount": "1",
"failingThreshold": 0,
"measurement": "percent",
"metric": "AUC",
"warningThreshold": 0
},
"actualsTimeliness": {
"enabled": true,
"expectedFrequency": "string"
},
"customMetrics": {
"failingConditions": [
{
"compareOperator": "lt",
"metricId": "string",
"threshold": 0
}
],
"warningConditions": [
{
"compareOperator": "lt",
"metricId": "string",
"threshold": 0
}
]
},
"dataDrift": {
"batchCount": "1",
"driftThreshold": 1,
"excludedFeatures": [
"string"
],
"highImportanceFailingCount": 1,
"highImportanceWarningCount": 1,
"importanceThreshold": 1,
"lowImportanceFailingCount": 1,
"lowImportanceWarningCount": 1,
"starredFeatures": [
"string"
],
"timeInterval": "T2H"
},
"fairness": {
"protectedClassFailingCount": 1,
"protectedClassWarningCount": 1
},
"predictionsTimeliness": {
"enabled": true,
"expectedFrequency": "string"
},
"service": {
"batchCount": "1"
}
}
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
deploymentId | path | string | true | Unique identifier of the deployment. |
body | body | HealthSettings | false | none |
Responses¶
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Updated deployment health settings. | None |
To perform this operation, you must be authenticated by means of one of the following methods:
BearerAuth
GET /api/v2/deployments/{deploymentId}/healthSettings/defaults/¶
Retrieve default deployment health settings.
Code samples¶
# You can also use wget
curl -X GET https://app.datarobot.com/api/v2/deployments/{deploymentId}/healthSettings/defaults/ \
-H "Accept: application/json" \
-H "Authorization: Bearer {access-token}"
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
deploymentId | path | string | true | Unique identifier of the deployment. |
Example responses¶
200 Response
{
"accuracy": {
"batchCount": "1",
"failingThreshold": 0,
"measurement": "percent",
"metric": "AUC",
"warningThreshold": 0
},
"actualsTimeliness": {
"enabled": true,
"expectedFrequency": "string"
},
"customMetrics": {
"failingConditions": [
{
"compareOperator": "lt",
"metricId": "string",
"threshold": 0
}
],
"warningConditions": [
{
"compareOperator": "lt",
"metricId": "string",
"threshold": 0
}
]
},
"dataDrift": {
"batchCount": "1",
"driftThreshold": 1,
"excludedFeatures": [
"string"
],
"highImportanceFailingCount": 1,
"highImportanceWarningCount": 1,
"importanceThreshold": 1,
"lowImportanceFailingCount": 1,
"lowImportanceWarningCount": 1,
"starredFeatures": [
"string"
],
"timeInterval": "T2H"
},
"fairness": {
"protectedClassFailingCount": 1,
"protectedClassWarningCount": 1
},
"predictionsTimeliness": {
"enabled": true,
"expectedFrequency": "string"
},
"service": {
"batchCount": "1"
}
}
Responses¶
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Default deployment health settings. | HealthSettings |
To perform this operation, you must be authenticated by means of one of the following methods:
BearerAuth
GET /api/v2/deployments/{deploymentId}/humilityStats/¶
Retrieve humility rule service triggers statistics overview.
Code samples¶
# You can also use wget
curl -X GET https://app.datarobot.com/api/v2/deployments/{deploymentId}/humilityStats/ \
-H "Accept: application/json" \
-H "Authorization: Bearer {access-token}"
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
start | query | string(date-time) | false | Start of the period to retrieve monitoring data, defaults to 7 days ago from the end of the period. Note: this field only accepts top of the hour RFC3339 datetime strings, for example: 2019-08-01T00:00:00Z . |
end | query | string(date-time) | false | End of the period to retrieve monitoring data, defaults to the next top of the hour. Note: this field only accepts top of the hour RFC3339 datetime strings, for example: 2019-08-01T00:00:00Z . |
bucketSize | query | string(duration) | false | The time duration of a bucket. Needs to be multiple of one hour. Can not be longer than the total length of the period. If not set, a default value will be calculated based on the start and end time. |
modelId | query | string | false | The id of the model for which metrics are being retrieved. |
segmentAttribute | query | string | false | The name of a segment attribute used for segment analysis. |
segmentValue | query | string | false | The value of the segmentAttribute to segment on. |
deploymentId | path | string | true | Unique identifier of the deployment. |
Enumerated Values¶
Parameter | Value |
---|---|
segmentAttribute | [DataRobot-Consumer , DataRobot-Remote-IP , DataRobot-Host-IP ] |
Example responses¶
200 Response
{
"data": [
{
"ruleId": "string",
"ruleName": "string",
"value": 0
}
],
"modelId": "string",
"period": {
"end": "2019-08-24T14:15:22Z",
"start": "2019-08-24T14:15:22Z"
},
"segmentAttribute": "string",
"segmentValue": ""
}
Responses¶
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Humility service health statistics overview retrieved. | HumilityStatsResponse |
403 | Forbidden | Model Deployments and/or Monitoring are not enabled. | None |
404 | Not Found | Either the deployment does not exist or user does not have permission to view the deployment. | None |
To perform this operation, you must be authenticated by means of one of the following methods:
BearerAuth
GET /api/v2/deployments/{deploymentId}/humilityStatsOverTime/¶
Retrieve humility service statistics over time.
Code samples¶
# You can also use wget
curl -X GET https://app.datarobot.com/api/v2/deployments/{deploymentId}/humilityStatsOverTime/ \
-H "Accept: application/json" \
-H "Authorization: Bearer {access-token}"
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
start | query | string(date-time) | false | Start of the period to retrieve monitoring data, defaults to 7 days ago from the end of the period. Note: this field only accepts top of the hour RFC3339 datetime strings, for example: 2019-08-01T00:00:00Z . |
end | query | string(date-time) | false | End of the period to retrieve monitoring data, defaults to the next top of the hour. Note: this field only accepts top of the hour RFC3339 datetime strings, for example: 2019-08-01T00:00:00Z . |
bucketSize | query | string(duration) | false | The time duration of a bucket. Needs to be multiple of one hour. Can not be longer than the total length of the period. If not set, a default value will be calculated based on the start and end time. |
modelId | query | string | false | The id of the model for which metrics are being retrieved. |
segmentAttribute | query | string | false | The name of a segment attribute used for segment analysis. |
segmentValue | query | string | false | The value of the segmentAttribute to segment on. |
deploymentId | path | string | true | Unique identifier of the deployment. |
Enumerated Values¶
Parameter | Value |
---|---|
segmentAttribute | [DataRobot-Consumer , DataRobot-Remote-IP , DataRobot-Host-IP ] |
Example responses¶
200 Response
{
"buckets": [
{
"period": {
"end": "2019-08-24T14:15:22Z",
"start": "2019-08-24T14:15:22Z"
},
"values": [
{
"ruleId": "string",
"ruleName": "string",
"value": 0
}
]
}
],
"modelId": "string",
"segmentAttribute": "string",
"segmentValue": "",
"summary": {
"period": {
"end": "2019-08-24T14:15:22Z",
"start": "2019-08-24T14:15:22Z"
},
"values": [
{
"ruleId": "string",
"ruleName": "string",
"value": 0
}
]
}
}
Responses¶
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Humility statistics for deployment retrieved. | HumilityStatsOverTimeResponse |
403 | Forbidden | Model Deployments and/or Monitoring are not enabled. | None |
404 | Not Found | Either the deployment does not exist or user does not have permission to view the deployment. | None |
To perform this operation, you must be authenticated by means of one of the following methods:
BearerAuth
PATCH /api/v2/deployments/{deploymentId}/model/¶
Replace the model used to make predictions for the deployment. A validation process will be performed to make sure the new model is eligible as a replacement. If the validation fails, the model replacement will not occur.The Model Replacement Validation endpoint can be used to confirm the new model is eligible as a replacement.
Code samples¶
# You can also use wget
curl -X PATCH https://app.datarobot.com/api/v2/deployments/{deploymentId}/model/ \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {access-token}" \
-d '{undefined}'
Body parameter¶
{
"modelId": "string",
"modelPackageId": "string",
"reason": "ACCURACY",
"runtimeParameterValues": "string"
}
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
deploymentId | path | string | true | Unique identifier of the deployment. |
body | body | ModelReplacementSubmission | false | none |
Example responses¶
202 Response
{
"checks": {
"combinedModelSegments": {
"message": "string",
"status": "failing"
},
"containsTrackedSegmentAttributes": {
"message": "string",
"status": "failing"
},
"driftTracking": {
"message": "string",
"status": "failing"
},
"featureDataTypes": {
"message": "string",
"status": "failing"
},
"features": {
"message": "string",
"status": "failing"
},
"humilityRules": {
"message": "string",
"status": "failing"
},
"modelCanBeDeployed": {
"message": "string",
"status": "failing"
},
"modelStatus": {
"message": "string",
"status": "failing"
},
"notCurrentModel": {
"message": "string",
"status": "failing"
},
"permission": {
"message": "string",
"status": "failing"
},
"predictionIntervals": {
"message": "string",
"status": "failing"
},
"predictionReady": {
"message": "string",
"status": "failing"
},
"seriesType": {
"message": "string",
"status": "failing"
},
"supported": {
"message": "string",
"status": "failing"
},
"target": {
"message": "string",
"status": "failing"
},
"targetClasses": {
"message": "string",
"status": "failing"
},
"targetType": {
"message": "string",
"status": "failing"
},
"timeSeriesCompatibility": {
"message": "string",
"status": "failing"
},
"validChallenger": {
"message": "string",
"status": "failing"
}
},
"message": "string",
"status": "failing"
}
Responses¶
Status | Meaning | Description | Schema |
---|---|---|---|
202 | Accepted | Job submitted. See Location header. | ModelReplacementValidationResponse |
Response Headers¶
Status | Header | Type | Format | Description |
---|---|---|---|---|
202 | Location | string | A url that can be polled to check the status. |
To perform this operation, you must be authenticated by means of one of the following methods:
BearerAuth
GET /api/v2/deployments/{deploymentId}/model/secondaryDatasetConfiguration/¶
Retrieve the secondary datasets configuration used by a deployed Feature discovery model.
Code samples¶
# You can also use wget
curl -X GET https://app.datarobot.com/api/v2/deployments/{deploymentId}/model/secondaryDatasetConfiguration/ \
-H "Accept: application/json" \
-H "Authorization: Bearer {access-token}"
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
deploymentId | path | string | true | Unique identifier of the deployment. |
Example responses¶
200 Response
{
"created": "2019-08-24T14:15:22Z",
"creatorFullName": "string",
"creatorUserId": "string",
"credentialIds": [
{
"catalogVersionId": "string",
"credentialId": "string",
"url": "string"
}
],
"featurelistId": "string",
"isDefault": true,
"isDeleted": true,
"name": "string",
"projectId": "string",
"secondaryDatasetConfigId": "string",
"secondaryDatasets": [
{
"catalogId": "string",
"catalogVersionId": "string",
"identifier": "string",
"snapshotPolicy": "specified"
}
]
}
Responses¶
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Secondary datasets configuration. | SecondaryDatasetConfigResponse |
404 | Not Found | Deployment or secondary datasets configuration cannot be found for the deployed model. | None |
To perform this operation, you must be authenticated by means of one of the following methods:
BearerAuth
PATCH /api/v2/deployments/{deploymentId}/model/secondaryDatasetConfiguration/¶
Update the secondary datasets configuration used by the deployed feature discovery model.
Code samples¶
# You can also use wget
curl -X PATCH https://app.datarobot.com/api/v2/deployments/{deploymentId}/model/secondaryDatasetConfiguration/ \
-H "Content-Type: application/json" \
-H "Authorization: Bearer {access-token}" \
-d '{undefined}'
Body parameter¶
{
"credentialsIds": [
{
"catalogVersionId": "string",
"credentialId": "string",
"url": "string"
}
],
"secondaryDatasetConfigId": "string"
}
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
deploymentId | path | string | true | Unique identifier of the deployment. |
body | body | SecondaryDatasetConfigUpdate | false | none |
Responses¶
Status | Meaning | Description | Schema |
---|---|---|---|
204 | No Content | Secondary Datasets Configuration updated successfully. | None |
403 | Forbidden | Invalid credentials for secondary datasets configuration. | None |
To perform this operation, you must be authenticated by means of one of the following methods:
BearerAuth
GET /api/v2/deployments/{deploymentId}/model/secondaryDatasetConfigurationHistory/¶
List all the secondary datasets configuration used by a given Feature Discovery deployment
Code samples¶
# You can also use wget
curl -X GET https://app.datarobot.com/api/v2/deployments/{deploymentId}/model/secondaryDatasetConfigurationHistory/?offset=0&limit=100 \
-H "Accept: application/json" \
-H "Authorization: Bearer {access-token}"
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
offset | query | integer | true | Number of items to skip. Defaults to 0 if not provided. |
limit | query | integer | true | Number of items to return, defaults to 100 if not provided. |
deploymentId | path | string | true | Unique identifier of the deployment. |
Example responses¶
200 Response
{
"count": 0,
"data": [
{
"configId": "string",
"configName": "string",
"updated": "string",
"username": "string"
}
],
"next": "http://example.com",
"previous": "http://example.com"
}
Responses¶
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Secondary Datasets Configuration history. | SecondaryDatasetsConfigListResponse |
To perform this operation, you must be authenticated by means of one of the following methods:
BearerAuth
POST /api/v2/deployments/{deploymentId}/model/validation/¶
Validate that a model can be used to replace the current model of the deployment.
Code samples¶
# You can also use wget
curl -X POST https://app.datarobot.com/api/v2/deployments/{deploymentId}/model/validation/ \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {access-token}" \
-d '{undefined}'
Body parameter¶
{
"modelId": "string",
"modelPackageId": "string"
}
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
deploymentId | path | string | true | Unique identifier of the deployment. |
body | body | ModelReplacementValidationRequest | false | none |
Example responses¶
200 Response
{
"checks": {
"combinedModelSegments": {
"message": "string",
"status": "failing"
},
"containsTrackedSegmentAttributes": {
"message": "string",
"status": "failing"
},
"driftTracking": {
"message": "string",
"status": "failing"
},
"featureDataTypes": {
"message": "string",
"status": "failing"
},
"features": {
"message": "string",
"status": "failing"
},
"humilityRules": {
"message": "string",
"status": "failing"
},
"modelCanBeDeployed": {
"message": "string",
"status": "failing"
},
"modelStatus": {
"message": "string",
"status": "failing"
},
"notCurrentModel": {
"message": "string",
"status": "failing"
},
"permission": {
"message": "string",
"status": "failing"
},
"predictionIntervals": {
"message": "string",
"status": "failing"
},
"predictionReady": {
"message": "string",
"status": "failing"
},
"seriesType": {
"message": "string",
"status": "failing"
},
"supported": {
"message": "string",
"status": "failing"
},
"target": {
"message": "string",
"status": "failing"
},
"targetClasses": {
"message": "string",
"status": "failing"
},
"targetType": {
"message": "string",
"status": "failing"
},
"timeSeriesCompatibility": {
"message": "string",
"status": "failing"
},
"validChallenger": {
"message": "string",
"status": "failing"
}
},
"message": "string",
"status": "failing"
}
Responses¶
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | none | ModelReplacementValidationResponse |
To perform this operation, you must be authenticated by means of one of the following methods:
BearerAuth
GET /api/v2/deployments/{deploymentId}/monitoringBatchLimits/¶
Get the limits related to monitoring batches.
Code samples¶
# You can also use wget
curl -X GET https://app.datarobot.com/api/v2/deployments/{deploymentId}/monitoringBatchLimits/ \
-H "Authorization: Bearer {access-token}"
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
deploymentId | path | string | true | Unique identifier of the deployment. |
Responses¶
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | none | None |
To perform this operation, you must be authenticated by means of one of the following methods:
BearerAuth
GET /api/v2/deployments/{deploymentId}/monitoringBatches/¶
List monitoring batches in a deployment.
Code samples¶
# You can also use wget
curl -X GET https://app.datarobot.com/api/v2/deployments/{deploymentId}/monitoringBatches/ \
-H "Accept: application/json" \
-H "Authorization: Bearer {access-token}"
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
offset | query | integer | false | Number of results to skip. |
limit | query | integer | false | At most this many results are returned. The default may change without notice. |
createdBy | query | string | false | ID of the user who created a batch. |
search | query | string | false | Search by matching batch name in a case-insensitive manner or exact match of batch ID. |
orderBy | query | string | false | Order of the returning batches. |
createdAfter | query | string(date-time) | false | Filter for batches created after the given time |
createdBefore | query | string(date-time) | false | Filter for batches created before the given time |
startAfter | query | string(date-time) | false | Filter for batches with a start time after the given time |
endBefore | query | string(date-time) | false | Filter for batches with an end time before the given time |
deploymentId | path | string | true | Unique identifier of the deployment. |
Enumerated Values¶
Parameter | Value |
---|---|
orderBy | [name , -name , createdAt , -createdAt , earliestPredictionTimestamp , -earliestPredictionTimestamp , latestPredictionTimestamp , -latestPredictionTimestamp ] |
Example responses¶
200 Response
{
"count": 0,
"data": [
{
"batchPredictionJobId": "string",
"batchPredictionJobStatus": "INITIALIZING",
"createdAt": "2019-08-24T14:15:22Z",
"createdBy": {
"id": "string",
"name": "string"
},
"description": "string",
"earliestPredictionTimestamp": "2019-08-24T14:15:22Z",
"externalContextUrl": "http://example.com",
"id": "string",
"isLocked": true,
"latestPredictionTimestamp": "2019-08-24T14:15:22Z",
"name": "string",
"predictionsCount": 0,
"serviceHealth": {
"message": "string",
"status": "string"
}
}
],
"next": "http://example.com",
"previous": "http://example.com",
"totalCount": 0
}
Responses¶
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | none | MonitoringBatchListResponse |
To perform this operation, you must be authenticated by means of one of the following methods:
BearerAuth
POST /api/v2/deployments/{deploymentId}/monitoringBatches/¶
Create a monitoring batch for a deployment.
Code samples¶
# You can also use wget
curl -X POST https://app.datarobot.com/api/v2/deployments/{deploymentId}/monitoringBatches/ \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {access-token}" \
-d '{undefined}'
Body parameter¶
{
"batchName": "string",
"description": "string",
"externalContextUrl": "http://example.com",
"isLocked": true
}
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
deploymentId | path | string | true | Unique identifier of the deployment. |
body | body | MonitoringBatchCreateUpdate | false | none |
Example responses¶
200 Response
{
"batchPredictionJobId": "string",
"batchPredictionJobStatus": "INITIALIZING",
"createdAt": "2019-08-24T14:15:22Z",
"createdBy": {
"id": "string",
"name": "string"
},
"description": "string",
"earliestPredictionTimestamp": "2019-08-24T14:15:22Z",
"externalContextUrl": "http://example.com",
"id": "string",
"isLocked": true,
"latestPredictionTimestamp": "2019-08-24T14:15:22Z",
"name": "string",
"predictionsCount": 0,
"serviceHealth": {
"message": "string",
"status": "string"
}
}
Responses¶
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | none | MonitoringBatch |
To perform this operation, you must be authenticated by means of one of the following methods:
BearerAuth
DELETE /api/v2/deployments/{deploymentId}/monitoringBatches/{monitoringBatchId}/¶
Delete a monitoring batch in a deployment.
Code samples¶
# You can also use wget
curl -X DELETE https://app.datarobot.com/api/v2/deployments/{deploymentId}/monitoringBatches/{monitoringBatchId}/ \
-H "Authorization: Bearer {access-token}"
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
deploymentId | path | string | true | Unique identifier of the deployment. |
monitoringBatchId | path | string | true | ID of the monitoring batch. |
Responses¶
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | none | None |
To perform this operation, you must be authenticated by means of one of the following methods:
BearerAuth
GET /api/v2/deployments/{deploymentId}/monitoringBatches/{monitoringBatchId}/¶
Retrieve a monitoring batch in a deployment.
Code samples¶
# You can also use wget
curl -X GET https://app.datarobot.com/api/v2/deployments/{deploymentId}/monitoringBatches/{monitoringBatchId}/ \
-H "Accept: application/json" \
-H "Authorization: Bearer {access-token}"
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
deploymentId | path | string | true | Unique identifier of the deployment. |
monitoringBatchId | path | string | true | ID of the monitoring batch. |
Example responses¶
200 Response
{
"batchPredictionJobId": "string",
"batchPredictionJobStatus": "INITIALIZING",
"createdAt": "2019-08-24T14:15:22Z",
"createdBy": {
"id": "string",
"name": "string"
},
"description": "string",
"earliestPredictionTimestamp": "2019-08-24T14:15:22Z",
"externalContextUrl": "http://example.com",
"id": "string",
"isLocked": true,
"latestPredictionTimestamp": "2019-08-24T14:15:22Z",
"name": "string",
"predictionsCount": 0,
"serviceHealth": {
"message": "string",
"status": "string"
}
}
Responses¶
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | none | MonitoringBatch |
To perform this operation, you must be authenticated by means of one of the following methods:
BearerAuth
PATCH /api/v2/deployments/{deploymentId}/monitoringBatches/{monitoringBatchId}/¶
Update a monitoring batch in a deployment.
Code samples¶
# You can also use wget
curl -X PATCH https://app.datarobot.com/api/v2/deployments/{deploymentId}/monitoringBatches/{monitoringBatchId}/ \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {access-token}" \
-d '{undefined}'
Body parameter¶
{
"batchName": "string",
"description": "string",
"externalContextUrl": "http://example.com",
"isLocked": true
}
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
deploymentId | path | string | true | Unique identifier of the deployment. |
monitoringBatchId | path | string | true | ID of the monitoring batch. |
body | body | MonitoringBatchCreateUpdate | false | none |
Example responses¶
200 Response
{
"batchPredictionJobId": "string",
"batchPredictionJobStatus": "INITIALIZING",
"createdAt": "2019-08-24T14:15:22Z",
"createdBy": {
"id": "string",
"name": "string"
},
"description": "string",
"earliestPredictionTimestamp": "2019-08-24T14:15:22Z",
"externalContextUrl": "http://example.com",
"id": "string",
"isLocked": true,
"latestPredictionTimestamp": "2019-08-24T14:15:22Z",
"name": "string",
"predictionsCount": 0,
"serviceHealth": {
"message": "string",
"status": "string"
}
}
Responses¶
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | none | MonitoringBatch |
To perform this operation, you must be authenticated by means of one of the following methods:
BearerAuth
GET /api/v2/deployments/{deploymentId}/monitoringBatches/{monitoringBatchId}/models/¶
List information about models that have data in a monitoring batch.
Code samples¶
# You can also use wget
curl -X GET https://app.datarobot.com/api/v2/deployments/{deploymentId}/monitoringBatches/{monitoringBatchId}/models/ \
-H "Accept: application/json" \
-H "Authorization: Bearer {access-token}"
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
offset | query | integer | false | Number of results to skip. |
limit | query | integer | false | At most this many results are returned. The default may change without notice. |
modelId | query | string | false | ID of the model associated with a batch. |
deploymentId | path | string | true | Unique identifier of the deployment. |
monitoringBatchId | path | string | true | ID of the monitoring batch. |
Example responses¶
200 Response
{
"count": 0,
"data": [
{
"batchId": "string",
"endTime": "2019-08-24T14:15:22Z",
"modelId": "string",
"predictionsCount": 0,
"startTime": "2019-08-24T14:15:22Z"
}
],
"next": "http://example.com",
"previous": "http://example.com",
"totalCount": 0
}
Responses¶
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | none | MonitoringBatchModelListResponse |
To perform this operation, you must be authenticated by means of one of the following methods:
BearerAuth
GET /api/v2/deployments/{deploymentId}/monitoringBatches/{monitoringBatchId}/models/{modelId}/¶
Get information about a model that has data in a monitoring batch.
Code samples¶
# You can also use wget
curl -X GET https://app.datarobot.com/api/v2/deployments/{deploymentId}/monitoringBatches/{monitoringBatchId}/models/{modelId}/ \
-H "Accept: application/json" \
-H "Authorization: Bearer {access-token}"
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
deploymentId | path | string | true | Unique identifier of the deployment. |
monitoringBatchId | path | string | true | ID of the monitoring batch. |
modelId | path | string | true | ID of the model. |
Example responses¶
200 Response
{
"batchId": "string",
"endTime": "2019-08-24T14:15:22Z",
"modelId": "string",
"predictionsCount": 0,
"startTime": "2019-08-24T14:15:22Z"
}
Responses¶
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | none | MonitoringBatchModel |
To perform this operation, you must be authenticated by means of one of the following methods:
BearerAuth
PATCH /api/v2/deployments/{deploymentId}/monitoringBatches/{monitoringBatchId}/models/{modelId}/¶
Update information about model data in a batch.
Code samples¶
# You can also use wget
curl -X PATCH https://app.datarobot.com/api/v2/deployments/{deploymentId}/monitoringBatches/{monitoringBatchId}/models/{modelId}/ \
-H "Content-Type: application/json" \
-H "Authorization: Bearer {access-token}" \
-d '{undefined}'
Body parameter¶
{
"endTime": "2019-08-24T14:15:22Z",
"startTime": "2019-08-24T14:15:22Z"
}
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
deploymentId | path | string | true | Unique identifier of the deployment. |
monitoringBatchId | path | string | true | ID of the monitoring batch. |
modelId | path | string | true | ID of the model. |
body | body | MonitoringBatchModelUpdate | false | none |
Responses¶
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | none | None |
To perform this operation, you must be authenticated by means of one of the following methods:
BearerAuth
POST /api/v2/deployments/{deploymentId}/monitoringDataDeletions/¶
Delete deployment monitoring data.
Code samples¶
# You can also use wget
curl -X POST https://app.datarobot.com/api/v2/deployments/{deploymentId}/monitoringDataDeletions/ \
-H "Content-Type: application/json" \
-H "Authorization: Bearer {access-token}" \
-d '{undefined}'
Body parameter¶
{
"end": "2019-08-24T14:15:22Z",
"modelId": "string",
"start": "2019-08-24T14:15:22Z"
}
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
deploymentId | path | string | true | Unique identifier of the deployment. |
body | body | MonitoringDataDeletePayload | false | none |
Responses¶
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | none | None |
404 | Not Found | Deployment or model not found. | None |
To perform this operation, you must be authenticated by means of one of the following methods:
BearerAuth
POST /api/v2/deployments/{deploymentId}/onDemandReports/¶
Add report to execution queue.
Code samples¶
# You can also use wget
curl -X POST https://app.datarobot.com/api/v2/deployments/{deploymentId}/onDemandReports/ \
-H "Content-Type: application/json" \
-H "Authorization: Bearer {access-token}" \
-d '{undefined}'
Body parameter¶
{
"id": "string"
}
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
deploymentId | path | string | true | Unique identifier of the deployment. |
body | body | ScheduledReportOnDemmand | false | none |
Responses¶
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Scheduled report job was addded to execution. | None |
Response Headers¶
Status | Header | Type | Format | Description |
---|---|---|---|---|
200 | Location | string | URL to poll to track report generation has finished. |
To perform this operation, you must be authenticated by means of one of the following methods:
BearerAuth
GET /api/v2/deployments/{deploymentId}/predictionDataExports/¶
A list of asynchronous prediction data exports.
Code samples¶
# You can also use wget
curl -X GET https://app.datarobot.com/api/v2/deployments/{deploymentId}/predictionDataExports/ \
-H "Accept: application/json" \
-H "Authorization: Bearer {access-token}"
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
offset | query | integer | false | Specifies the number of rows to skip before starting to return rows from the query. |
limit | query | integer | false | Specifies the number of rows to return after the offset. |
status | query | string | false | A prediction data export processing state. |
modelId | query | string | false | Id of model used for prediction data export. |
batch | query | string | false | If true, returns just the exports associated with batches. If false, just the real-time ones. If not provided, returns both real-time and batch exports. |
deploymentId | path | string | true | Unique identifier of the deployment. |
Enumerated Values¶
Parameter | Value |
---|---|
status | [CANCELLED , CREATED , FAILED , SCHEDULED , SUCCEEDED ] |
batch | [false , False , true , True ] |
Example responses¶
200 Response
{
"count": 0,
"data": [
{
"associationIds": [
"string"
],
"augmentationType": "NO_AUGMENTATION",
"batches": [
{
"batchId": "string",
"batchName": "string"
}
],
"createdAt": "2019-08-24T14:15:22Z",
"createdBy": "string",
"data": [
{
"id": "string",
"name": "string"
}
],
"error": {
"message": "string"
},
"id": "string",
"modelId": "string",
"period": {
"end": "2019-08-24T14:15:22Z",
"start": "2019-08-24T14:15:22Z"
},
"status": "CANCELLED"
}
],
"next": "string",
"previous": "string",
"totalCount": 0
}
Responses¶
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | The prediction data exports. | PredictionExportListResponse |
403 | Forbidden | User does not have permission to access a particular deployment. | None |
404 | Not Found | Resource not found. | None |
422 | Unprocessable Entity | Unable to process the prediction data exports list retrieval due to invalid parameter values. | None |
To perform this operation, you must be authenticated by means of one of the following methods:
BearerAuth
POST /api/v2/deployments/{deploymentId}/predictionDataExports/¶
Create a deployment prediction data export.
Code samples¶
# You can also use wget
curl -X POST https://app.datarobot.com/api/v2/deployments/{deploymentId}/predictionDataExports/ \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {access-token}" \
-d '{undefined}'
Body parameter¶
{
"augmentationType": "NO_AUGMENTATION",
"batchIds": [
"string"
],
"end": "2019-08-24T14:15:22Z",
"modelId": "string",
"start": "2019-08-24T14:15:22Z"
}
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
deploymentId | path | string | true | Unique identifier of the deployment. |
body | body | ExportCreatePayload | false | none |
Example responses¶
202 Response
{
"associationIds": [
"string"
],
"augmentationType": "NO_AUGMENTATION",
"batches": [
{
"batchId": "string",
"batchName": "string"
}
],
"createdAt": "2019-08-24T14:15:22Z",
"createdBy": "string",
"data": [
{
"id": "string",
"name": "string"
}
],
"error": {
"message": "string"
},
"id": "string",
"modelId": "string",
"period": {
"end": "2019-08-24T14:15:22Z",
"start": "2019-08-24T14:15:22Z"
},
"status": "CANCELLED"
}
Responses¶
Status | Meaning | Description | Schema |
---|---|---|---|
202 | Accepted | Prediction data export successfully created. | ExportEntity |
403 | Forbidden | User does not have permission to create a prediction data export. | None |
404 | Not Found | Resource not found. | None |
422 | Unprocessable Entity | Unable to process the prediction data export creation request. | None |
To perform this operation, you must be authenticated by means of one of the following methods:
BearerAuth
GET /api/v2/deployments/{deploymentId}/predictionDataExports/{exportId}/¶
Retrieve a single prediction data export.
Code samples¶
# You can also use wget
curl -X GET https://app.datarobot.com/api/v2/deployments/{deploymentId}/predictionDataExports/{exportId}/ \
-H "Accept: application/json" \
-H "Authorization: Bearer {access-token}"
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
deploymentId | path | string | true | Unique identifier of the deployment. |
exportId | path | string | true | Unique identifier of the export. |
Example responses¶
200 Response
{
"associationIds": [
"string"
],
"augmentationType": "NO_AUGMENTATION",
"batches": [
{
"batchId": "string",
"batchName": "string"
}
],
"createdAt": "2019-08-24T14:15:22Z",
"createdBy": "string",
"data": [
{
"id": "string",
"name": "string"
}
],
"error": {
"message": "string"
},
"id": "string",
"modelId": "string",
"period": {
"end": "2019-08-24T14:15:22Z",
"start": "2019-08-24T14:15:22Z"
},
"status": "CANCELLED"
}
Responses¶
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | A given prediction data export user can view is retrieved. | ExportEntity |
403 | Forbidden | User does not have permission to access a particular deployment or prediction data export. | None |
404 | Not Found | Resource not found. | None |
To perform this operation, you must be authenticated by means of one of the following methods:
BearerAuth
PATCH /api/v2/deployments/{deploymentId}/predictionDataExports/{exportId}/¶
Update prediction data export.
Code samples¶
# You can also use wget
curl -X PATCH https://app.datarobot.com/api/v2/deployments/{deploymentId}/predictionDataExports/{exportId}/ \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {access-token}" \
-d '{undefined}'
Body parameter¶
{
"status": "CANCELLED"
}
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
deploymentId | path | string | true | Unique identifier of the deployment. |
exportId | path | string | true | Unique identifier of the export. |
body | body | PredictionDataUpdate | false | none |
Example responses¶
204 Response
{
"associationIds": [
"string"
],
"augmentationType": "NO_AUGMENTATION",
"batches": [
{
"batchId": "string",
"batchName": "string"
}
],
"createdAt": "2019-08-24T14:15:22Z",
"createdBy": "string",
"data": [
{
"id": "string",
"name": "string"
}
],
"error": {
"message": "string"
},
"id": "string",
"modelId": "string",
"period": {
"end": "2019-08-24T14:15:22Z",
"start": "2019-08-24T14:15:22Z"
},
"status": "CANCELLED"
}
Responses¶
Status | Meaning | Description | Schema |
---|---|---|---|
204 | No Content | Prediction data export successfully updated. | ExportEntity |
403 | Forbidden | User does not have permission to update a prediction data export. | None |
404 | Not Found | Requested resource does not exist or the user does not have permission to view it. | None |
422 | Unprocessable Entity | Unable to process the prediction data export update. | None |
To perform this operation, you must be authenticated by means of one of the following methods:
BearerAuth
POST /api/v2/deployments/{deploymentId}/predictionInputs/fromDataset/¶
Assigns prediction dataset to the external deployment to enable the analysis of historical model performance. Multiple datasets containing historical predictions for the external deployment can be uploaded. This requires one request for each dataset. For a regression deployment, predictions can be either an int or float. For a classification (binary/multiclass) deployment, predictions must be lists with each list containing probabilities for each class.
Code samples¶
# You can also use wget
curl -X POST https://app.datarobot.com/api/v2/deployments/{deploymentId}/predictionInputs/fromDataset/ \
-H "Content-Type: application/json" \
-H "Authorization: Bearer {access-token}" \
-d '{undefined}'
Body parameter¶
{
"datasetId": "string",
"datasetVersionId": "string"
}
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
deploymentId | path | string | true | Unique identifier of the deployment. |
body | body | PredictionDatasetAssignment | false | none |
Responses¶
Status | Meaning | Description | Schema |
---|---|---|---|
202 | Accepted | Submitted successfully. | None |
405 | Method Not Allowed | Data can only be uploaded to an external deployment. | None |
422 | Unprocessable Entity | Unable to process predictions upload. | None |
To perform this operation, you must be authenticated by means of one of the following methods:
BearerAuth
GET /api/v2/deployments/{deploymentId}/predictionResults/¶
Retrieve predictions results of the deployment.
Code samples¶
# You can also use wget
curl -X GET https://app.datarobot.com/api/v2/deployments/{deploymentId}/predictionResults/ \
-H "Accept: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {access-token}"
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
offset | query | integer | false | Number of results to skip. |
limit | query | integer | false | At most this many results are returned. The default may change without notice. |
modelId | query | string | false | The id of the model for which prediction results are being retrieved. |
start | query | string(date-time) | false | Start of the period for which prediction results are being retrieved. |
end | query | string(date-time) | false | End of the period for which prediction results are being retrieved. |
batchId | query | any | false | The id of the batch for which prediction results are being retrieved. |
actualsPresent | query | boolean | false | Filters predictions results to only those who have actuals present or with missing actuals. |
deploymentId | path | string | true | Unique identifier of the deployment. |
Accept | header | string | false | Requested MIME type for the returned data |
Enumerated Values¶
Parameter | Value |
---|---|
Accept | [application/json , text/csv ] |
Example responses¶
200 Response
{
"associationIdColumnNames": [
"string"
],
"count": 0,
"data": [
{
"actual": 0,
"associationId": "string",
"forecastDistance": 0,
"modelId": "string",
"predicted": 0,
"timestamp": "2019-08-24T14:15:22Z"
}
],
"next": "http://example.com",
"previous": "http://example.com"
}
Responses¶
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | none | string |
To perform this operation, you must be authenticated by means of one of the following methods:
BearerAuth
GET /api/v2/deployments/{deploymentId}/predictionsOverBatch/¶
Retrieve metrics about predictions, such as row count, mean predicted value, mean probabilities, and class distribution, over batches.
Code samples¶
# You can also use wget
curl -X GET https://app.datarobot.com/api/v2/deployments/{deploymentId}/predictionsOverBatch/ \
-H "Accept: application/json" \
-H "Authorization: Bearer {access-token}"
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
segmentAttribute | query | string | false | The name of the segment on which segment analysis is being performed. |
segmentValue | query | string | false | The value of the segmentAttribute to segment on. |
batchId | query | any | false | The id of the batch for which metrics are being retrieved. |
modelId | query | string | false | The id of the model for which metrics are being retrieved. |
includePercentiles | query | string | false | Include percentiles in the response, only applicable to deployments with binary classification and regression target. |
deploymentId | path | string | true | Unique identifier of the deployment. |
Enumerated Values¶
Parameter | Value |
---|---|
includePercentiles | [false , False , true , True ] |
Example responses¶
200 Response
{
"baselines": [
{
"classDistribution": [
{
"className": "string",
"count": 0,
"percent": 0
}
],
"meanPredictedValue": 0,
"meanProbabilities": [
{
"className": "string",
"value": 0
}
],
"modelId": "string",
"percentiles": [
{
"percent": 0,
"value": 0
}
],
"predictionsWarningCount": 0,
"rowCount": 0
}
],
"buckets": [
{
"batch": {
"earliestPredictionTimestamp": "2019-08-24T14:15:22Z",
"id": "string",
"latestPredictionTimestamp": "2019-08-24T14:15:22Z",
"name": "string"
},
"classDistribution": [
{
"className": "string",
"count": 0,
"percent": 0
}
],
"meanPredictedValue": 0,
"meanProbabilities": [
{
"className": "string",
"value": 0
}
],
"percentiles": [
{
"percent": 0,
"value": 0
}
],
"predictionsWarningCount": 0,
"rowCount": 0
}
],
"segmentAttribute": "string",
"segmentValue": ""
}
Responses¶
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Predictions over batch info retrieved. | PredictionsOverBatchResponse |
To perform this operation, you must be authenticated by means of one of the following methods:
BearerAuth
GET /api/v2/deployments/{deploymentId}/predictionsOverSpace/¶
Retrieve predictions stats for the deployment over the geospatial feature data.
Notice: Endpoint is currently in [PUBLIC_PREVIEW]. Do not use it in production workflows to reduce risk. See details:
This endpoint depends on the following features that are subject to change.
Feature Flag | Maturity | Enabled by default | Description |
---|---|---|---|
MMM_GEOSPATIAL_FEATURES_MONITORING | PUBLIC_PREVIEW | true | Enables monitoring geospatial features. |
Code samples¶
# You can also use wget
curl -X GET https://app.datarobot.com/api/v2/deployments/{deploymentId}/predictionsOverSpace/ \
-H "Accept: application/json" \
-H "Authorization: Bearer {access-token}"
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
start | query | string(date-time) | false | Start of the period to retrieve monitoring data, defaults to 7 days ago from the end of the period. Note: this field only accepts top of the hour RFC3339 datetime strings, for example: 2019-08-01T00:00:00Z . |
end | query | string(date-time) | false | End of the period to retrieve monitoring data, defaults to the next top of the hour. Note: this field only accepts top of the hour RFC3339 datetime strings, for example: 2019-08-01T00:00:00Z . |
geoFeatureName | query | string | false | The name of the geospatial feature. Segmented analysis must be enabled for the feature specified. |
modelId | query | string | false | The ID of the model that feature drift is being retrieved from. |
targetClass | query | any | false | Target class to filter out results. |
deploymentId | path | string | true | Unique identifier of the deployment. |
Example responses¶
200 Response
{
"baselines": [
{
"classDistribution": [
{
"className": "string",
"count": 0,
"percent": 0
}
],
"hexagon": "string",
"meanPredictedValue": 0,
"meanProbabilities": [
{
"className": "string",
"value": 0
}
],
"percentiles": [
{
"percent": 0,
"value": 0
}
],
"predictionsWarningCount": 0,
"rowCount": 0
}
],
"buckets": [
{
"classDistribution": [
{
"className": "string",
"count": 0,
"percent": 0
}
],
"hexagon": "string",
"meanPredictedValue": 0,
"meanProbabilities": [
{
"className": "string",
"value": 0
}
],
"percentiles": [
{
"percent": 0,
"value": 0
}
],
"predictionsWarningCount": 0,
"rowCount": 0
}
],
"geoFeatureName": "string",
"modelId": "string",
"period": {
"end": "2019-08-24T14:15:22Z",
"start": "2019-08-24T14:15:22Z"
}
}
Responses¶
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | The retrieved prediction stats for the specified feature over the specified geospatial feature data. | PredictionsOverSpaceResponse |
To perform this operation, you must be authenticated by means of one of the following methods:
BearerAuth
GET /api/v2/deployments/{deploymentId}/predictionsOverTime/¶
Retrieve metrics about predictions, such as row count, mean predicted value, mean probabilities, and class distribution, over a specific time range.
Code samples¶
# You can also use wget
curl -X GET https://app.datarobot.com/api/v2/deployments/{deploymentId}/predictionsOverTime/ \
-H "Accept: application/json" \
-H "Authorization: Bearer {access-token}"
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
start | query | string(date-time) | false | Start of the period to retrieve monitoring data, defaults to 7 days ago from the end of the period. Note: this field only accepts top of the hour RFC3339 datetime strings, for example: 2019-08-01T00:00:00Z . |
end | query | string(date-time) | false | End of the period to retrieve monitoring data, defaults to the next top of the hour. Note: this field only accepts top of the hour RFC3339 datetime strings, for example: 2019-08-01T00:00:00Z . |
bucketSize | query | string | false | Time duration of buckets |
segmentAttribute | query | string | false | The name of the segment on which segment analysis is being performed. |
segmentValue | query | string | false | The value of the segmentAttribute to segment on. |
modelId | query | any | false | The id of the models for which metrics are being retrieved. |
targetClass | query | any | false | Target class to filter out results. |
includePercentiles | query | string | false | Include percentiles in the response, only applicable to deployments with binary classification and regression target. |
deploymentId | path | string | true | Unique identifier of the deployment. |
Enumerated Values¶
Parameter | Value |
---|---|
bucketSize | [PT1H , P1D , P7D , P1M ] |
includePercentiles | [false , False , true , True ] |
Example responses¶
200 Response
{
"baselines": [
{
"classDistribution": [
{
"className": "string",
"count": 0,
"percent": 0
}
],
"meanPredictedValue": 0,
"meanProbabilities": [
{
"className": "string",
"value": 0
}
],
"modelId": "string",
"percentiles": [
{
"percent": 0,
"value": 0
}
],
"predictionsWarningCount": 0,
"rowCount": 0
}
],
"buckets": [
{
"classDistribution": [
{
"className": "string",
"count": 0,
"percent": 0
}
],
"meanPredictedValue": 0,
"meanProbabilities": [
{
"className": "string",
"value": 0
}
],
"modelId": "string",
"percentiles": [
{
"percent": 0,
"value": 0
}
],
"period": {
"end": "2019-08-24T14:15:22Z",
"start": "2019-08-24T14:15:22Z"
},
"predictionsWarningCount": 0,
"rowCount": 0
}
],
"segmentAttribute": "string",
"segmentValue": ""
}
Responses¶
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Predictions over time info retrieved. | PredictionsOverTimeResponse |
To perform this operation, you must be authenticated by means of one of the following methods:
BearerAuth
GET /api/v2/deployments/{deploymentId}/predictionsVsActualsOverBatch/¶
Retrieve metrics about predictions and actuals, such as mean predicted & actual value, predicted & actual class distribution, over a specific set of batches.
Code samples¶
# You can also use wget
curl -X GET https://app.datarobot.com/api/v2/deployments/{deploymentId}/predictionsVsActualsOverBatch/ \
-H "Accept: application/json" \
-H "Authorization: Bearer {access-token}"
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
segmentAttribute | query | string | false | The name of the segment on which segment analysis is being performed. |
segmentValue | query | string | false | The value of the segmentAttribute to segment on. |
modelId | query | string | false | The id of the model for which metrics are being retrieved. |
batchId | query | any | false | The id of the batch for which metrics are being retrieved. |
targetClass | query | any | false | Target class to filter out results. |
deploymentId | path | string | true | Unique identifier of the deployment. |
Example responses¶
200 Response
{
"baselines": [
{
"actualClassDistribution": [
{
"className": "string",
"count": 0,
"percent": 0
}
],
"meanActualValue": 0,
"meanPredictedValue": 0,
"modelId": "string",
"predictedClassDistribution": [
{
"className": "string",
"count": 0,
"percent": 0
}
],
"rowCountTotal": 0,
"rowCountWithActual": 0
}
],
"buckets": [
{
"actualClassDistribution": [
{
"className": "string",
"count": 0,
"percent": 0
}
],
"batchId": "string",
"batchName": "string",
"meanActualValue": 0,
"meanPredictedValue": 0,
"modelId": "string",
"period": {
"end": "2019-08-24T14:15:22Z",
"start": "2019-08-24T14:15:22Z"
},
"predictedClassDistribution": [
{
"className": "string",
"count": 0,
"percent": 0
}
],
"rowCountTotal": 0,
"rowCountWithActual": 0
}
],
"segmentAttribute": "string",
"segmentValue": ""
}
Responses¶
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Predictions vs actuals over batch info. | PredictionsVsActualsOverBatchResponse |
To perform this operation, you must be authenticated by means of one of the following methods:
BearerAuth
GET /api/v2/deployments/{deploymentId}/predictionsVsActualsOverSpace/¶
Retrieve predictions vs. actuals over space.
Code samples¶
# You can also use wget
curl -X GET https://app.datarobot.com/api/v2/deployments/{deploymentId}/predictionsVsActualsOverSpace/ \
-H "Accept: application/json" \
-H "Authorization: Bearer {access-token}"
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
start | query | string(date-time) | false | Start of the period to retrieve monitoring data, defaults to 7 days ago from the end of the period. Note: this field only accepts top of the hour RFC3339 datetime strings, for example: 2019-08-01T00:00:00Z . |
end | query | string(date-time) | false | End of the period to retrieve monitoring data, defaults to the next top of the hour. Note: this field only accepts top of the hour RFC3339 datetime strings, for example: 2019-08-01T00:00:00Z . |
modelId | query | string | false | The ID of the model for which metrics are being retrieved. |
geoFeatureName | query | string | false | The name of the geospatial feature. |
targetClass | query | any | false | Target class to filter out results. |
deploymentId | path | string | true | Unique identifier of the deployment. |
Example responses¶
200 Response
{
"baselines": [
{
"actualClassDistribution": [
{
"className": "string",
"count": 0,
"percent": 0
}
],
"hexagon": "string",
"meanActualValue": 0,
"meanPredictedValue": 0,
"predictedClassDistribution": [
{
"className": "string",
"count": 0,
"percent": 0
}
],
"rowCountTotal": 0,
"rowCountWithActual": 0
}
],
"buckets": [
{
"actualClassDistribution": [
{
"className": "string",
"count": 0,
"percent": 0
}
],
"hexagon": "string",
"meanActualValue": 0,
"meanPredictedValue": 0,
"predictedClassDistribution": [
{
"className": "string",
"count": 0,
"percent": 0
}
],
"rowCountTotal": 0,
"rowCountWithActual": 0
}
],
"geoFeatureName": "string",
"modelId": "string",
"period": {
"end": "2019-08-24T14:15:22Z",
"start": "2019-08-24T14:15:22Z"
},
"summary": {
"rowCountTotal": 0,
"rowCountWithActual": 0
}
}
Responses¶
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Predictions vs. actuals over space. | PredictionsVsActualsOverSpaceResponse |
To perform this operation, you must be authenticated by means of one of the following methods:
BearerAuth
GET /api/v2/deployments/{deploymentId}/predictionsVsActualsOverTime/¶
Retrieve metrics about predictions and actuals, such as mean predicted & actual value, predicted & actual class distribution, over a specific time range.
Code samples¶
# You can also use wget
curl -X GET https://app.datarobot.com/api/v2/deployments/{deploymentId}/predictionsVsActualsOverTime/ \
-H "Accept: application/json" \
-H "Authorization: Bearer {access-token}"
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
start | query | string(date-time) | false | Start of the period to retrieve monitoring data, defaults to 7 days ago from the end of the period. Note: this field only accepts top of the hour RFC3339 datetime strings, for example: 2019-08-01T00:00:00Z . |
end | query | string(date-time) | false | End of the period to retrieve monitoring data, defaults to the next top of the hour. Note: this field only accepts top of the hour RFC3339 datetime strings, for example: 2019-08-01T00:00:00Z . |
bucketSize | query | string | false | Time duration of buckets |
segmentAttribute | query | string | false | The name of the segment on which segment analysis is being performed. |
segmentValue | query | string | false | The value of the segmentAttribute to segment on. |
modelId | query | any | false | The id of the models for which metrics are being retrieved. |
targetClass | query | any | false | Target class to filter out results. |
deploymentId | path | string | true | Unique identifier of the deployment. |
Enumerated Values¶
Parameter | Value |
---|---|
bucketSize | [PT1H , P1D , P7D , P1M ] |
Example responses¶
200 Response
{
"baselines": [
{
"actualClassDistribution": [
{
"className": "string",
"count": 0,
"percent": 0
}
],
"meanActualValue": 0,
"meanPredictedValue": 0,
"modelId": "string",
"predictedClassDistribution": [
{
"className": "string",
"count": 0,
"percent": 0
}
],
"rowCountTotal": 0,
"rowCountWithActual": 0
}
],
"buckets": [
{
"actualClassDistribution": [
{
"className": "string",
"count": 0,
"percent": 0
}
],
"meanActualValue": 0,
"meanPredictedValue": 0,
"modelId": "string",
"period": {
"end": "2019-08-24T14:15:22Z",
"start": "2019-08-24T14:15:22Z"
},
"predictedClassDistribution": [
{
"className": "string",
"count": 0,
"percent": 0
}
],
"rowCountTotal": 0,
"rowCountWithActual": 0
}
],
"segmentAttribute": "string",
"segmentValue": "",
"summary": {
"rowCountTotal": 0,
"rowCountWithActual": 0
}
}
Responses¶
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Predictions vs actuals over time info. | PredictionsVsActualsOverTimeResponse |
To perform this operation, you must be authenticated by means of one of the following methods:
BearerAuth
GET /api/v2/deployments/{deploymentId}/retrainingPolicies/¶
Retrieve a list of deployment retraining policies.
Code samples¶
# You can also use wget
curl -X GET https://app.datarobot.com/api/v2/deployments/{deploymentId}/retrainingPolicies/ \
-H "Accept: application/json" \
-H "Authorization: Bearer {access-token}"
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
offset | query | integer | false | Number of results to skip. |
limit | query | integer | false | At most this many results are returned. The default may change without notice. |
deploymentId | path | string | true | Unique identifier of the deployment. |
Example responses¶
200 Response
{
"count": 0,
"data": [
{
"action": "create_challenger",
"autopilotOptions": {
"blendBestModels": true,
"mode": "auto",
"runLeakageRemovedFeatureList": true,
"scoringCodeOnly": true,
"shapOnlyMode": true
},
"description": "string",
"featureListStrategy": "informative_features",
"id": "string",
"latestRun": {
"challengerId": "string",
"errorMessage": "string",
"finishTime": "2019-08-24T14:15:22Z",
"id": "string",
"modelPackageId": "string",
"projectId": "string",
"registeredModelId": "string",
"startTime": "2019-08-24T14:15:22Z",
"status": "string"
},
"modelSelectionStrategy": "autopilot_recommended",
"name": "string",
"projectOptions": {
"cvMethod": "RandomCV",
"holdoutPct": null,
"metric": "Accuracy",
"reps": null,
"validationPct": null,
"validationType": "CV"
},
"projectOptionsStrategy": "same_as_champion",
"timeSeriesOptions": {
"calendarId": "string",
"differencingMethod": "auto",
"exponentiallyWeightedMovingAlpha": 0,
"periodicities": [
{
"timeSteps": 0,
"timeUnit": "MILLISECOND"
}
],
"treatAsExponential": "auto"
},
"trigger": {
"minIntervalBetweenRuns": "string",
"schedule": {
"dayOfMonth": [
"*"
],
"dayOfWeek": [
"*"
],
"hour": [
"*"
],
"minute": [
"*"
],
"month": [
"*"
]
},
"statusDeclinesToFailing": true,
"statusDeclinesToWarning": true,
"statusStillInDecline": true,
"type": "schedule"
}
}
],
"next": "http://example.com",
"previous": "http://example.com",
"totalCount": 0
}
Responses¶
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Retrieve a list of deployment retraining policies. | RetrainingPolicyListResponse |
404 | Not Found | Deployment not found. | None |
To perform this operation, you must be authenticated by means of one of the following methods:
BearerAuth
POST /api/v2/deployments/{deploymentId}/retrainingPolicies/¶
Create a deployment retraining policy.
Code samples¶
# You can also use wget
curl -X POST https://app.datarobot.com/api/v2/deployments/{deploymentId}/retrainingPolicies/ \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {access-token}" \
-d '{undefined}'
Body parameter¶
{
"action": "create_challenger",
"autopilotOptions": {
"blendBestModels": true,
"mode": "auto",
"runLeakageRemovedFeatureList": true,
"scoringCodeOnly": true,
"shapOnlyMode": true
},
"description": null,
"featureListStrategy": "informative_features",
"modelSelectionStrategy": "autopilot_recommended",
"name": "string",
"projectOptions": {
"cvMethod": "RandomCV",
"holdoutPct": null,
"metric": "Accuracy",
"reps": null,
"validationPct": null,
"validationType": "CV"
},
"projectOptionsStrategy": "same_as_champion",
"timeSeriesOptions": {
"calendarId": "string",
"differencingMethod": "auto",
"exponentiallyWeightedMovingAlpha": 0,
"periodicities": [
{
"timeSteps": 0,
"timeUnit": "MILLISECOND"
}
],
"treatAsExponential": "auto"
},
"trigger": {
"minIntervalBetweenRuns": "string",
"schedule": {
"dayOfMonth": [
"*"
],
"dayOfWeek": [
"*"
],
"hour": [
"*"
],
"minute": [
"*"
],
"month": [
"*"
]
},
"statusDeclinesToFailing": true,
"statusDeclinesToWarning": true,
"statusStillInDecline": true,
"type": "schedule"
}
}
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
deploymentId | path | string | true | Unique identifier of the deployment. |
body | body | RetrainingPolicyCreate | false | none |
Example responses¶
200 Response
{
"action": "create_challenger",
"autopilotOptions": {
"blendBestModels": true,
"mode": "auto",
"runLeakageRemovedFeatureList": true,
"scoringCodeOnly": true,
"shapOnlyMode": true
},
"description": "string",
"featureListStrategy": "informative_features",
"id": "string",
"latestRun": {
"challengerId": "string",
"errorMessage": "string",
"finishTime": "2019-08-24T14:15:22Z",
"id": "string",
"modelPackageId": "string",
"projectId": "string",
"registeredModelId": "string",
"startTime": "2019-08-24T14:15:22Z",
"status": "string"
},
"modelSelectionStrategy": "autopilot_recommended",
"name": "string",
"projectOptions": {
"cvMethod": "RandomCV",
"holdoutPct": null,
"metric": "Accuracy",
"reps": null,
"validationPct": null,
"validationType": "CV"
},
"projectOptionsStrategy": "same_as_champion",
"timeSeriesOptions": {
"calendarId": "string",
"differencingMethod": "auto",
"exponentiallyWeightedMovingAlpha": 0,
"periodicities": [
{
"timeSteps": 0,
"timeUnit": "MILLISECOND"
}
],
"treatAsExponential": "auto"
},
"trigger": {
"minIntervalBetweenRuns": "string",
"schedule": {
"dayOfMonth": [
"*"
],
"dayOfWeek": [
"*"
],
"hour": [
"*"
],
"minute": [
"*"
],
"month": [
"*"
]
},
"statusDeclinesToFailing": true,
"statusDeclinesToWarning": true,
"statusStillInDecline": true,
"type": "schedule"
}
}
Responses¶
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | none | RetrainingPolicyRetrieve |
404 | Not Found | Deployment not found. | None |
To perform this operation, you must be authenticated by means of one of the following methods:
BearerAuth
DELETE /api/v2/deployments/{deploymentId}/retrainingPolicies/{retrainingPolicyId}/¶
Delete a deployment retraining policy.
Code samples¶
# You can also use wget
curl -X DELETE https://app.datarobot.com/api/v2/deployments/{deploymentId}/retrainingPolicies/{retrainingPolicyId}/ \
-H "Authorization: Bearer {access-token}"
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
deploymentId | path | string | true | Unique identifier of the deployment. |
retrainingPolicyId | path | string | true | ID of the retraining policy. |
Responses¶
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Delete a deployment retraining policy. | None |
404 | Not Found | Deployment or retraining policy not found. | None |
To perform this operation, you must be authenticated by means of one of the following methods:
BearerAuth
GET /api/v2/deployments/{deploymentId}/retrainingPolicies/{retrainingPolicyId}/¶
Retrieve a deployment retraining policy.
Code samples¶
# You can also use wget
curl -X GET https://app.datarobot.com/api/v2/deployments/{deploymentId}/retrainingPolicies/{retrainingPolicyId}/ \
-H "Accept: application/json" \
-H "Authorization: Bearer {access-token}"
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
deploymentId | path | string | true | Unique identifier of the deployment. |
retrainingPolicyId | path | string | true | ID of the retraining policy. |
Example responses¶
200 Response
{
"action": "create_challenger",
"autopilotOptions": {
"blendBestModels": true,
"mode": "auto",
"runLeakageRemovedFeatureList": true,
"scoringCodeOnly": true,
"shapOnlyMode": true
},
"description": "string",
"featureListStrategy": "informative_features",
"id": "string",
"latestRun": {
"challengerId": "string",
"errorMessage": "string",
"finishTime": "2019-08-24T14:15:22Z",
"id": "string",
"modelPackageId": "string",
"projectId": "string",
"registeredModelId": "string",
"startTime": "2019-08-24T14:15:22Z",
"status": "string"
},
"modelSelectionStrategy": "autopilot_recommended",
"name": "string",
"projectOptions": {
"cvMethod": "RandomCV",
"holdoutPct": null,
"metric": "Accuracy",
"reps": null,
"validationPct": null,
"validationType": "CV"
},
"projectOptionsStrategy": "same_as_champion",
"timeSeriesOptions": {
"calendarId": "string",
"differencingMethod": "auto",
"exponentiallyWeightedMovingAlpha": 0,
"periodicities": [
{
"timeSteps": 0,
"timeUnit": "MILLISECOND"
}
],
"treatAsExponential": "auto"
},
"trigger": {
"minIntervalBetweenRuns": "string",
"schedule": {
"dayOfMonth": [
"*"
],
"dayOfWeek": [
"*"
],
"hour": [
"*"
],
"minute": [
"*"
],
"month": [
"*"
]
},
"statusDeclinesToFailing": true,
"statusDeclinesToWarning": true,
"statusStillInDecline": true,
"type": "schedule"
}
}
Responses¶
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Retrieve a deployment retraining policy. | RetrainingPolicyRetrieve |
404 | Not Found | Deployment or retraining policy not found. | None |
To perform this operation, you must be authenticated by means of one of the following methods:
BearerAuth
PATCH /api/v2/deployments/{deploymentId}/retrainingPolicies/{retrainingPolicyId}/¶
Update a deployment retraining policy.
Code samples¶
# You can also use wget
curl -X PATCH https://app.datarobot.com/api/v2/deployments/{deploymentId}/retrainingPolicies/{retrainingPolicyId}/ \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {access-token}" \
-d '{undefined}'
Body parameter¶
{
"action": "create_challenger",
"autopilotOptions": {
"blendBestModels": true,
"mode": "auto",
"runLeakageRemovedFeatureList": true,
"scoringCodeOnly": true,
"shapOnlyMode": true
},
"description": "string",
"featureListStrategy": "informative_features",
"modelSelectionStrategy": "autopilot_recommended",
"name": "string",
"projectOptions": {
"cvMethod": "RandomCV",
"holdoutPct": null,
"metric": "Accuracy",
"reps": null,
"validationPct": null,
"validationType": "CV"
},
"projectOptionsStrategy": "same_as_champion",
"timeSeriesOptions": {
"calendarId": "string",
"differencingMethod": "auto",
"exponentiallyWeightedMovingAlpha": 0,
"periodicities": [
{
"timeSteps": 0,
"timeUnit": "MILLISECOND"
}
],
"treatAsExponential": "auto"
},
"trigger": {
"minIntervalBetweenRuns": "string",
"schedule": {
"dayOfMonth": [
"*"
],
"dayOfWeek": [
"*"
],
"hour": [
"*"
],
"minute": [
"*"
],
"month": [
"*"
]
},
"statusDeclinesToFailing": true,
"statusDeclinesToWarning": true,
"statusStillInDecline": true,
"type": "schedule"
}
}
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
deploymentId | path | string | true | Unique identifier of the deployment. |
retrainingPolicyId | path | string | true | ID of the retraining policy. |
body | body | RetrainingPolicyUpdate | false | none |
Example responses¶
200 Response
{
"action": "create_challenger",
"autopilotOptions": {
"blendBestModels": true,
"mode": "auto",
"runLeakageRemovedFeatureList": true,
"scoringCodeOnly": true,
"shapOnlyMode": true
},
"description": "string",
"featureListStrategy": "informative_features",
"id": "string",
"latestRun": {
"challengerId": "string",
"errorMessage": "string",
"finishTime": "2019-08-24T14:15:22Z",
"id": "string",
"modelPackageId": "string",
"projectId": "string",
"registeredModelId": "string",
"startTime": "2019-08-24T14:15:22Z",
"status": "string"
},
"modelSelectionStrategy": "autopilot_recommended",
"name": "string",
"projectOptions": {
"cvMethod": "RandomCV",
"holdoutPct": null,
"metric": "Accuracy",
"reps": null,
"validationPct": null,
"validationType": "CV"
},
"projectOptionsStrategy": "same_as_champion",
"timeSeriesOptions": {
"calendarId": "string",
"differencingMethod": "auto",
"exponentiallyWeightedMovingAlpha": 0,
"periodicities": [
{
"timeSteps": 0,
"timeUnit": "MILLISECOND"
}
],
"treatAsExponential": "auto"
},
"trigger": {
"minIntervalBetweenRuns": "string",
"schedule": {
"dayOfMonth": [
"*"
],
"dayOfWeek": [
"*"
],
"hour": [
"*"
],
"minute": [
"*"
],
"month": [
"*"
]
},
"statusDeclinesToFailing": true,
"statusDeclinesToWarning": true,
"statusStillInDecline": true,
"type": "schedule"
}
}
Responses¶
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | none | RetrainingPolicyRetrieve |
404 | Not Found | Deployment or retraining policy not found. | None |
To perform this operation, you must be authenticated by means of one of the following methods:
BearerAuth
GET /api/v2/deployments/{deploymentId}/retrainingPolicies/{retrainingPolicyId}/runs/¶
Retrieve a list of deployment retraining policy runs.
Code samples¶
# You can also use wget
curl -X GET https://app.datarobot.com/api/v2/deployments/{deploymentId}/retrainingPolicies/{retrainingPolicyId}/runs/ \
-H "Accept: application/json" \
-H "Authorization: Bearer {access-token}"
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
offset | query | integer | false | Number of results to skip. |
limit | query | integer | false | At most this many results are returned. The default may change without notice. |
deploymentId | path | string | true | Unique identifier of the deployment. |
retrainingPolicyId | path | string | true | ID of the retraining policy. |
Example responses¶
200 Response
{
"count": 0,
"data": [
{
"challengerId": "string",
"errorMessage": "string",
"finishTime": "2019-08-24T14:15:22Z",
"id": "string",
"modelPackageId": "string",
"projectId": "string",
"registeredModelId": "string",
"startTime": "2019-08-24T14:15:22Z",
"status": "string"
}
],
"next": "http://example.com",
"previous": "http://example.com",
"totalCount": 0
}
Responses¶
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Retrieve a list of deployment retraining policy runs. | RetrainingPolicyRunListResponse |
404 | Not Found | Deployment or retraining policy not found. | None |
To perform this operation, you must be authenticated by means of one of the following methods:
BearerAuth
POST /api/v2/deployments/{deploymentId}/retrainingPolicies/{retrainingPolicyId}/runs/¶
Initiate a deployment retraining policy run.
Code samples¶
# You can also use wget
curl -X POST https://app.datarobot.com/api/v2/deployments/{deploymentId}/retrainingPolicies/{retrainingPolicyId}/runs/ \
-H "Authorization: Bearer {access-token}"
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
deploymentId | path | string | true | Unique identifier of the deployment. |
retrainingPolicyId | path | string | true | ID of the retraining policy. |
Responses¶
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | none | None |
404 | Not Found | Deployment or retraining policy not found. | None |
To perform this operation, you must be authenticated by means of one of the following methods:
BearerAuth
GET /api/v2/deployments/{deploymentId}/retrainingPolicies/{retrainingPolicyId}/runs/{runId}/¶
Retrieve a single deployment retraining policy run.
Code samples¶
# You can also use wget
curl -X GET https://app.datarobot.com/api/v2/deployments/{deploymentId}/retrainingPolicies/{retrainingPolicyId}/runs/{runId}/ \
-H "Accept: application/json" \
-H "Authorization: Bearer {access-token}"
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
deploymentId | path | string | true | Unique identifier of the deployment. |
retrainingPolicyId | path | string | true | ID of the retraining policy. |
runId | path | string | true | ID of the retraining policy run. |
Example responses¶
200 Response
{
"challengerId": "string",
"errorMessage": "string",
"finishTime": "2019-08-24T14:15:22Z",
"id": "string",
"modelPackageId": "string",
"projectId": "string",
"registeredModelId": "string",
"startTime": "2019-08-24T14:15:22Z",
"status": "string"
}
Responses¶
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Retrieve a single deployment retraining policy run. | RetrainingPolicyRunRetrieve |
404 | Not Found | Deployment or retraining policy not found. | None |
To perform this operation, you must be authenticated by means of one of the following methods:
BearerAuth
PATCH /api/v2/deployments/{deploymentId}/retrainingPolicies/{retrainingPolicyId}/runs/{runId}/¶
Update a single deployment retraining policy run.
Code samples¶
# You can also use wget
curl -X PATCH https://app.datarobot.com/api/v2/deployments/{deploymentId}/retrainingPolicies/{retrainingPolicyId}/runs/{runId}/ \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {access-token}" \
-d '{undefined}'
Body parameter¶
{
"status": "cancelled"
}
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
deploymentId | path | string | true | Unique identifier of the deployment. |
retrainingPolicyId | path | string | true | ID of the retraining policy. |
runId | path | string | true | ID of the retraining policy run. |
body | body | RetrainingPolicyRunUpdate | false | none |
Example responses¶
200 Response
{
"challengerId": "string",
"errorMessage": "string",
"finishTime": "2019-08-24T14:15:22Z",
"id": "string",
"modelPackageId": "string",
"projectId": "string",
"registeredModelId": "string",
"startTime": "2019-08-24T14:15:22Z",
"status": "string"
}
Responses¶
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Update a single deployment retraining policy run. | RetrainingPolicyRunRetrieve |
404 | Not Found | Deployment or retraining policy not found. | None |
To perform this operation, you must be authenticated by means of one of the following methods:
BearerAuth
GET /api/v2/deployments/{deploymentId}/retrainingSettings/¶
Retrieve deployment retraining settings.
Code samples¶
# You can also use wget
curl -X GET https://app.datarobot.com/api/v2/deployments/{deploymentId}/retrainingSettings/ \
-H "Accept: application/json" \
-H "Authorization: Bearer {access-token}"
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
deploymentId | path | string | true | Unique identifier of the deployment. |
Example responses¶
200 Response
{
"dataset": {
"id": "string",
"name": "string"
},
"predictionEnvironment": {
"id": "string",
"name": "string"
},
"retrainingUser": {
"id": "string",
"username": "string"
}
}
Responses¶
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Retrieve deployment retraining settings. | RetrainingSettingsRetrieve |
404 | Not Found | Deployment not found. | None |
To perform this operation, you must be authenticated by means of one of the following methods:
BearerAuth
PATCH /api/v2/deployments/{deploymentId}/retrainingSettings/¶
Update deployment retraining settings.
Code samples¶
# You can also use wget
curl -X PATCH https://app.datarobot.com/api/v2/deployments/{deploymentId}/retrainingSettings/ \
-H "Content-Type: application/json" \
-H "Authorization: Bearer {access-token}" \
-d '{undefined}'
Body parameter¶
{
"credentialId": "string",
"datasetId": "string",
"predictionEnvironmentId": "string",
"retrainingUserId": "string"
}
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
deploymentId | path | string | true | Unique identifier of the deployment. |
body | body | RetrainingSettingsUpdate | false | none |
Responses¶
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Update deployment retraining settings. | None |
404 | Not Found | Deployment not found. | None |
To perform this operation, you must be authenticated by means of one of the following methods:
BearerAuth
GET /api/v2/deployments/{deploymentId}/runtimeParameters/¶
List runtime parameters.
Notice: Endpoint is currently in [PUBLIC_PREVIEW]. Do not use it in production workflows to reduce risk. See details:
This endpoint depends on the following features that are subject to change.
Feature Flag | Maturity | Enabled by default | Description |
---|---|---|---|
CUSTOM_MODEL_EDIT_RUNTIME_PARAMETERS_ON_DEPLOYMENT | PUBLIC_PREVIEW | true | Enables the ability to edit Custom Model Runtime-Parameters (and replica and resource bundle settings) directly from the Deployment info page. Edited values are local to a given Deployment and do not affect the runtime of any current or future Deployments of the same Model Package. |
Code samples¶
# You can also use wget
curl -X GET https://app.datarobot.com/api/v2/deployments/{deploymentId}/runtimeParameters/?orderBy=createdAt \
-H "Accept: application/json" \
-H "Authorization: Bearer {access-token}"
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
offset | query | integer | false | Number of results to skip. |
limit | query | integer | false | At most this many results are returned. The default may change without notice. |
orderBy | query | string | true | The sort order to apply to the runtime parameters list. Prefix the attribute name with a dash to sort in descending order; for example: '-created_at'. |
deploymentId | path | string | true | Unique identifier of the deployment. |
Enumerated Values¶
Parameter | Value |
---|---|
orderBy | [createdAt , -createdAt , name , -name ] |
Example responses¶
200 Response
{
"count": 0,
"data": [
{
"allowEmpty": true,
"credentialType": "adlsGen2Oauth",
"currentValue": "string",
"defaultValue": "string",
"description": "string",
"fieldName": "string",
"keyValueId": "string",
"maxValue": 0,
"minValue": 0,
"overrideValue": "string",
"type": "boolean"
}
],
"next": "http://example.com",
"previous": "http://example.com",
"totalCount": 0
}
Responses¶
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | none | RuntimeParameterListResponse |
To perform this operation, you must be authenticated by means of one of the following methods:
BearerAuth
PUT /api/v2/deployments/{deploymentId}/runtimeParameters/¶
Update runtime parameters by replacing existing params with the provided set. Any values not provided will revert back to the values set from the model package.
Notice: Endpoint is currently in [PUBLIC_PREVIEW]. Do not use it in production workflows to reduce risk. See details:
This endpoint depends on the following features that are subject to change.
Feature Flag | Maturity | Enabled by default | Description |
---|---|---|---|
CUSTOM_MODEL_EDIT_RUNTIME_PARAMETERS_ON_DEPLOYMENT | PUBLIC_PREVIEW | true | Enables the ability to edit Custom Model Runtime-Parameters (and replica and resource bundle settings) directly from the Deployment info page. Edited values are local to a given Deployment and do not affect the runtime of any current or future Deployments of the same Model Package. |
Code samples¶
# You can also use wget
curl -X PUT https://app.datarobot.com/api/v2/deployments/{deploymentId}/runtimeParameters/ \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {access-token}" \
-d '{undefined}'
Body parameter¶
{
"runtimeParameterValues": "string"
}
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
deploymentId | path | string | true | Unique identifier of the deployment. |
body | body | RuntimeParameterUpdate | false | none |
Example responses¶
200 Response
{
"count": 0,
"data": [
{
"allowEmpty": true,
"credentialType": "adlsGen2Oauth",
"currentValue": "string",
"defaultValue": "string",
"description": "string",
"fieldName": "string",
"keyValueId": "string",
"maxValue": 0,
"minValue": 0,
"overrideValue": "string",
"type": "boolean"
}
],
"next": "http://example.com",
"previous": "http://example.com",
"totalCount": 0
}
Responses¶
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | none | RuntimeParameterListResponse |
To perform this operation, you must be authenticated by means of one of the following methods:
BearerAuth
GET /api/v2/deployments/{deploymentId}/scoringCode/¶
Retrieve Scoring Code of the current deployed model for making predictions outside of a DataRobot prediction server. You need the "Scoring Code" feature enabled to use this route.
By default, returns a compiled executable JAR that can be executed locally to calculate model predictions, or it can be used as a library for a Java application. Execute it with the '--help` parameters to learn how to use it as a command-line utility. See model API documentation at https://javadoc.io/doc/com.datarobot/datarobot-prediction/latest/index.html to be able to use it inside an existing Java application.
With sourceCode query parameter set to 'true', returns a source code archive that can be used to review internal calculations of the model. This JAR is NOT executable.
See "https://docs.datarobot.com/en/docs/predictions/port-pred/scoring-code/index.html" documentation in DataRobot application for more information.
Note Cannot retrieve source code if agent is included.
Code samples¶
# You can also use wget
curl -X GET https://app.datarobot.com/api/v2/deployments/{deploymentId}/scoringCode/ \
-H "Authorization: Bearer {access-token}"
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
sourceCode | query | string | false | Whether source code or binary of the Scoring Code will be retrieved |
includeAgent | query | string | false | Whether the Scoring code retrieved will include tracking agent |
includePe | query | string | false | Please use includePredictionExplanations parameter instead |
includePredictionExplanations | query | string | false | Whether the Scoring Code retrieved will include prediction explanations |
includePredictionIntervals | query | string | false | Whether the Scoring Code retrieved will include prediction intervals |
deploymentId | path | string | true | Unique identifier of the deployment. |
Enumerated Values¶
Parameter | Value |
---|---|
sourceCode | [false , False , true , True ] |
includeAgent | [false , False , true , True ] |
includePe | [false , False , true , True ] |
includePredictionExplanations | [false , False , true , True ] |
includePredictionIntervals | [false , False , true , True ] |
Responses¶
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | JAR file | None |
Response Headers¶
Status | Header | Type | Format | Description |
---|---|---|---|---|
200 | Content-Disposition | string | Indicating the content is supposed to be downloaded as an attachment | |
200 | Content-Type | string | application/java-archive |
To perform this operation, you must be authenticated by means of one of the following methods:
BearerAuth
POST /api/v2/deployments/{deploymentId}/scoringCodeBuilds/¶
Build Java package containing Scoring Code with agent integration.
Code samples¶
# You can also use wget
curl -X POST https://app.datarobot.com/api/v2/deployments/{deploymentId}/scoringCodeBuilds/ \
-H "Content-Type: application/json" \
-H "Authorization: Bearer {access-token}" \
-d '{undefined}'
Body parameter¶
{
"includeAgent": true,
"includePredictionExplanations": true,
"includePredictionIntervals": true
}
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
deploymentId | path | string | true | Unique identifier of the deployment. |
body | body | DeploymentsScoringCodeBuildPayload | false | none |
Responses¶
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | none | None |
To perform this operation, you must be authenticated by means of one of the following methods:
BearerAuth
GET /api/v2/deployments/{deploymentId}/segmentAttributes/¶
Retrieve deployment segment attributes.
Code samples¶
# You can also use wget
curl -X GET https://app.datarobot.com/api/v2/deployments/{deploymentId}/segmentAttributes/ \
-H "Accept: application/json" \
-H "Authorization: Bearer {access-token}"
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
monitoringType | query | string | false | The monitoring type for which segment attributes are being retrieved. |
deploymentId | path | string | true | Unique identifier of the deployment. |
Enumerated Values¶
Parameter | Value |
---|---|
monitoringType | [serviceHealth , dataDrift , accuracy , humility , customMetrics ] |
Example responses¶
200 Response
{
"data": [
"string"
],
"monitoringType": "serviceHealth"
}
Responses¶
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | none | SegmentAttributesRetrieveResponse |
To perform this operation, you must be authenticated by means of one of the following methods:
BearerAuth
GET /api/v2/deployments/{deploymentId}/segmentValues/¶
Retrieve deployment segment values.
Code samples¶
# You can also use wget
curl -X GET https://app.datarobot.com/api/v2/deployments/{deploymentId}/segmentValues/ \
-H "Accept: application/json" \
-H "Authorization: Bearer {access-token}"
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
offset | query | integer | false | Number of results to skip. |
limit | query | integer | false | At most this many results are returned. The default may change without notice. |
segmentAttribute | query | string | false | The name of the segment attribute whose values the user wants to retrieve. |
search | query | string | false | The search query to filter the list of segment values. |
deploymentId | path | string | true | Unique identifier of the deployment. |
Example responses¶
200 Response
{
"count": 0,
"data": [
{
"segmentAttribute": "string",
"value": "string"
}
],
"next": "http://example.com",
"previous": "http://example.com",
"totalCount": 0
}
Responses¶
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | none | SegmentValuesRetrieveResponse |
To perform this operation, you must be authenticated by means of one of the following methods:
BearerAuth
GET /api/v2/deployments/{deploymentId}/serviceStats/¶
Retrieve all deployment service health metrics over a single period of time.
Code samples¶
# You can also use wget
curl -X GET https://app.datarobot.com/api/v2/deployments/{deploymentId}/serviceStats/ \
-H "Accept: application/json" \
-H "Authorization: Bearer {access-token}"
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
start | query | string(date-time) | false | Start of the period to retrieve monitoring data, defaults to 7 days ago from the end of the period. Note: this field only accepts top of the hour RFC3339 datetime strings, for example: 2019-08-01T00:00:00Z . |
end | query | string(date-time) | false | End of the period to retrieve monitoring data, defaults to the next top of the hour. Note: this field only accepts top of the hour RFC3339 datetime strings, for example: 2019-08-01T00:00:00Z . |
executionTimeQuantile | query | number | false | Quantile for executionTime metric. |
responseTimeQuantile | query | number | false | Quantile for responseTime metric. |
slowRequestsThreshold | query | integer | false | Threshold for slowRequests metric. |
segmentAttribute | query | string | false | The name of a segment attribute used for segment analysis. |
segmentValue | query | string | false | The value of the segmentAttribute to segment on. |
modelId | query | string | false | The id of the model for which metrics are being retrieved. |
deploymentId | path | string | true | Unique identifier of the deployment. |
Enumerated Values¶
Parameter | Value |
---|---|
segmentAttribute | [DataRobot-Consumer , DataRobot-Remote-IP , DataRobot-Host-IP ] |
Example responses¶
200 Response
{
"metrics": {
"cacheHitRatio": 0,
"executionTime": 0,
"medianLoad": 0,
"numConsumers": 0,
"peakLoad": 0,
"responseTime": 0,
"serverErrorRate": 0,
"slowRequests": 0,
"totalPredictions": 0,
"totalRequests": 0,
"userErrorRate": 0
},
"modelId": "string",
"period": {
"end": "2019-08-24T14:15:22Z",
"start": "2019-08-24T14:15:22Z"
},
"segmentAttribute": "string",
"segmentValue": ""
}
Responses¶
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Service health metric data retrieved. | ServiceStatsForTimeRangeResponse |
To perform this operation, you must be authenticated by means of one of the following methods:
BearerAuth
GET /api/v2/deployments/{deploymentId}/serviceStatsOverBatch/¶
Retrieve values for one single deployment service health metric over batch.
Code samples¶
# You can also use wget
curl -X GET https://app.datarobot.com/api/v2/deployments/{deploymentId}/serviceStatsOverBatch/ \
-H "Accept: application/json" \
-H "Authorization: Bearer {access-token}"
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
segmentAttribute | query | string | false | The name of a segment attribute used for segment analysis. |
segmentValue | query | string | false | The value of the segmentAttribute to segment on. |
batchId | query | any | false | The id of the batch for which metrics are being retrieved. |
modelId | query | string | false | The id of the model for which metrics are being retrieved. |
metric | query | string | false | A service health metric. |
quantile | query | number | false | Quantile for executionTime and responseTime metrics |
threshold | query | integer | false | Threshold for slowQueries metric. |
deploymentId | path | string | true | Unique identifier of the deployment. |
Enumerated Values¶
Parameter | Value |
---|---|
segmentAttribute | [DataRobot-Consumer , DataRobot-Remote-IP , DataRobot-Host-IP ] |
metric | [totalPredictions , totalRequests , slowRequests , executionTime , responseTime , userErrorRate , serverErrorRate , numConsumers , cacheHitRatio ] |
Example responses¶
200 Response
{
"buckets": [
{
"batch": {
"earliestPredictionTimestamp": "2019-08-24T14:15:22Z",
"id": "string",
"latestPredictionTimestamp": "2019-08-24T14:15:22Z",
"name": "string"
},
"value": 0
}
],
"metric": "string",
"segmentAttribute": "string",
"segmentValue": ""
}
Responses¶
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Service health metric data retrieved. | ServiceStatsOverBatchResponse |
To perform this operation, you must be authenticated by means of one of the following methods:
BearerAuth
GET /api/v2/deployments/{deploymentId}/serviceStatsOverTime/¶
Retrieve values for one single deployment service health metric over time.
Code samples¶
# You can also use wget
curl -X GET https://app.datarobot.com/api/v2/deployments/{deploymentId}/serviceStatsOverTime/ \
-H "Accept: application/json" \
-H "Authorization: Bearer {access-token}"
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
start | query | string(date-time) | false | Start of the period to retrieve monitoring data, defaults to 7 days ago from the end of the period. Note: this field only accepts top of the hour RFC3339 datetime strings, for example: 2019-08-01T00:00:00Z . |
end | query | string(date-time) | false | End of the period to retrieve monitoring data, defaults to the next top of the hour. Note: this field only accepts top of the hour RFC3339 datetime strings, for example: 2019-08-01T00:00:00Z . |
bucketSize | query | string(duration) | false | The time duration of a bucket. Needs to be multiple of one hour. Can not be longer than the total length of the period. If not set, a default value will be calculated based on the start and end time. |
metric | query | string | false | Name of the metric. See below for a list of supported metrics. |
quantile | query | number | false | A quantile for resulting data, used if metric is executionTime or responseTime , defaults to 0.5. |
threshold | query | integer | false | A threshold for filtering results, used if metric is slowQueries , defaults to 1000. |
segmentAttribute | query | string | false | The name of a segment attribute used for segment analysis. |
segmentValue | query | string | false | The value of the segmentAttribute to segment on. |
modelId | query | string | false | The id of the model for which metrics are being retrieved. |
deploymentId | path | string | true | Unique identifier of the deployment. |
Enumerated Values¶
Parameter | Value |
---|---|
metric | [totalPredictions , totalRequests , slowRequests , executionTime , responseTime , userErrorRate , serverErrorRate , numConsumers , cacheHitRatio , medianLoad , peakLoad ] |
segmentAttribute | [DataRobot-Consumer , DataRobot-Remote-IP , DataRobot-Host-IP ] |
Example responses¶
200 Response
{
"buckets": [
{
"period": {
"end": "2019-08-24T14:15:22Z",
"start": "2019-08-24T14:15:22Z"
},
"value": 0
}
],
"metric": "string",
"modelId": "string",
"segmentAttribute": "string",
"segmentValue": "",
"summary": {
"period": {
"end": "2019-08-24T14:15:22Z",
"start": "2019-08-24T14:15:22Z"
},
"value": 0
}
}
Responses¶
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Service health metric data retrieved. | ServiceStatsOverTimeResponse |
To perform this operation, you must be authenticated by means of one of the following methods:
BearerAuth
GET /api/v2/deployments/{deploymentId}/settings/¶
Retrieve deployment settings.
Code samples¶
# You can also use wget
curl -X GET https://app.datarobot.com/api/v2/deployments/{deploymentId}/settings/ \
-H "Accept: application/json" \
-H "Authorization: Bearer {access-token}"
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
deploymentId | path | string | true | Unique identifier of the deployment. |
Example responses¶
200 Response
{
"associationId": {
"columnNames": [
"string"
],
"requiredInPredictionRequests": true
},
"automaticActuals": {
"enabled": true
},
"biasAndFairness": {
"fairnessMetricsSet": "proportionalParity",
"fairnessThreshold": 1,
"preferableTargetValue": true,
"protectedFeatures": [
"string"
]
},
"challengerModels": {
"enabled": true
},
"featureDrift": {
"enabled": true
},
"humility": {
"enabled": true
},
"predictionIntervals": {
"enabled": true,
"percentiles": [
0
]
},
"predictionWarning": {
"customBoundaries": {
"lower": 0,
"upper": 0
},
"enabled": true
},
"predictionsByForecastDate": {
"columnName": "string",
"datetimeFormat": "string",
"enabled": true
},
"predictionsDataCollection": {
"enabled": true
},
"processingLimits": {
"interval": "hour"
},
"segmentAnalysis": {
"attributes": [
"string"
],
"enabled": true
},
"targetDrift": {
"enabled": true
}
}
Responses¶
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | The deployment settings | DeploymentSettingsResponse |
To perform this operation, you must be authenticated by means of one of the following methods:
BearerAuth
PATCH /api/v2/deployments/{deploymentId}/settings/¶
Updates deployment settings.
Code samples¶
# You can also use wget
curl -X PATCH https://app.datarobot.com/api/v2/deployments/{deploymentId}/settings/ \
-H "Content-Type: application/json" \
-H "Authorization: Bearer {access-token}" \
-d '{undefined}'
Body parameter¶
{
"associationId": {
"columnNames": [
"string"
],
"requiredInPredictionRequests": true
},
"automaticActuals": {
"enabled": true
},
"biasAndFairness": {
"fairnessMetricsSet": "proportionalParity",
"fairnessThreshold": 1,
"preferableTargetValue": true,
"protectedFeatures": [
"string"
]
},
"challengerModels": {
"enabled": true
},
"featureDrift": {
"enabled": true
},
"humility": {
"enabled": true
},
"predictionIntervals": {
"enabled": true,
"percentiles": [
0
]
},
"predictionWarning": {
"customBoundaries": {
"lower": 0,
"upper": 0
},
"enabled": true
},
"predictionsByForecastDate": {
"columnName": "string",
"datetimeFormat": "string",
"enabled": true
},
"predictionsDataCollection": {
"enabled": true
},
"processingLimits": {
"interval": "hour"
},
"segmentAnalysis": {
"attributes": [
"string"
],
"enabled": true
},
"targetDrift": {
"enabled": true
}
}
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
deploymentId | path | string | true | Unique identifier of the deployment. |
body | body | DeploymentSettingsUpdate | false | none |
Responses¶
Status | Meaning | Description | Schema |
---|---|---|---|
202 | Accepted | Job submitted. See Location header. | None |
Response Headers¶
Status | Header | Type | Format | Description |
---|---|---|---|---|
202 | Location | string | A url that can be polled to check the status. |
To perform this operation, you must be authenticated by means of one of the following methods:
BearerAuth
GET /api/v2/deployments/{deploymentId}/sharedRoles/¶
Get a list of users, groups and organizations who have access to this deployment and their roles.
Code samples¶
# You can also use wget
curl -X GET https://app.datarobot.com/api/v2/deployments/{deploymentId}/sharedRoles/?offset=0&limit=10 \
-H "Accept: application/json" \
-H "Authorization: Bearer {access-token}"
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
id | query | string | false | Only return roles for a user, group or organization with this identifier. |
offset | query | integer | true | This many results will be skipped |
limit | query | integer | true | At most this many results are returned |
name | query | string | false | Only return roles for a user, group or organization with this name. |
shareRecipientType | query | string | false | List access controls for recipients with this type. |
deploymentId | path | string | true | The deployment ID. |
Enumerated Values¶
Parameter | Value |
---|---|
shareRecipientType | [user , group , organization ] |
Example responses¶
200 Response
{
"count": 0,
"data": [
{
"id": "string",
"name": "string",
"role": "ADMIN",
"shareRecipientType": "user"
}
],
"next": "string",
"previous": "string",
"totalCount": 0
}
Responses¶
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | none | SharingListV2Response |
404 | Not Found | Either the deployment does not exist or the user does not have permissions to view the deployment. | None |
422 | Unprocessable Entity | Both username and userId were specified | None |
To perform this operation, you must be authenticated by means of one of the following methods:
BearerAuth
PATCH /api/v2/deployments/{deploymentId}/sharedRoles/¶
Set roles for users on this model deployment.
Code samples¶
# You can also use wget
curl -X PATCH https://app.datarobot.com/api/v2/deployments/{deploymentId}/sharedRoles/ \
-H "Content-Type: application/json" \
-H "Authorization: Bearer {access-token}" \
-d '{undefined}'
Body parameter¶
{
"operation": "updateRoles",
"roles": [
{
"canShare": true,
"role": "string",
"shareRecipientType": "user",
"username": "string"
}
]
}
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
deploymentId | path | string | true | The deployment ID. |
body | body | SharedRolesUpdateWithGrant | false | none |
Responses¶
Status | Meaning | Description | Schema |
---|---|---|---|
204 | No Content | Roles updated successfully. | None |
409 | Conflict | The request would leave the project without an owner. | None |
422 | Unprocessable Entity | One of the users in the request does not exist, or the request is otherwise invalid | None |
To perform this operation, you must be authenticated by means of one of the following methods:
BearerAuth
PATCH /api/v2/deployments/{deploymentId}/status/¶
Change deployment status.
Code samples¶
# You can also use wget
curl -X PATCH https://app.datarobot.com/api/v2/deployments/{deploymentId}/status/ \
-H "Content-Type: application/json" \
-H "Authorization: Bearer {access-token}" \
-d '{undefined}'
Body parameter¶
{
"status": "active"
}
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
deploymentId | path | string | true | Unique identifier of the deployment. |
body | body | DeploymentStatusUpdate | false | none |
Responses¶
Status | Meaning | Description | Schema |
---|---|---|---|
202 | Accepted | Job submitted. See Location header. | None |
409 | Conflict | Deployment is already in process of status change or already in requested status. | None |
422 | Unprocessable Entity | Deployment status change request could not be processed. | None |
Response Headers¶
Status | Header | Type | Format | Description |
---|---|---|---|---|
202 | Location | string | URL for tracking async job status. |
To perform this operation, you must be authenticated by means of one of the following methods:
BearerAuth
GET /api/v2/deployments/{deploymentId}/targetDrift/¶
Retrieve target drift data.
Code samples¶
# You can also use wget
curl -X GET https://app.datarobot.com/api/v2/deployments/{deploymentId}/targetDrift/ \
-H "Accept: application/json" \
-H "Authorization: Bearer {access-token}"
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
start | query | string(date-time) | false | Start of the period to retrieve monitoring data, defaults to 7 days ago from the end of the period. Note: this field only accepts top of the hour RFC3339 datetime strings, for example: 2019-08-01T00:00:00Z . |
end | query | string(date-time) | false | End of the period to retrieve monitoring data, defaults to the next top of the hour. Note: this field only accepts top of the hour RFC3339 datetime strings, for example: 2019-08-01T00:00:00Z . |
modelId | query | string | false | An ID of the model in the deployment. If not set, defaults to the deployment current model. |
metric | query | string | false | Metric used to calculate drift score. |
segmentAttribute | query | string | false | The name of a segment attribute used for segment analysis. |
segmentValue | query | string | false | The value of the segmentAttribute to segment on. |
batchId | query | any | false | The id of the batch for which metrics are being retrieved. |
deploymentId | path | string | true | Unique identifier of the deployment. |
Enumerated Values¶
Parameter | Value |
---|---|
metric | [psi , kl_divergence , dissimilarity , hellinger , js_divergence ] |
Example responses¶
200 Response
{
"baselineSampleSize": 0,
"batchId": [],
"driftScore": 0,
"metric": "psi",
"modelId": "string",
"period": {
"end": "2019-08-24T14:15:22Z",
"start": "2019-08-24T14:15:22Z"
},
"sampleSize": 0,
"segmentAttribute": "string",
"segmentValue": "",
"targetName": "string",
"type": "numeric"
}
Responses¶
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Target drift over specified time period retrieved. | TargetDriftResponse |
To perform this operation, you must be authenticated by means of one of the following methods:
BearerAuth
GET /api/v2/deployments/{deploymentId}/trainingDataExports/¶
A list of successful training data exports.
Code samples¶
# You can also use wget
curl -X GET https://app.datarobot.com/api/v2/deployments/{deploymentId}/trainingDataExports/ \
-H "Accept: application/json" \
-H "Authorization: Bearer {access-token}"
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
offset | query | integer | false | Specifies the number of rows to skip before starting to return rows from the query. |
limit | query | integer | false | Specifies the number of rows to return after the offset. |
modelId | query | string | false | Id of model used for training data export. |
deploymentId | path | string | true | Unique identifier of the deployment. |
Example responses¶
200 Response
{
"count": 0,
"data": [
{
"createdAt": "2019-08-24T14:15:22Z",
"createdBy": "string",
"data": {
"id": "string",
"name": "string"
},
"id": "string",
"modelId": "string",
"modelPackageId": "string"
}
],
"next": "string",
"previous": "string",
"totalCount": 0
}
Responses¶
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | The training data exports. | TrainingDataExportListResponse |
403 | Forbidden | User does not have permission to access a particular deployment. | None |
404 | Not Found | Resource not found. | None |
422 | Unprocessable Entity | Unable to process the training data exports list retrieval due to invalid parameter values. | None |
To perform this operation, you must be authenticated by means of one of the following methods:
BearerAuth
POST /api/v2/deployments/{deploymentId}/trainingDataExports/¶
Create a deployment training data export.
Code samples¶
# You can also use wget
curl -X POST https://app.datarobot.com/api/v2/deployments/{deploymentId}/trainingDataExports/ \
-H "Content-Type: application/json" \
-H "Authorization: Bearer {access-token}" \
-d '{undefined}'
Body parameter¶
{
"modelId": null
}
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
deploymentId | path | string | true | Unique identifier of the deployment. |
body | body | TrainingDataExportCreatePayload | false | none |
Responses¶
Status | Meaning | Description | Schema |
---|---|---|---|
202 | Accepted | Training data export successfully enqueued. | None |
403 | Forbidden | User does not have permission to create a training data export. | None |
404 | Not Found | Resource not found. | None |
422 | Unprocessable Entity | Unable to process the training data export request. | None |
Response Headers¶
Status | Header | Type | Format | Description |
---|---|---|---|---|
202 | Location | string | URL to poll to get status of job that waits for the training data export to finish |
To perform this operation, you must be authenticated by means of one of the following methods:
BearerAuth
GET /api/v2/deployments/{deploymentId}/trainingDataExports/{exportId}/¶
Retrieve a single training data export details.
Code samples¶
# You can also use wget
curl -X GET https://app.datarobot.com/api/v2/deployments/{deploymentId}/trainingDataExports/{exportId}/ \
-H "Accept: application/json" \
-H "Authorization: Bearer {access-token}"
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
deploymentId | path | string | true | Unique identifier of the deployment. |
exportId | path | string | true | Unique identifier of the export. |
Example responses¶
200 Response
{
"createdAt": "2019-08-24T14:15:22Z",
"createdBy": "string",
"data": {
"id": "string",
"name": "string"
},
"id": "string",
"modelId": "string",
"modelPackageId": "string"
}
Responses¶
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | A given training data export user can view is retrieved. | TrainingDataExportEntity |
403 | Forbidden | User does not have permission to access a particular deployment or training data export. | None |
404 | Not Found | Resource not found. | None |
To perform this operation, you must be authenticated by means of one of the following methods:
BearerAuth
GET /api/v2/predictionServers/¶
List prediction servers available for a user.
Code samples¶
# You can also use wget
curl -X GET https://app.datarobot.com/api/v2/predictionServers/ \
-H "Accept: application/json" \
-H "Authorization: Bearer {access-token}"
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
offset | query | integer | false | This many results will be skipped. |
limit | query | integer | false | At most this many results are returned. |
Example responses¶
200 Response
{
"count": 0,
"data": [
{
"batchPredictions": {
"processing": 0,
"queued": 0
},
"datarobot-key": "string",
"id": "string",
"url": "string"
}
],
"next": "http://example.com",
"previous": "http://example.com"
}
Responses¶
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | none | PredictionServerListResponse |
To perform this operation, you must be authenticated by means of one of the following methods:
BearerAuth
Schemas¶
AccessControlV2
{
"id": "string",
"name": "string",
"role": "ADMIN",
"shareRecipientType": "user"
}
Properties¶
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
id | string | true | The identifier of the recipient. | |
name | string | true | The name of the recipient. | |
role | string | true | The role of the recipient on this entity. | |
shareRecipientType | string | true | The type of the recipient. |
Enumerated Values¶
Property | Value |
---|---|
role | [ADMIN , CONSUMER , DATA_SCIENTIST , EDITOR , OBSERVER , OWNER , READ_ONLY , READ_WRITE , USER ] |
shareRecipientType | [user , group , organization ] |
AccuracyBatchBaselineBucket
{
"metric": "string",
"modelId": "string",
"perClass": [
{
"className": "string",
"value": 0
}
],
"sampleSize": 0,
"value": 0
}
Properties¶
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
metric | string | true | Name of the metric. | |
modelId | string | false | The id of the model for which metrics are being retrieved. | |
perClass | [AccuracyPerClass] | false | Accuracy metric for selected classes. | |
sampleSize | integer | true | Number of rows used to calculate the metric. | |
value | number¦null | true | Accuracy metric value. |
AccuracyBatchBucket
{
"batchId": "string",
"batchName": "string",
"metric": "string",
"modelId": "string",
"perClass": [
{
"className": "string",
"value": 0
}
],
"period": {
"end": "2019-08-24T14:15:22Z",
"start": "2019-08-24T14:15:22Z"
},
"sampleSize": 0,
"value": 0
}
Properties¶
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
batchId | string | true | ID of the batch. | |
batchName | string | true | Name of the batch. | |
metric | string | true | Name of the metric. | |
modelId | string | false | The id of the model for which metrics are being retrieved. | |
perClass | [AccuracyPerClass] | false | Accuracy metric for selected classes. | |
period | BatchPeriod | true | Time period of the batch. | |
sampleSize | integer | true | Number of rows used to calculate the metric. | |
value | number¦null | true | Accuracy metric value. |
AccuracyHealth
{
"batchCount": "1",
"failingThreshold": 0,
"measurement": "percent",
"metric": "AUC",
"warningThreshold": 0
}
Accuracy health status setting.
Properties¶
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
batchCount | string | false | Number of recent batches used to compute accuracy health status, only applicable to deployments with batch monitoring enabled. | |
failingThreshold | number¦null | false | Threshold for failing status. | |
measurement | string¦null | false | Measurement for calculating accuracy health status. | |
metric | string¦null | false | Metric used for calculating accuracy health status. | |
warningThreshold | number¦null | false | Threshold for warning status. |
Enumerated Values¶
Property | Value |
---|---|
batchCount | [1 , 5 , 10 , 50 , 100 , 1000 , 10000 ] |
measurement | [percent , value ] |
metric | [AUC , Accuracy , Balanced Accuracy , F1 , FPR , FVE Binomial , FVE Gamma , FVE Multinomial , FVE Poisson , FVE Tweedie , Gamma Deviance , Gini Norm , Kolmogorov-Smirnov , LogLoss , MAE , MAPE , MCC , NPV , PPV , Poisson Deviance , R Squared , RMSE , RMSLE , Rate@Top10% , Rate@Top5% , TNR , TPR , Tweedie Deviance ] |
AccuracyLegacyTimeBucket
{
"period": {
"end": "2019-08-24T14:15:22Z",
"start": "2019-08-24T14:15:22Z"
},
"sampleSize": 0,
"value": 0,
"valuePerClass": "\n {\n \"class1\": 0.880778024500618,\n \"class2\": 0.5294117647058824,\n \"class3\": 0.4117647058823529\n }\n "
}
A bucket object containing metric info calculated. Deprecated and to be removed in v2.35, use summaries field with includeSummaries query param to get accuracy metrics computed over the whole time range.
Properties¶
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
period | TimeRange | true | An object with the keys "start" and "end" defining the period. | |
sampleSize | integer¦null | true | Number of predictions used to calculate the metric. | |
value | number¦null | true | Value of the metric, null if no value. | |
valuePerClass | object¦null | false | A dict keyed by class names with metric calculated for specific classes as values, if targetClass is set. Deprecated and to be removed in v2.35, use perClass instead. |
AccuracyOverBatchResponse
{
"baselines": [
{
"metric": "string",
"modelId": "string",
"perClass": [
{
"className": "string",
"value": 0
}
],
"sampleSize": 0,
"value": 0
}
],
"buckets": [
{
"batchId": "string",
"batchName": "string",
"metric": "string",
"modelId": "string",
"perClass": [
{
"className": "string",
"value": 0
}
],
"period": {
"end": "2019-08-24T14:15:22Z",
"start": "2019-08-24T14:15:22Z"
},
"sampleSize": 0,
"value": 0
}
]
}
Properties¶
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
baselines | [AccuracyBatchBaselineBucket] | true | Accuracy metric training baseline. | |
buckets | [AccuracyBatchBucket] | true | Accuracy metric for batches that are requested, with non-existing batches omitted. |
AccuracyOverSpaceBaselineBucket
{
"hexagon": "string",
"perClass": [
{
"className": "string",
"value": 0
}
],
"sampleSize": 0,
"value": 0
}
Properties¶
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
hexagon | string | true | h3 hexagon. | |
perClass | [AccuracyPerClass] | false | maxItems: 100 |
Accuracy metric values for selected classes, only available for multiclass deployments. |
sampleSize | integer | true | Number of rows used to calculate the metric. | |
value | number¦null | true | Accuracy metric value. |
AccuracyOverSpaceBucket
{
"hexagon": "string",
"perClass": [
{
"className": "string",
"value": 0
}
],
"value": 0
}
Properties¶
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
hexagon | string | true | h3 hexagon. | |
perClass | [AccuracyPerClass] | false | maxItems: 100 |
Accuracy metric values for selected classes, only available for multiclass deployments. |
value | number¦null | true | Accuracy metric value. |
AccuracyOverSpaceResponse
{
"baselines": [
{
"hexagon": "string",
"perClass": [
{
"className": "string",
"value": 0
}
],
"sampleSize": 0,
"value": 0
}
],
"buckets": [
{
"hexagon": "string",
"perClass": [
{
"className": "string",
"value": 0
}
],
"value": 0
}
],
"geoFeatureName": "string",
"metric": "AUC",
"modelId": "string",
"period": {
"end": "2019-08-24T14:15:22Z",
"start": "2019-08-24T14:15:22Z"
}
}
Properties¶
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
baselines | [AccuracyOverSpaceBaselineBucket] | true | maxItems: 1000 |
Baseline accuracy per geospatial hexagon. |
buckets | [AccuracyOverSpaceBucket] | true | maxItems: 1000 |
Accuracy per geospatial hexagon. |
geoFeatureName | string | true | The name of the geospatial feature. Segmented analysis must be enabled for the feature specified. | |
metric | string | true | The metric being retrieved. | |
modelId | string | false | The ID of the model for which metrics are being retrieved. | |
period | TimeRange | false | An object with the keys "start" and "end" defining the period. |
Enumerated Values¶
Property | Value |
---|---|
metric | [AUC , Accuracy , Balanced Accuracy , F1 , FPR , FVE Binomial , FVE Gamma , FVE Multinomial , FVE Poisson , FVE Tweedie , Gamma Deviance , Gini Norm , Kolmogorov-Smirnov , LogLoss , MAE , MAPE , MCC , NPV , PPV , Poisson Deviance , R Squared , RMSE , RMSLE , Rate@Top10% , Rate@Top5% , TNR , TPR , Tweedie Deviance ] |
AccuracyOverTimeResponse
{
"baseline": {
"period": {
"end": "2019-08-24T14:15:22Z",
"start": "2019-08-24T14:15:22Z"
},
"sampleSize": 0,
"value": 0,
"valuePerClass": "\n {\n \"class1\": 0.880778024500618,\n \"class2\": 0.5294117647058824,\n \"class3\": 0.4117647058823529\n }\n "
},
"baselines": [
{
"modelId": "string",
"perClass": [
{
"className": "string",
"value": 0
}
],
"sampleSize": 0,
"value": 0
}
],
"buckets": [
{
"modelId": "string",
"perClass": [
{
"className": "string",
"value": 0
}
],
"period": {
"end": "2019-08-24T14:15:22Z",
"start": "2019-08-24T14:15:22Z"
},
"sampleSize": 0,
"value": 0,
"valuePerClass": "\n {\n \"class1\": 0.880778024500618,\n \"class2\": 0.5294117647058824,\n \"class3\": 0.4117647058823529\n }\n "
}
],
"metric": "AUC",
"modelId": "string",
"segmentAttribute": "string",
"segmentValue": "",
"summary": {
"period": {
"end": "2019-08-24T14:15:22Z",
"start": "2019-08-24T14:15:22Z"
},
"sampleSize": 0,
"value": 0,
"valuePerClass": "\n {\n \"class1\": 0.880778024500618,\n \"class2\": 0.5294117647058824,\n \"class3\": 0.4117647058823529\n }\n "
}
}
Properties¶
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
baseline | AccuracyLegacyTimeBucket | true | A bucket object containing metric info calculated. Deprecated and to be removed in v2.35, use summaries field with includeSummaries query param to get accuracy metrics computed over the whole time range. | |
baselines | [AccuracyTimeBaselineBucket] | true | Accuracy metric training baseline. | |
buckets | [AccuracyTimeBucket] | true | Accuracy metric for requested models and time buckets. | |
metric | string | true | The metric being retrieved. | |
modelId | string | false | The id of the model for which metrics are being retrieved. Deprecated and to be removed in v2.35, use modelId in each baseline or bucket object. | |
segmentAttribute | string¦null | false | The name of the segment on which segment analysis is being performed. | |
segmentValue | string¦null | false | The value of the segmentAttribute to segment on. |
|
summary | AccuracyLegacyTimeBucket | true | A bucket object containing metric info calculated. Deprecated and to be removed in v2.35, use summaries field with includeSummaries query param to get accuracy metrics computed over the whole time range. |
Enumerated Values¶
Property | Value |
---|---|
metric | [AUC , Accuracy , Balanced Accuracy , F1 , FPR , FVE Binomial , FVE Gamma , FVE Multinomial , FVE Poisson , FVE Tweedie , Gamma Deviance , Gini Norm , Kolmogorov-Smirnov , LogLoss , MAE , MAPE , MCC , NPV , PPV , Poisson Deviance , R Squared , RMSE , RMSLE , Rate@Top10% , Rate@Top5% , TNR , TPR , Tweedie Deviance ] |
AccuracyPerClass
{
"className": "string",
"value": 0
}
Properties¶
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
className | string | true | Name of the class. | |
value | number¦null | true | Value of the metric. |
AccuracyResponse
{
"batchIds": [
"string"
],
"metrics": "\n {\"metrics\": {\n \"LogLoss\": {\n \"baselineValue\": 0.454221484838069,\n \"value\": 0.880778024500618,\n \"percentChange\": -93.91\n },\n \"AUC\": {\n \"baselineValue\": 0.8690358459556535,\n \"value\": 0.5294117647058824,\n \"percentChange\": -39.08\n },\n \"Kolmogorov-Smirnov\": {\n \"baselineValue\": 0.5753202944706626,\n \"value\": 0.4117647058823529,\n \"percentChange\": -28.43\n },\n \"Rate@Top10%\": {\n \"baselineValue\": 0.9603223806571606,\n \"value\": 1.0,\n \"percentChange\": 4.13\n },\n \"Gini Norm\": {\n \"baselineValue\": 0.7380716919113071,\n \"value\": 0.05882352941176472,\n \"percentChange\": -92.03\n }\n }\n ",
"modelId": "string",
"period": {
"end": "2019-08-24T14:15:22Z",
"start": "2019-08-24T14:15:22Z"
},
"segmentAttribute": "string",
"segmentValue": "",
"targetClasses": "string"
}
Properties¶
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
batchIds | [string] | false | ID of the batches used to calculate accuracy metrics. | |
metrics | object | true | Accuracy metrics of the deployment, keyed by metric names, each value is a metric object with detail on a single metric.For classification deployments: - LogLoss - AUC - Kolmogorov - Smirnov - Gini Norm - Rate @ Top10 % For regression deployments: - RMSE - MAE - Gamma Deviance - Tweedie Deviance - R Squared |
|
modelId | string | false | The id of the model for which metrics are being retrieved. | |
period | TimeRange | false | An object with the keys "start" and "end" defining the period. | |
segmentAttribute | string¦null | false | The name of the segment on which segment analysis is being performed. | |
segmentValue | string¦null | false | The value of the segmentAttribute to segment on. |
|
targetClasses | string¦null | false | Target classes provided in the request. |
AccuracyTimeBaselineBucket
{
"modelId": "string",
"perClass": [
{
"className": "string",
"value": 0
}
],
"sampleSize": 0,
"value": 0
}
Properties¶
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|