datarobot (version 2.18.9)

'DataRobot' Predictive Modeling API

Description

For working with the 'DataRobot' predictive modeling platform's API .

Copy Link

Version

Install

install.packages('datarobot')

Monthly Downloads

375

Version

2.18.9

License

MIT + file LICENSE

Maintainer

David Chudzicki

Last Published

September 9th, 2026

Functions in datarobot (2.18.9)

CreateComplianceDocumentation

Create compliance documentation from a model.

CreateDataStore

Create a data store.

CreateBacktestSpecification

Create a list describing backtest parameters

ComputeDatetimeTrendPlots

Compute datetime trend plots for datetime partitioned model.

CreateCalendar

Create a calendar from an uploaded CSV.

CreateDataSource

Create a data source.

CreateDatetimePartitionSpecification

Create a list describing datetime partition parameters

CloneProject

Clone a project

ConnectToDataRobot

Establish a connection to the DataRobot modeling engine

ConstructDurationString

Construct a valid string representing a duration in accordance with ISO8601

CreateUserPartition

Create a class partition object for use in the SetTarget function representing a user-defined partition.

CreateStratifiedPartition

Create a stratified sampling-based S3 object of class partition for the SetTarget function

CreateRandomPartition

Create a random sampling-based S3 object of class partition for the SetTarget function

CreateGroupPartition

Create a group-based S3 object of class partition for the SetTarget function

CreateModelingFeaturelist

This function allows the user to create a new featurelist in a project by specifying its name and a list of variables to be included

CreateDeployment

Create a deployment.

CreatePrimeCode

Create and validate the downloadable code for the ruleset associated with this model

CreateFeaturelist

Create a new featurelist in a DataRobot project

CrossValidateModel

Run cross validation on a model.

CreateDerivedFeatures

Derived Features

DataPartition

Data Partition methods

DeleteModelJob

Delete a model job from the modeling queue

DeleteModel

Delete a specified DataRobot model

DatetimeTrendPlotsResolutions

Datetime trend plots resolutions

DeleteTransferableModel

Delete this imported model.

DeploymentAccuracyMetric

Deployment accuracy metrics

DeleteDataSource

Delete a data store.

DeleteModelingFeaturelist

Delete a modeling featurelist

DeprecatedHeaderMessage

Handler for Deprecated header in API responses

DataSubset

Data subset for training predictions

DeploymentServiceHealthMetric

Deployment service health metrics

DeleteComplianceDocTemplate

Deletes a compliance doc template.

DownloadScoringCode

Download scoring code JAR

FeatureFromAsyncUrl

Retrieve a feature from the creation URL

GenerateDatetimePartition

Preview the full partitioning determined by a DatetimePartitioningSpecification

DownloadSeriesAccuracy

Download the series accuracy for a model, computing it if not already computed.

GetBlueprintChart

Retrieve a blueprint chart

DownloadComplianceDocumentation

Download compliance documentation (in DOCX format).

GetBlenderModelFromJobId

Retrieve a new or updated blender model defined by modelJobId

DeletePredictionExplanationsInitialization

Delete the prediction explanations initialization for a model.

DeletePredictJob

Function to delete one predict job from the DataRobot queue

DatetimeTrendPlotsStatuses

Datetime trend plots statuses

Get all tables associated with a data store.

GetCalendar

Retrieve a calendar

GetBlueprintDocumentation

Get documentation for tasks used in the blueprint

GetCalendarFromProject

Retrieve the calendar for a particular project.

DownloadPrimeCode

Download the code of DataRobot Prime model and save it to a file.

DownloadTrainingPredictions

Download training predictions on a specified data set.

DeleteProject

Delete a specified element from the DataRobot project list

DownloadTimeSeriesFeatureDerivationLog

Download the time series feature derivation log as a text file.

GetDataStoreSchemas

Get the schemas associated with a data store.

GetAccuracyOverTimePlot

Retrieve Accuracy over Time plot for a model.

GetDataStore

Returns information about a particular data store.

GetAccuracyOverTimePlotPreview

Retrieve Accuracy over Time preview plot for a model.

GetAnomalyAssessmentPredictionsPreview

Retrieve anomaly assessment predictions preview.

GetBlenderModel

Retrieve the details of a specified blender model

DownloadPredictionExplanations

Function to download and save prediction explanations rows as csv file

CreateRatingTable

Creates and validates a new rating table from an uploaded CSV.

GetDeploymentDriftTrackingSettings

