Salesforce Docs Portal

Einstein Discovery REST API Enums

Enums specific to the /smartdatadiscovery namespace

Enums are not versioned. Enum Values are returned in all API versions. Clients should handle values they don't understand gracefully.

Enum Description
Analysis​Outcome​Type​Enum The analysis outcome type. Valid values are:
  • Categorical
  • Count
  • Number
  • Text
Analysis​Prediction​Type​Enum The analysis prediction type. Valid values are:
  • Binary
  • Count
  • Multi​Class
  • None
  • Numeric
Analysis​Sampling​Strategy​Enum The sampling strategy associated with the story version. Valid values are:
  • Discovery
  • None
  • Random
Analysis​Setup​Scope​Type​Enum The type of scope. Valid values are:
  • Created​By​Me
  • Shared​With​Me
Analysis​Setup​Source​Type​Enum The type of source. Valid values are:
  • Analytics​Dataset
  • Live​Dataset
  • Report
Analysis​Setup​Status​Enum The state of analysis performed by an Einstein Discovery service. Valid values are:
  • Autopilot
  • Done​Descriptive
  • Done​Feature​Engineering
  • Done​Model​Metrics
  • Done​Predictive
  • Draft
  • Failed
  • Fetching
  • Generate​Setup
  • In​Progress
  • Postprocessing
  • Preprocessing
  • Queued
  • Queued​For​Fetching
  • Queued​For​Postprocessing
  • Request​To​Delete
  • Resizing
  • Retry​Preprocessing
  • Running​Descriptive
  • Running​Feature​Engineering
  • Running​Model​Metrics
  • Running​Predictive
  • Success
  • Timed​Out
Classification​Type​Enum The type of classification. Valid values are:
  • Binary
Connect​ED​Insight​Type​Enum The insight type to return. Valid values are:
  • Descriptive
  • Summary
Connect​ED​Narrative​Type​Enum The narrative type to return. Valid values are:
  • Positive
  • Negative
Connect​Smart​Data​Discovery​Filter​Operator​Enum The operator to apply to this filter. Valid values are:
  • Between
  • Contains
  • Ends​With
  • Equal
  • Greater​Than
  • Greater​Than​Or​Equal
  • In​Set
  • Less​Than
  • Less​Than​Or​Equal
  • Not​Between
  • Not​Equal
  • Not​In
  • Starts​With
Connect​Smart​Data​Discovery​Outcome​Goal​Enum The outcome goal to filter the collection by. Valid values are:
  • Maximize
  • Minimize
  • None
Insights​Comparison​Enum The insights score comparison criteria. Valid values are:
  • Average
  • Other
  • Uniform​Distribution
Insights​Condition​Restriction​Enum The insights condition restriction. Valid values are:
  • Included
  • Not​Included
Insights​Outcome​Change​Enum The change in outcome value. Valid values are:
  • Decreased
  • Increased
Insights​Result​Category​Enum The insights result category. Valid values are:
  • Negative
  • Positive
Insights​Results​Type​Enum The descriptive insights result type. Valid values are:
  • First​Order
  • Second​Order
Insights​Type​Enum The analysis type for query insights. Valid values are:
  • Descriptive
  • Diagnostic
Metric​Span​Enum The time span for the metrics. Valid values are:
  • Day
  • Month
  • Since​Last​Action
  • Week
Predict​History​Interval​Enum The interval for look back. Valid values are:
  • None
  • Weekly
Prediction​Definition​Collection​Collection​Sort​Order​Type​Enum The sort order type for the collection. Valid values are:
  • Last​Update
  • Name
  • Outcome​Field​Label
  • Prediction​Type
  • Subscribed​Entity
Smart​Data​Discovery​AI​Model​Collection​Sort​Order​Type​Enum The sort order type for the collection. Valid values are:
  • Created​Date
  • Description
  • Name
  • Prediction​Field​Name
  • Prediction​Type
  • Runtime​Type
Smart​Data​Discovery​AI​Model​Status​Enum The model status. Valid values are:
  • Disabled
  • Enabled
  • Upload​Completed
  • Upload​Failed
  • Uploading
  • Validating
  • Validation​Completed
  • Validation​Failed
