DataRobot Insights API
Use the endpoints described below to generate and interpret insights for specific models.
Operations 146
GET
/api/v2/dataSlices/{dataSliceId}/sliceSizes/
Returns the number of rows available after applying a data slice by data slice…
#
POST
/api/v2/dataSlices/{dataSliceId}/sliceSizes/
Compute the number of rows available after applying a data slice by data slice…
#
GET
/api/v2/insights/confusionMatrix/models/{entityId}/
The list of paginated Confusion Matrix chart insights by entity ID
#
GET
/api/v2/insights/featureEffects/models/{entityId}/
The list of paginated Feature Effects insights by entity ID
#
GET
/api/v2/insights/featureImpact/models/{entityId}/
The list of paginated Feature Impact insights by entity ID
#
GET
/api/v2/insights/liftChart/models/{entityId}/
The list of paginated lift chart insights by entity ID
#
GET
/api/v2/insights/residuals/models/{entityId}/
The list of paginated Residuals insights by entity ID
#
GET
/api/v2/insights/rocCurve/models/{entityId}/
The list of paginated ROC curve insights by entity ID
#
GET
/api/v2/insights/shapDistributions/models/{entityId}/
The list of paginated SHAP Distributions insights by entity ID
#
GET
/api/v2/insights/shapImpact/models/{entityId}/
The list of paginated SHAP Impact insights by entity ID
#
GET
/api/v2/insights/shapMatrix/models/{entityId}/
The list of paginated SHAP Matrix insights by entity ID
#
GET
/api/v2/insights/shapPreview/models/{entityId}/
The list of paginated SHAP Preview insights by entity ID
#
GET
/api/v2/multilabelInsights/{multilabelInsightsKey}/histogram/
Retrieve multicategorical feature histogram by multilabelinsightskey
#
GET
/api/v2/multilabelInsights/{multilabelInsightsKey}/pairwiseManualSelections/
Get all label lists by multilabelinsightskey
#
POST
/api/v2/multilabelInsights/{multilabelInsightsKey}/pairwiseManualSelections/
Save a list of manually selected labels by multilabelinsightskey
#
DELETE
/api/v2/multilabelInsights/{multilabelInsightsKey}/pairwiseManualSelections/{manualSelectionListId}/
Delete the label list by multilabelinsightskey
#
PATCH
/api/v2/multilabelInsights/{multilabelInsightsKey}/pairwiseManualSelections/{manualSelectionListId}/
Update the label list name by multilabelinsightskey
#
GET
/api/v2/multilabelInsights/{multilabelInsightsKey}/pairwiseStatistics/
Retrieve pairwise statistics by multilabelinsightskey
#
GET
/api/v2/projects/{projectId}/anomalyAssessmentRecords/
Retrieve anomaly assessment records by project ID
#
DELETE
/api/v2/projects/{projectId}/anomalyAssessmentRecords/{recordId}/
Delete the anomaly assessment record by project ID
#
GET
/api/v2/projects/{projectId}/anomalyAssessmentRecords/{recordId}/explanations/
Retrieve anomaly assessment record by project ID
#
GET
/api/v2/projects/{projectId}/anomalyAssessmentRecords/{recordId}/predictionsPreview/
Retrieve predictions preview by project ID
#
GET
/api/v2/projects/{projectId}/biasVsAccuracyInsights/
List Bias vs Accuracy insights by project ID
#
GET
/api/v2/projects/{projectId}/datetimeModels/{modelId}/accuracyOverTimePlots/
Retrieve the data by project ID
#
GET
/api/v2/projects/{projectId}/datetimeModels/{modelId}/accuracyOverTimePlots/metadata/
Retrieve the metadata by project ID
#
GET
/api/v2/projects/{projectId}/datetimeModels/{modelId}/accuracyOverTimePlots/preview/
Retrieve the preview by project ID
#
GET
/api/v2/projects/{projectId}/datetimeModels/{modelId}/anomalyOverTimePlots/
Retrieve anomaly over time plots by ID
#
GET
/api/v2/projects/{projectId}/datetimeModels/{modelId}/anomalyOverTimePlots/metadata/
Retrieve metadata by ID
#
GET
/api/v2/projects/{projectId}/datetimeModels/{modelId}/anomalyOverTimePlots/preview/
Retrieve preview by ID
#
GET
/api/v2/projects/{projectId}/datetimeModels/{modelId}/backtestStabilityPlot/
Retrieve a plot displaying the stability of the datetime model across by…
#
GET
/api/v2/projects/{projectId}/datetimeModels/{modelId}/datasetAccuracyOverTimePlots/{datasetId}/
Retrieve the Accuracy Over Time (AOT) chart data by project ID
#
GET
/api/v2/projects/{projectId}/datetimeModels/{modelId}/datasetAccuracyOverTimePlots/{datasetId}/metadata/
Retrieve the metadata of the Accuracy Over Time (AOT) chart by project ID
#
GET
/api/v2/projects/{projectId}/datetimeModels/{modelId}/datasetAccuracyOverTimePlots/{datasetId}/preview/
Retrieve a preview of the Accuracy Over Time (AOT) chart by project ID
#
POST
/api/v2/projects/{projectId}/datetimeModels/{modelId}/datetimeTrendPlots/
Computes Datetime Trend plots by project ID
#
GET
/api/v2/projects/{projectId}/datetimeModels/{modelId}/featureEffects/
Retrieve Feature Effects by project ID
#
POST
/api/v2/projects/{projectId}/datetimeModels/{modelId}/featureEffects/
Add a request by project ID
#
GET
/api/v2/projects/{projectId}/datetimeModels/{modelId}/featureEffectsMetadata/
Retrieve Feature Effects metadata for each backtest by project ID
#
GET
/api/v2/projects/{projectId}/datetimeModels/{modelId}/forecastDistanceStabilityPlot/
Retrieve a plot displaying the stability of the time series model across by…
#
GET
/api/v2/projects/{projectId}/datetimeModels/{modelId}/forecastVsActualPlots/
Retrieve forecast vs actual plots by ID
#
GET
/api/v2/projects/{projectId}/datetimeModels/{modelId}/forecastVsActualPlots/metadata/
Retrieve metadata by ID
#
GET
/api/v2/projects/{projectId}/datetimeModels/{modelId}/forecastVsActualPlots/preview/
Retrieve preview by ID
#
GET
/api/v2/projects/{projectId}/datetimeModels/{modelId}/multiclassFeatureEffects/
Retrieve feature effects by project ID
#
POST
/api/v2/projects/{projectId}/datetimeModels/{modelId}/multiclassFeatureEffects/
Compute feature effects by project ID
#
GET
/api/v2/projects/{projectId}/datetimeModels/{modelId}/multiseriesHistograms/
Retrieve the histograms by project ID
#
GET
/api/v2/projects/{projectId}/datetimeModels/{modelId}/multiseriesScores/
List the scores per individual series by project ID
#
POST
/api/v2/projects/{projectId}/datetimeModels/{modelId}/multiseriesScores/
Request the computation of per-series scores by project ID
#
GET
/api/v2/projects/{projectId}/datetimeModels/{modelId}/multiseriesScores/file/
Retrieve the CSV file by project ID
#
GET
/api/v2/projects/{projectId}/externalScores/
The list of scores on prediction datasets by project ID
#
GET
/api/v2/projects/{projectId}/featureAssociationFeaturelists/
List all featurelists with feature association matrix availability flags by…
#
GET
/api/v2/projects/{projectId}/featureAssociationMatrix/
Retrieve pairwise feature association statistics by project ID
#
POST
/api/v2/projects/{projectId}/featureAssociationMatrix/
Compute the feature association matrix by project ID
#
GET
/api/v2/projects/{projectId}/features/{featureName}/frequentValues/
Retrieve the frequent values information by project ID
#
POST
/api/v2/projects/{projectId}/geometryFeaturePlots/
Create a map of one location feature by project ID
#
GET
/api/v2/projects/{projectId}/geometryFeaturePlots/{featureName}/
Retrieve a map of one location feature by project ID
#
GET
/api/v2/projects/{projectId}/imageActivationMaps/
List all Image Activation Maps by project ID
#
POST
/api/v2/projects/{projectId}/models/{modelId}/anomalyAssessmentInitialization/
Calculate the anomaly assessment insight by project ID
#
GET
/api/v2/projects/{projectId}/models/{modelId}/anomalyInsightsFile/
Retrieve a CSV file of the raw data displayed by project ID
#
GET
/api/v2/projects/{projectId}/models/{modelId}/anomalyInsightsTable/
Retrieve a table of the raw data displayed by project ID
#
GET
/api/v2/projects/{projectId}/models/{modelId}/clusterInsights/
Retrieve Cluster Insights by project ID
#
POST
/api/v2/projects/{projectId}/models/{modelId}/clusterInsights/
Compute Cluster Insights by project ID
#
GET
/api/v2/projects/{projectId}/models/{modelId}/clusterInsights/download/
Download Cluster Insights result by project ID
#
GET
/api/v2/projects/{projectId}/models/{modelId}/confusionCharts/
Retrieve all available confusion charts by project ID
#
GET
/api/v2/projects/{projectId}/models/{modelId}/confusionCharts/{source}/
Retrieve the confusion chart data by project ID
#
GET
/api/v2/projects/{projectId}/models/{modelId}/confusionCharts/{source}/classDetails/
Calculates and sends frequency of class in distributed among other classes by…
#
GET
/api/v2/projects/{projectId}/models/{modelId}/confusionCharts/{source}/metadata/
Retrieve metadata by project ID
#
GET
/api/v2/projects/{projectId}/models/{modelId}/crossClassAccuracyScores/
List Cross Class Accuracy scores by project ID
#
POST
/api/v2/projects/{projectId}/models/{modelId}/crossClassAccuracyScores/
Start Cross Class Accuracy calculations by project ID
#
GET
/api/v2/projects/{projectId}/models/{modelId}/dataDisparityInsights/
Get Cross Class Data Disparity results by project ID
#
POST
/api/v2/projects/{projectId}/models/{modelId}/dataDisparityInsights/
Start insight calculations by project ID
#
GET
/api/v2/projects/{projectId}/models/{modelId}/datasetConfusionCharts/
List of Confusion Charts objects on external datasets by project ID
#
GET
/api/v2/projects/{projectId}/models/{modelId}/datasetConfusionCharts/{datasetId}/
Retrieve Confusion Chart objects on external datasets by project ID
#
GET
/api/v2/projects/{projectId}/models/{modelId}/datasetConfusionCharts/{datasetId}/classDetails/
Calculate and sends frequency of class in distributed among other classes by…
#
GET
/api/v2/projects/{projectId}/models/{modelId}/datasetConfusionCharts/{datasetId}/metadata/
Retrieve metadata by ID
#
GET
/api/v2/projects/{projectId}/models/{modelId}/datasetLiftCharts/
Retrieve List of Lift chart data on prediction datasets by project ID
#
GET
/api/v2/projects/{projectId}/models/{modelId}/datasetMulticlassLiftCharts/
Retrieve List of Multiclass Lift chart data on prediction datasets by project ID
#
GET
/api/v2/projects/{projectId}/models/{modelId}/datasetResidualsCharts/
The list of residuals chart objects by project ID
#
GET
/api/v2/projects/{projectId}/models/{modelId}/datasetRocCurves/
List of ROC curve objects on prediction datasets for a project with filtering…
#
GET
/api/v2/projects/{projectId}/models/{modelId}/fairnessInsights/
List calculated Per Class Bias insights by project ID
#
POST
/api/v2/projects/{projectId}/models/{modelId}/fairnessInsights/
Create fairness insights by ID
#
GET
/api/v2/projects/{projectId}/models/{modelId}/featureEffectsMetadata/
Retrieve Feature Effects metadata by project ID
#
GET
/api/v2/projects/{projectId}/models/{modelId}/featureImpact/
Retrieve feature impact scores by project ID
#
GET
/api/v2/projects/{projectId}/models/{modelId}/featureLists/{datasetId}/clusterInsights/
Retrieve cluster insights by ID
#
GET
/api/v2/projects/{projectId}/models/{modelId}/imageActivationMaps/
Retrieve Image Activation Maps by project ID
#
POST
/api/v2/projects/{projectId}/models/{modelId}/imageActivationMaps/
Request the computation of image activation maps by project ID
#
GET
/api/v2/projects/{projectId}/models/{modelId}/labelwiseRocCurves/{source}/
Retrieve labelwise ROC curves by project ID
#
GET
/api/v2/projects/{projectId}/models/{modelId}/liftChart/
Retrieve all available lift charts by project ID
#
GET
/api/v2/projects/{projectId}/models/{modelId}/liftChart/{source}/
Retrieve the lift chart data by project ID
#
GET
/api/v2/projects/{projectId}/models/{modelId}/multiclassFeatureEffects/
Retrieve multiclass feature effects by ID
#
POST
/api/v2/projects/{projectId}/models/{modelId}/multiclassFeatureEffects/
Create multiclass feature effects by ID
#
GET
/api/v2/projects/{projectId}/models/{modelId}/multiclassFeatureImpact/
Retrieve multiclass feature impact by ID
#
GET
/api/v2/projects/{projectId}/models/{modelId}/multiclassLiftChart/
Retrieve multiclass lift chart by ID
#
GET
/api/v2/projects/{projectId}/models/{modelId}/multiclassLiftChart/{source}/
Retrieve the multiclass lift chart data by project ID
#
GET
/api/v2/projects/{projectId}/models/{modelId}/multilabelLiftCharts/{source}/
Retrieve labelwise lift charts by project ID
#
DELETE
/api/v2/projects/{projectId}/models/{modelId}/predictionExplanationsInitialization/
Delete an existing PredictionExplanationsInitialization by project ID
#
GET
/api/v2/projects/{projectId}/models/{modelId}/predictionExplanationsInitialization/
Retrieve the current PredictionExplanationsInitialization by project ID
#
POST
/api/v2/projects/{projectId}/models/{modelId}/predictionExplanationsInitialization/
Create a new prediction explanations initialization by project ID
#
GET
/api/v2/projects/{projectId}/models/{modelId}/residuals/
Retrieve all residuals charts by project ID
#
GET
/api/v2/projects/{projectId}/models/{modelId}/residuals/{source}/
Retrieve the residuals chart data by project ID
#
GET
/api/v2/projects/{projectId}/models/{modelId}/rocCurve/
Retrieve all available ROC curves by project ID
#
GET
/api/v2/projects/{projectId}/models/{modelId}/rocCurve/{source}/
Retrieve the ROC curve data by project ID
#
GET
/api/v2/projects/{projectId}/models/{modelId}/shapImpact/
Retrieve Feature Impact for a model by project ID
#
POST
/api/v2/projects/{projectId}/models/{modelId}/shapImpact/
Create SHAP-based Feature Impact by project ID
#
GET
/api/v2/projects/{projectId}/models/{modelId}/wordCloud/
Retrieve word cloud data by project ID
#
GET
/api/v2/projects/{projectId}/multicategoricalInvalidFormat/
Retrieve multicategorical data quality log by project ID
#
DELETE
/api/v2/projects/{projectId}/payoffMatrices/{payoffMatrixId}/
Delete a payoff matrix by project ID
#
PUT
/api/v2/projects/{projectId}/payoffMatrices/{payoffMatrixId}/
Update a payoff matrix by project ID
#
POST
/api/v2/projects/{projectId}/predictionExplanations/
Create a new PredictionExplanations object ( by project ID
#
GET
/api/v2/projects/{projectId}/predictionExplanations/{predictionExplanationsId}/
Retrieve stored Prediction Explanations by project ID
#
GET
/api/v2/projects/{projectId}/predictionExplanationsRecords/
List PredictionExplanationsRecord objects by project ID
#
DELETE
/api/v2/projects/{projectId}/predictionExplanationsRecords/{predictionExplanationsId}/
Delete saved Prediction Explanations by project ID
#
GET
/api/v2/projects/{projectId}/predictionExplanationsRecords/{predictionExplanationsId}/
Retrieve a PredictionExplanationsRecord object by project ID
#
GET
/api/v2/projects/{projectId}/ratingTableModels/{modelId}/
Retrieve a rating table model by project ID
#
GET
/api/v2/projects/{projectId}/ratingTables/{ratingTableId}/
Retrieve rating table information by project ID
#
PATCH
/api/v2/projects/{projectId}/ratingTables/{ratingTableId}/
Update an uploaded rating table by project ID
#
GET
/api/v2/projects/{projectId}/ratingTables/{ratingTableId}/file/
Retrieve the rating table file by project ID
#
POST
/api/v2/projects/{projectId}/shapMatrices/
Calculate a matrix with SHAP-based prediction explanations scores by project ID
#
GET
/api/v2/projects/{projectId}/shapMatrices/{shapMatrixId}/
Return matrix with SHAP-based prediction explanations scores by project ID
#