Get drift tracking settings for a deployment.

GetDeploymentServiceStatsOverTime

Retrieves service health statistics over time on given metrics for a deployment.

GetFeatureAssociationMatrixDetails

Get a sample of the actual values used to measure the association between a pair of features.

GetDeploymentServiceStats

Retrieve service health statistics for a deployment.

GetDatetimeModel

Retrieve the details of a specified datetime model.

GetDeploymentSettings

Retrieves all settings for a deployed model.

DeleteCalendar

Delete a calendar

DeleteAnomalyAssessmentRecord

Delete anomaly assessment record.

GetDriver

Returns information about a particular driver.

GetFeatureAssociationMatrix

Get pairwise feature association statistics for a project's informative features

GetFeaturelist

Retrieve a specific featurelist from a DataRobot project

GetFrozenModel

Retrieve the details of a specified frozen model

GetGeneralizedInsight

An internal function to help fetch insights.

GetFrozenModelFromJobId

Retrieve a frozen model defined by modelJobId

DownloadRatingTable

Download a rating table to a CSV.

GetFeatureHistogram

Retrieve histogram plot data for a specific feature

DeletePredictionExplanations

Function to delete prediction explanations

DeletePredictionDataset

Delete a specified prediction dataset

DifferencingMethod

Differencing method

DownloadComplianceDocTemplate

Download a compliance doc template (in JSON format).

ExpectHasKeys

Make sure that the object has all of the keys specified. Also tests that there are not additional keys if allowAdditional is FALSE (default).

DownloadTransferableModel

Download an transferable model file for use in an on-premise DataRobot standalone prediction environment.

GetComplianceDocTemplate

Get a compliance doc template.

GetModelFromJobId

Retrieve a new or updated model defined by modelJobId

GetModelCapabilities

Get supported capabilities for a model, e.g., whether it has a word cloud.

GetJob

Request information about a job

GetAccuracyOverTimePlotsMetadata

Retrieve Accuracy over Time plots metadata for a model.

GetDatetimeModelFromJobId

Retrieve a new or updated datetime model defined by modelJobId

GetDeploymentAssociationId

Deployment Association ID

GetConfusionChart

Retrieve a model's confusion chart for a specified source.

GetFeatureInfo

Details about a feature

GetFeatureImpactForModel

Retrieve completed Feature Impact results given a model

GetDeploymentAccuracyOverTime

Retrieves accuracy statistics over time on given metrics for a deployment.

GetCrossValidationScores

Get cross validation scores

GetDataSource

Returns information about a particular data source.

GetAnomalyAssessmentExplanations

Retrieve anomaly assessment explanations.

GetPredictJob

Request information about a predict job

GetDeployment

Get information on a particular deployment.

GetDeploymentAccuracy

Retrieve accuracy statistics for a deployment.

GetParetoFront

Pareto Front data for a Eureqa model

GetMultiSeriesProperties

Retrieve time series properties for a potential multiseries datetime partition column

GetProject

Retrieve details about a specified DataRobot modeling project

GetPredictionExplanationsRowsAsDataFrame

Retrieve all prediction explanations rows and return them as a data frame

GetPredictJobs

Function to list all prediction jobs in a project

GetPrimeEligibility

Check if model can be approximated with DataRobot Prime

GetModelRecommendation

Retrieve a model recommendation from DataRobot for your project.

GetPredictionExplanationsRows

Retrieve all prediction explanations rows

GetTimeSeriesFeatureDerivationLog

Retrieve the time series feature derivation log content

GetProjectStatus

Request Autopilot status for a specified DataRobot project

GetDatetimePartition

Retrieve the DatetimePartitioning from a project

IsParameterIn

Check if a parameter is in a list of possibilities.

GetTrainingPredictionDataFrame

Simplify the training prediction rows into a tidy format dataframe.

GetModelJob

Request information about a single model job

GetModelingFeaturelist

Retrieve a specific modeling featurelist from a DataRobot project

IsId

Checks if an id is a valid DataRobot ID (24 character string)

GetSeriesAccuracy

Get the computed series accuracy for a model, computing it if not already computed.

IsBlenderEligible

Check whether individual models can be blended together

GetRulesets

List the rulesets approximating a model generated by DataRobot Prime

GetLiftChart

Retrieve lift chart data for a model for a data partition (see DataPartition)

GetPredictions

Retrieve model predictions

GetRatingTableModel

Retrieve information about specified model with a rating table.

ListModelRecommendations