Smart​Data​Discovery​AI​Model​Transformation​Type​Enum The transformation type. Valid values are:
  • Categorical​Imputation (Replace categorical missing values)
  • Extract​Day​Of​Week (Extract day of week)
  • Extract​Month​Of​Year (Extract month of year)
  • Free​Text​Clustering (Free text clustering)
  • Numerical​Imputation (Replace numerical missing values)
  • Sentiment​Analysis (Detecting sentiment)
  • Time​Series​Forecast (Projected predictions)
  • Typographic​Clustering (Fuzzy matching)
Smart​Data​Discovery​Bucketing​Strategy​Enum The bucketing strategy. Valid values are:
  • Even​Width
  • Manual
  • Percentage
Smart​Data​Discovery​Categorical​Imputation​Method​Enum The categorical imputation method. Valid values are:
  • Auto
Smart​Data​Discovery​Classification​Algorithm​Type​Enum The classification algorithm type. Valid values are:
  • Best (Model tournament)
  • Drf (Distributed Random Forest)
  • Gbm (GBM)
  • Glm (GLM)
  • Xgboost (XGBoost)
Smart​Data​Discovery​Date​Interval​Enum The date interval for the field. Valid values are:
  • Auto
  • Day
  • Month
  • None
  • Quarter
  • Year
Smart​Data​Discovery​Field​Map​Source​Type​Enum The source type for the field mapping. Valid values are:
  • Analytics​Dataset​Field
  • Salesforce​Field
Smart​Data​Discovery​Filter​Field​Type​Enum The filter field type. Valid values are:
  • Boolean
  • Date
  • Date​Time
  • Number
  • Text
Smart​Data​Discovery​Filter​Value​Type​Enum The type of the filter value. Valid values are:
  • Constant
  • Placeholder
Smart​Data​Discovery​Impute​Method​Enum The impute method. Valid values are:
  • Mean
  • Median
  • Mode
  • None
Smart​Data​Discovery​Model​Field​Type​Enum The type of the model field. Valid values are:
  • Date
  • Number
  • Text
Smart​Data​Discovery​Model​Runtime​Type​Enum The runtime type of the model. Valid values are:
  • Discovery
  • H2O
  • Py36Tensorflow244 (TensorFlow)
  • Py37Scikitlearn102 (Scikit Learn v1.0.2)
  • Py37Tensorflow207 (TensorFlow v2.7.0)
Smart​Data​Discovery​Model​Source​Type​Enum The model source type. Valid values are:
  • Discovery
  • User​Upload
Smart​Data​Discovery​Numerical​Imputation​Method​Enum The numerical imputation method. Valid values are:
  • Mean
  • Median
  • Mode
Smart​Data​Discovery​Periodic​Date​Interval​Enum The periodic date interval. Valid values are:
  • Day_of_week
  • Month_of_year
  • Quarter_of_year
Smart​Data​Discovery​Predict​Aggregate​Function​Enum The predict aggregate function type. Valid values are:
  • Average
  • Median
  • Sum
Smart​Data​Discovery​Predict​Aggregate​Status​Enum The predict aggregate status. Valid values are:
  • Error
  • Success
Smart​Data​Discovery​Predict​Job​Status​Enum The status of the predict job. Valid values are:
  • Cancelled
  • Completed
  • Failed
  • In​Progress
  • Not​Started
  • Paused
Smart​Data​Discovery​Predict​Status​Enum The predict status. Valid values are:
  • Error
  • Success
Smart​Data​Discovery​Predict​Type​Enum The predict type. Valid values are:
  • Raw​Data (Represent rows within a two-dimensional array of row values)
  • Record​Overrides (Represent records using Salesforce record Ids. Optionally override or append individual records with an array of row values)
  • Records (Represent rows using Salesforce record Ids associated with the subscribedEntity of the prediction definition)
Smart​Data​Discovery​Prediction​Type​Enum The prediction type. Valid values are:
  • Classification
  • Multiclass​Classification
  • Regression
  • Unknown