Retrieve information about model recommendation made by DataRobot for your project.

GetRatingTableModelFromJobId

Retrieve a new or updated rating table model defined by a job ID.

GetResidualsChart

Retrieve residuals chart data for a model for a data partition (see DataPartition).

GetRocCurve

Retrieve ROC curve data for a model for a particular data partition (see DataPartition)

ListAnomalyAssessmentRecords

Retrieve anomaly assessment records.

JobType

Job type

PeriodicityTimeUnits

Periodicity time units

ModelCapability

Model capabilities

ListFeaturelists

Retrieve all featurelists associated with a project

GetPredictionExplanationsMetadata

Retrieve metadata for specified prediction explanations

ListDrivers

Returns a dataframe with information on available drivers.

ListDeployments

List all current model deployments.

JobStatus

Job statuses

GetValidMetrics

Retrieve the valid fitting metrics for a specified project and target

GetPrimeModelFromJobId

Retrieve information about specified DataRobot Prime model using corresponding jobId.

GetPrimeModel

Retrieve information about specified DataRobot Prime model.

GetTuningParameters

Retrieve data on tuning parameters for a particular model.

GetPredictionExplanationsMetadataFromJobId

Retrieve the prediction explanations metadata for a model using jobId

ListSharingAccess

List information about which users have what kinds of access to a shared object.

ListStarredModels

List all the starred models in a project.

ListFeatureInfo

Details about all features for this project

PostgreSQLdrivers

PostgreSQL drivers

ListCalendars

List all available calendars.

ListBlueprints

Retrieve the list of available blueprints for a project

GetModelBlueprintChart

Retrieve a model blueprint chart

GetSeriesAccuracyForModel

Get the series accuracy associated with a particular model.

GetFeatureImpact

Get the feature impact for a model, requesting the feature impact if it is not already available.

ListResidualsCharts

Retrieve residuals chart data for a model for all available data partitions (see DataPartition). This chart is only available for regression models that are not time-aware.

GetModelBlueprintDocumentation

Get documentation for tasks used in the model blueprint

GetPrimeFile

Retrieve a specific Prime file from a DataRobot project

GetMissingValuesReport

Get a report on missing values for the model.

GetFeatureImpactForJobId

Retrieve completed Feature Impact results given a job ID

ListRocCurves

Retrieve ROC curve data for a model for all available data partitions (see DataPartition)

GetServerDataInRows

Handle server side pagination.

GetRecommendedModel

Retrieve the model object that DataRobot recommends for your project.

GetPrimeFileFromJobId

Retrieve a specific Prime file from a DataRobot project for corresponding jobId

GetRedirectFromResponse

Helper method to retrieve the redirect from the response headers to any request that puts or queries for a DR job. Use this in your job-related methods to simplify testing.

GetModelParameters

Retrieve model parameters

SegmentAnalysisAttribute

Segment analysis attributes

ListModelFeatures

Returns the list of features (i.e., variables) on which a specified model is based

ListComplianceDocTemplates

Retrieve information about all compliance doc templates.

ModelReplacementReason

Model replacement reason

ProjectFromJobResponse

Retrieve a project from the job response, which has a project-creation URL

MulticlassDeploymentAccuracyMetric

Accuracy metrics for multiclass deployments

PrimeLanguage

Prime Language

ListJobs

Retrieve information about jobs

ListLiftCharts

Retrieve lift chart data for a model for all available data partitions (see DataPartition)

ReplaceDeployedModel

Replace a model in a deployment with another model.

RequestSampleSizeUpdate

Refits an existing model to a different fraction of the training dataset

SetTarget

Set the target variable (and by default, start the DataRobot Autopilot)

RequestPrimeModel

Request training for a DataRobot Prime model using a specified ruleset

RequestApproximation

Request an approximation of a model using DataRobot Prime

ListPredictionExplanationsMetadata

Retrieve metadata for prediction explanations in specified project

MakeDataRobotRequest

Make a HTTP request

ListConfusionCharts

Returns all available confusion charts for the model.

ListModelingFeaturelists

Retrieve all modeling featurelists associated with a project

UpdateModelingFeaturelist

Update a modeling featurelist

ListTransferableModels

Retrieve information about all imported models This function returns a data.frame that describes all imported models

ListProjects

Retrieve a list of all DataRobot projects

ListPrimeModels

Retrieve information about all DataRobot Prime models for a DataRobot project

GetTrainingPredictionsFromJobId

Retrieve the training predictions for a model using a job id.

GetTransferableModel

Retrieve imported model info using import id

ListModelJobs

Retrieve status of Autopilot modeling jobs that are not complete

ListPredictions

Fetch all computed predictions for a project.

ListPrimeFiles

List all downloadable code files from DataRobot Prime for the project

RequestTransferableModel

Request creation of a transferable model

RequestFrozenModel

Train a new frozen model with parameters from specified model

RequestSeriesAccuracy

Compute the series accuracy for a model.

RequestFeatureImpact

Request Feature Impact to be computed.

ListTrainingPredictions

Retrieve information about all training prediction datasets in a project.

UpdateAccess

Update access to a particular object.

SetupProject

Function to set up a new DataRobot project

GetModel

Retrieve the details of a specified model

UpdateComplianceDocTemplate

Update the name or sections of an existing doc template.

Share a shareable object with a particular user.

UploadPredictionDataset

Function to upload new data to a DataRobot project for predictions

ToggleStarForModel

Star a model if it is unstarred, otherwise unstar the model.

ReformatMetrics

replace NULL in $metrics list elements with NA

GetPredictionExplanationsInitializationFromJobId

Retrieve the prediction explanations initialization for a model using jobId

GetPredictionExplanationsInitialization

Retrieve the prediction explanations initialization for a model.

TreatAsExponential

Treat as exponential

RecommendedModelType

Recommended model type values

GetRatingTableFromJobId

Get a rating table from the rating table job metadata.

ListPredictionServers

List all available prediction servers.

GetPredictionDataset

Retrieve data on a prediction dataset

Predict

Retrieve model predictions

GetTrainingPredictions

Retrieve training predictions on a specified data set.

GetPredictionExplanations

Get prediction explanations

GetRatingTable

Retrieve a single rating table.

StartRetryWaiter

Creates a waiter function that can be used in a loop while trying some task many times. The waiter sleeps while waiting to try again, with sleep times determined by exponential back-off.

RequestNewDatetimeModel

Adds a new datetime model of the type specified by the blueprint to a DataRobot project

RequestFrozenDatetimeModel

Train a new frozen datetime model with parameters from the specified model

GetTrainingPredictionsForModel

Get training predictions for a particular model.

PauseQueue

Pause the DataRobot modeling queue

RequestBlender

Submit a job for creating blender model. Upon success, the new job will be added to the end of the queue.

RequestCrossSeriesDetection

Format a cross series with group by columns.

PeriodicityMaxTimeStep

Periodicity max time step

RequestPredictionExplanationsInitialization

Request prediction explanations initialization for specified model

RequestPredictions

Request predictions from a model against a previously uploaded dataset

RequestNewModel

Adds a new model of type specified by blueprint to a DataRobot project

GetWordCloud

Retrieve word cloud data for a model.

TimeUnits

Time units

TestDataStore

Test the database connection to the data store.

InitializeAnomalyAssessment

Request anomaly assessment insight computation on the specified subset.

RequestTrainingPredictions

Request training predictions for a specific model.

ValidateCalendar

Get a calendar id from a calendar object.

RequestMultiSeriesDetection

Format a multiseries.

ScoreBacktests

Compute the scores for all available backtests.

SaveCABundlePreference

Save the CA bundle path to the session environment variable.

UpdateProject

Update parameters for an existing project

PredictionDatasetFromAsyncUrl

Retrieve prediction dataset info from the dataset creation URL

RunInteractiveTuning

Run an interactive model tuning session.

SubmitActuals

Submit actuals for processing.

WaitForJobToComplete

Wait for specified job to complete

WaitForAutopilot

This function periodically checks whether Autopilot is finished and returns only after it is.

as.dataRobotProjectShort

Return value for SetupProject() and others

cvMethods

CV methods

UploadPredictionDatasetFromDataSource

Upload a prediction dataset from a data source.

ValidateMultiSeriesProperties

Validate that the multiseries properties indicate a successful multiseries setup.

StartTuningSession

Create a function to initiate hyperparameter tuning for a particular model.

UpdateFeaturelist

Update a featurelist

ListRatingTableModels

Retrieve information about all DataRobot models with a rating table.

ListPredictionDatasets

Retrieve all prediction datasets associated with a project

ListDataStores

Returns a dataframe with information on available data stores.

ListModels

Retrieve all available model information for a DataRobot project

ListDataSources

Returns a dataframe with information on available data sources.

ListRatingTables