Smart​Data​Discovery​Projected​Predictions​Interval​Setting​Type​Enum The projected predictions interval setting type. Valid values are:
  • Count
  • Count​From​Date
  • Date
Smart​Data​Discovery​Projected​Predictions​Interval​Type​Enum The projected predictions internal type. Valid values are:
  • Day
  • Month
  • Quarter
  • Week
Smart​Data​Discovery​Projected​Predictions​Type​Enum The projected predictions type. Valid values are:
  • Categorical
  • Numerical
Smart​Data​Discovery​Pushback​Type​Enum The pushback type. Valid values are:
  • Ai​Record​Insight
  • Direct
Smart​Data​Discovery​Ordering​Enum The strategy for ordering text values. Valid values are:
  • Alphabetical
  • Numeric
  • Occurrence
Smart​Data​Discovery​Recipient​Type​Enum The type of the recipient. Valid values are:
  • Group
  • User
Smart​Data​Discovery​Refresh​Job​Status​Enum The status of the refresh job. Valid values are:
  • Cancelled
  • Completed​With​Warnings
  • Failure
  • No​Runnable​Task
  • Not​Started
  • Running
  • Scoring​Job​Failed
  • Success
  • User​Not​Found
Smart​Data​Discovery​Refresh​Job​Type​Enum The type of the refresh job. Valid values are:
  • Scheduled
  • User​Triggered
Smart​Data​Discovery​Refresh​Task​Status​Enum The status of the refresh task. Valid values are:
  • Analysis​Not​Found
  • Cancelled
  • Dataset​Join​Fields​Missing
  • Dataset​Not​Found
  • Dataset​Not​Updated
  • Failure
  • Limits​Reached
  • Model​Schema​Changed
  • Not​Started
  • Outcome​Values​Changed
  • Poisson​Distribution​Disabled
  • Running
  • Story​Creation​Failure
  • Success
  • User​Not​Found
  • Warning​Threshold​Reached
Smart​Data​Discovery​Regression​Algorithm​Type​Enum The regression algorithm type. Valid values are:
  • Drf (Distributed Random Forest)
  • Gbm (GBM)
  • Glm (GLM)
  • Xgboost (XGBoost)
Smart​Data​Discovery​Sort​Order​Enum The sort order for the collection. Valid values are:
  • Ascending
  • Descending
Smart​Data​Discovery​Transformation​Filter​Type​Enum The transformation filter type for the model. Valid values are:
  • Number
  • Text
Smart​Data​Discovery​Status​Enum The status. Valid values are:
  • Disabled
  • Enabled
Story​Analysis​Type​Enum The analysis type. Valid values are:
  • Count
  • Descriptive
Story​Chart​Value​Type​Enum The story chart value type. Valid values are:
  • Average
  • Baseline
  • Impact
  • Prediction
  • Small​Terms
  • Unexplained
  • Value
Story​Count​Insights​Frequency​Change​Enum The story count insights frequency change. Valid values are:
  • Down
  • Up
Story​Count​Insights​Frequency​;Enum The story count imsights frequency. Valid values are:
  • Less​Often
  • More​Often
Story​Descriptive​Insights​Impact​Enum The descriptive insights impact for the story. Valid values are:
  • Improved
  • Worsened
Story​Descriptive​Insights​Rating​Enum The story descriptive insights rate. Valid values are:
  • Above​Average
  • Below​Average
  • Higher
  • Lower
Story​Field​Detail​Type​Enum The field type. Valid values are:
  • Field
  • Outcome
Story​Narrative​Element​Type​Enum The narrative element type. Valid values are:
  • Bad​Selection
  • Body
  • Buckets​Mismatch​Section
  • Good​Section
  • Heading
  • Missing​Values​Section
  • New​Values​Section
  • Numbered​List
  • Outcome​Value
  • Paragraph
  • Sub​Heading
  • Unordered​List
Validation​Configuration​Strategy​Enum The validation strategy for the configuration. Valid values are:
  • Validation_Dataset
  • Validation_Set_Ratio