Retrieve information about all rating tables.

StartProject

Start a project, set the target, and run autopilot.

SourceType

Source types

ValidateProject

Get a projectId from a project object.

UpdateTransferableModel

Update the display name or note for an imported model.

RegressionDeploymentAccuracyMetric

Accuracy metrics for regression deployments

ValidatePartition

Checks if a partition is valid.

reorderColumns

Reorder the columns in a data.frame

RFC3339DateTimeFormat

RFC 3339 datetime format

ValidateParameterIn

Ensure a parameter is valid

RequestPredictionExplanations

Request prediction explanations computation for a specified model and dataset.

RequestNewRatingTableModel

Create a new model from a rating table.

SetPredictionThreshold

Set a custom prediction threshold for binary classification models.

RenameRatingTable

Renames a rating table to a different name.

SetSSLVerification

Configure SSL verification and optional CA bundle for httr.

as.dataRobotMultiSeriesProperties

Return value for GetMultiSeriesProperties() and others

as.dataRobotFeatureInfo

Information on a data feature.

predict.dataRobotModel

Retrieve model predictions using R's default S3 predict method.

datarobot-package

datarobot: 'DataRobot' Predictive Modeling API

formatRFC3339Timestamp

summary.dataRobotModel

DataRobot S3 object methods for R's generic summary function

SetupProjectFromDataSource

Create a project from a data source.

SetupProjectFromHDFS

Function to set up a new DataRobot project using datasource on a WebHDFS server (deprecated)

TargetLeakageType

Target leakage report values

summary.listOfDataRobotTuningParameters

Summarize the list of tuning parameters available for a model.

UpdateDataStore

Update a data store.

UploadData

Upload a data source.

UploadComplianceDocTemplate

Upload a compliance doc template.

SeriesAggregationType

Series aggregation type

UpdateDeploymentDriftTrackingSettings

Update drift tracking settings for a deployment.

StartNewAutoPilot

Starts autopilot on provided featurelist. Only one autopilot can be running at the time. That's why any ongoing autopilot on different featurelist will be halted - modeling jobs in queue would not be affected but new jobs would not be added to queue by halted autopilot.

Stringify

Convert a function into a single string for DataRobot

UnstarModel

Unstar a model.

UnpauseQueue

Re-start the DataRobot modeling queue

ValidateModel

Validate that model belongs to class 'dataRobotModel' and includes projectId and modelId.

parseRFC3339Timestamp

ValidateReplaceDeployedModel

Validate a potential deployment model replacement.

ValidateActuals

Validate that the actuals are a dataframe and contain required columns.

TryingToSubmitNull

Checks to see if we are trying to submit `NULL` as a value.

UploadTransferableModel

Import a previously exported model for predictions.

as.data.frame

DataRobot S3 object methods for R's generic as.data.frame function

as.dataRobotDeploymentAssociationIdSettings

Association ID settings for a deployment.

tidyServiceOverTimeObject

Tidies a ServiceOverTime response object for use in a DF

plot.listOfModels

Plot method for DataRobot S3 objects of class listOfModels

VariableTransformTypes

Types of variable transformations

transformRFC3339Period

The DataRobot Monitoring APIs return dates formatted as RFC 3339 strings. This is the same as ISO 8601. Specifically, 'T' is the date/time separator and 'Z' is used to denote UTC. Fractional seconds are returned. e.g. 2020-01-01T05:00:00.000000Z

UpdateDeploymentSettings

Updates configuration settings for a deployed model.

validateReportingPeriodTime

Helper function for validating reporting period objects used by the deployment monitoring functions. See GetDeploymentServiceStats, GetDeploymentAccuracy, GetDeploymentServiceStatsOverTime, and GetDeploymentAccuracyOverTime.

ViewWebModel

Retrieve a DataRobot web page that displays detailed model information

ViewWebProject

Retrieve a DataRobot web page that displays detailed project information

BatchFeaturesTypeTransform

Create new features by transforming the type of an existing ones.

CABundle

Return the path to the custom CA bundle (if set).

CleanServerData

Reformat paginated data returned from the server.

BlueprintChartToGraphviz

Convert a blueprint chart into graphviz DOT format

CheckUrl

Make sure the path is a reasonable URL

AddEureqaSolution

Add a Eureqa solution to the list of models for the project.

ApplySchema

Apply a schema to DataRobot objects (lists, frames)

ClassificationDeploymentAccuracyMetric

Accuracy metrics for classification deployments