# legacydeveloper Bi Dev Guide Rest Sdd - Full Documentation # Abstract Bucketing Strategy The base bucketing strategy. Properties Inherited by [Even​Width​Bucketing​Strategy](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_responses_even_width_bucketing_strategy.htm "The even-width bucketing strategy."), [Manual​Bucketing​Strategy](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_responses_manual_bucketing_strategy.htm "The manual bucketing strategy."), and [Percentile​Bucketing​Strategy](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_responses_percentile_bucketing_strategy.htm "The percentile bucketing strategy.").
Property Name Type Description Filter Group and Version Available Version
type Smart​Data​Discovery​Bucketing​Strategy​Enum The bucketing strategy. Valid values are:
  • Even​Width
  • Manual
  • Percentage
 Small, 54.0 54.0
# Abstract Classification Threshold The base classification threshold. Properties Inherited by [Binary Classification Threshold](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_responses_binary_classification_threshold.htm "A binary classification threshold.").
Property Name Type Description Filter Group and Version Available Version
type Classification​Type​Enum The classification type. Valid values are:
  • Binary
 Small, 47.0 47.0
# Abstract Classification Threshold Input The base classification threshold input. Properties Inherited by [Binary Classification Threshold Input](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_requests_binary_classification_threshold_input.htm "A binary classification threshold input.").
Property Name Type Description Required or Optional Available Version
type Classification​Type​Enum The classification type. Valid values are:
  • Binary
 Required 47.0
# Abstract Date Field Configuration The base Einstein Discovery date field configuration. Properties Inherits properties from [Abstract​Field​Configuration](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_responses_abstract_field_configuration.htm "The base Einstein Discovery field configuration."). Inherited by [Date​Field​Configuration](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_responses_date_field_configuration.htm "The date field configuration.").
Property Name Type Description Filter Group and Version Available Version
interval Smart​Data​Discovery​Date​Interval​Enum The date interval for the field. Valid values are:
  • Auto
  • Day
  • Month
  • None
  • Quarter
  • Year
 Small, 54.0 54.0
max Date The maximum date value for the field. Small, 54.0 54.0
min Date The minimum date value for the field. Small, 54.0 54.0
periodic​Intervals Smart​Data​Discovery​Periodic​Date​Interval​Enum[] A list of the periodic date intervals for the field. Valid values are:
  • Day_of_week
  • Month_of_year
  • Quarter_of_year
 Small, 54.0 54.0
# Abstract Field Configuration The base Einstein Discovery field configuration. Properties Inherited by [Abstract​Date​Field​Configuration](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_responses_abstract_date_field_configuration.htm "The base Einstein Discovery date field configuration."), [Abstract​Numeric​Field​Configuration](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_responses_abstract_numeric_field_configuration.htm "The base Einstein Discovery numeric field configuration."), and[Abstract​Text​Field​Configuration](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_responses_abstract_text_field_configuration.htm "The base Einstein Discovery text field configuration.")
Property Name Type Description Filter Group and Version Available Version
high​Cardinality Boolean Indicates whether the field is a high cardinality field (true) or not (false). Small, 54.0 54.0
ignored Boolean Indicates whether the field is ignored (true) or not (false). Small, 54.0 54.0
label String The developer name for the field. Small, 54.0 54.0
name String The display name for the field. Small, 54.0 54.0
sensitive Boolean Indicates whether the field is sensitive (true) or not (false). Small, 54.0 54.0
type Smart​Data​Discovery​Filter​Field​Type​Enum The field type. Valid values are:
  • Boolean
  • Date
  • Date​Time
  • Number
  • Text
 Small, 54.0 54.0
# Abstract Numeric Field Configuration The base Einstein Discovery numeric field configuration. Properties Inherits properties from [Abstract​Field​Configuration](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_responses_abstract_field_configuration.htm "The base Einstein Discovery field configuration."). Inherited by [Numeric​Field​Configuration](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_responses_numeric_field_configuration.htm "The numeric field configuration.").
Property Name Type Description Filter Group and Version Available Version
bucketing​Strategy Abstract​Bucketing​Strategy The bucketing strategy for the field. Valid values are: Small, 54.0 54.0
impute​Strategy Smart​Data​Discovery​Impute​Strategy The impute strategy for the field. Small, 54.0 54.0
max Double The maximum value for the field. Small, 54.0 54.0
min Double The minimum value for the field. Small, 54.0 54.0
# Abstract Smart Data Discovery Aggregate Prediction The base Einstein Discovery aggregate prediction result. Properties Inherited by [Smart Data Discovery Aggregate Prediction](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_responses_smart_data_discovery_aggregate_prediction.htm "An Einstein Discovery aggregate prediction result.") and [Smart Data Discovery Aggregate Prediction Error](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_responses_smart_data_discovery_aggregate_prediction_error.htm "An Einstein Discovery aggregate prediction error.").
Property Name Type Description Filter Group and Version Available Version
aggregate​Function Smart​Data​Discovery​Predict​Aggregate​Function​Enum The predict aggregate function. Valid values are:
  • Average
  • Median
  • Sum
 Small, 55.0 55.0
middle​Values Smart​Data​Discovery​Aggregate​Predict​Condition[] The list of middle values. Small, 55.0 55.0
prescriptions Smart​Data​Discovery​Aggregate​Predict​Condition[] The list of prescriptions. Small, 55.0 55.0
status Smart​Data​Discovery​Predict​Aggregate​Status​Enum The predict aggregate status. Valid values are:
  • Error
  • Success
 Small, 55.0 55.0
# Abstract Smart Data Discovery AI Model Metrics The base Einstein Discovery AI model metric. Properties Inherited by [Smart Data Discovery AI Model Classification Metrics](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_responses_smart_data_discovery_ai_model_classification_metrics.htm "The binomial classification metrics for an Einstein Discovery AI model."), [Smart Data Discovery AI Model Multiclass Metrics](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_responses_smart_data_discovery_ai_model_multiclass_metrics.htm "The multiclass metrics for an Einstein Discovery AI model."), and [Smart Data Discovery AI Model Regression Metrics](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_responses_smart_data_discovery_ai_model_regression_metrics.htm "The regression metrics for an Einstein Discovery AI model.").
Property Name Type Description Filter Group and Version Available Version
data​Segments​Url String The URL to the data segments metrics for the AI model. Small, 56.0 56.0
feature​Importances​Url String The URL to the feature importances metrics for the AI model. Small, 56.0 56.0
prediction​Type Smart​Data​Discovery​Prediction​Type​Enum The prediction type of the AI model. Valid values are:
  • Classification
  • Multiclass​Classification
  • Regression
  • Unknown
 Small, 54.0 54.0
url String The URL for the metrics Small, 54.0 54.0
# Abstract Smart Data Discovery AI Model Source The base Einstein Discovery AI model prediction property. Properties Inherited by [Smart Data Discovery AI Model Discovery Source](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_responses_smart_data_discovery_ai_model_discovery_source.htm "The discovery source for an AI model.") and [Smart Data Discovery AI Model User Upload Source](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_responses_smart_data_discovery_ai_model_user_upload_source.htm "The user upload source for an AI model.").
Property Name Type Description Filter Group and Version Available Version
type Smart​Data​Discovery​Model​Source​Type​Enum The source type of the AI model. Valid values are:
  • Discovery
  • User​Upload
 Small, 48.0 48.0
# Abstract Smart Data Discovery AI Model Source Input The base source input for an Einstein Discovery AI model. Properties Inherited by [Smart Data Discovery AI Model Discovery Source Input](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_requests_smart_data_discovery_ai_model_discovery_source_input.htm "The discovery source input for a Smart Data Discovery AI Model.") and [Smart Data Discovery AI Model User Upload Source Input](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_requests_smart_data_discovery_ai_model_user_upload_source_input.htm "The user upload source input for a Smart Data Discovery AI Model.").
Property Name Type Description Required or Optional Available Version
type Smart​Data​Discovery​Model​Source​Type​Enum The model source type. Valid values are:
  • Discovery
  • User​Upload
 Required 51.0
# Abstract Smart Data Discovery Field Mapping Source The base Einstein Discovery field mapping source. Properties Inherited by [Smart Data Discovery Field Mapping Analytics Dataset Field](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_responses_smart_data_discovery_field_mapping_analytics_dataset_field.htm "An Einstein Discovery field mapped from an analytics dataset source.") and [Smart Data Discovery Field Mapping Salesforce Field](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_responses_smart_data_discovery_field_mapping_salesforce_field.htm "An Einstein Discovery field mapped from a Salesforce field source.").
Property Name Type Description Filter Group and Version Available Version
type Smart​Data​Discovery​Field​Map​Source​Type​Enum The source type for the field mapping. Valid values are:
  • Analytics​Dataset​Field
  • Salesforce​Field
 Small, 48.0 48.0
# Abstract Smart Data Discovery Field Mapping Source Input The base Einstein Discovery field mapping source input. Properties Inherited by [Smart Data Discovery Field Mapping Analytics Dataset Field Input](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_requests_field_mapping_analytics_dataset_field_input.htm "Input for an Einstein Discovery field mapped from an analytics dataset source.") and [Smart Data Discovery Field Mapping Salesforce Field Input](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_requests_smart_data_discovery_field_mapping_salesforce_field_input.htm "Input for an Einstein Discovery field mapped from a Salesforce field source.").
Property Name Type Description Required or Optional Available Version
type Smart​Data​Discovery​Field​Map​Source​Type​Enum The source type for the field mapping. Valid values are:
  • Analytics​Dataset​Field
  • Salesforce​Field
 Required 48.0
# Abstract Smart Data Discovery Many To One Transformation Input The base input to identify the transformation as many to one. Properties Inherits properties from [Abstract​Smart​Data​Discovery​Transformation​Input](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_requests_abstract_smart_data_discovery_transformation_input.htm "The base Einstein Discovery transformation input."). Inherited by [Smart Data Discovery Categorical Imputation Transformation Input](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_requests_categorical_imputation_transformation_input.htm "The input to identify the transformation as categorical imputation.").
Property Name Type Description Required or Optional Available Version
post​Transformation​Filter Abstract​Smart​Data​Discovery​Transformation​Filter​Input The filter applied after the transformation is executed. Valid values are: Optional 55.0
source​Field​Names String[] A list of field names for the data to transform. Required 55.0
target​Field​Name String The field name to write the transformed value to. Required 55.0
# Abstract Smart Data Discovery Model Field The base Einstein Discovery model field. Properties Inherited by [Smart Data Discovery Model Field Date](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_responses_smart_data_discovery_model_field_date.htm "An Einstein Discovery date model field."), [Smart Data Discovery Model Field Numeric](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_responses_smart_data_discovery_model_field_numeric.htm "An Einstein Discovery numeric model field.") and [Smart Data Discovery Model Field Text](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_responses_smart_data_discovery_model_field_text.htm "An Einstein Discovery text model field.").
Property Name Type Description Filter Group and Version Available Version
disparate​Impact Boolean Indicates whether the model field is disparate impact (true) or not (false). Small, 55.0 55.0
label String The label of the model field. Small, 48.0 48.0
name String The name of the model field. Small, 48.0 48.0
sensitive Boolean Indicates whether the model field is sensitive (true) or not (false). Small, 55.0 55.0
type Smart​Data​Discovery​Model​Field​Type​Enum The type of the model field. Valid values are:
  • Date
  • Number
  • Text
 Small, 48.0 48.0
# Abstract Smart Data Discovery Model Field Input The base Einstein Discovery model field create or update. Properties Inherited by [Smart Data Discovery Model Field Date Input](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_requests_smart_data_discovery_model_field_date_input.htm "The Einstein Discovery date model field create or update."), [Smart Data Discovery Model Numeric Field Input](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_requests_smart_data_discovery_model_field_numeric_input.htm "The Einstein Discovery numeric model field create or update.") and [Smart Data Discovery Model Field Text Input](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_requests_smart_data_discovery_model_field_text_input.htm "The Einstein Discovery text model field create or update.").
Property Name Type Description Required or Optional Available Version
disparate​Impact Boolean Indicates whether the model field is disparate impact (true) or not (false). Required 55.0
label String The label of the model field. Required 48.0
name String The name of the model field. Required 48.0
sensitive Boolean Indicates whether the model field is sensitive (true) or not (false). Optional 55.0
type Smart​Data​Discovery​Model​Field​Type​Enum The type of the model field. Valid values are:
  • Date
  • Number
  • Text
 Small, 48.0 48.0
# Abstract Smart Data Discovery Model Runtime The base Einstein Discovery model run time. Properties
Property Name Type Description Filter Group and Version Available Version
type Smart​Data​Discovery​Model​Runtime​Type​Enum The run time type of the model. Valid values are:
  • Discovery
  • H2O
  • Py36Tensorflow244 (TensorFlow)
  • Py37Scikitlearn102 (Scikit Learn v1.0.2)
  • Py37Tensorflow207 (TensorFlow v2.7.0)
Small, 49.0 49.0
# Abstract Smart Data Discovery Model Runtime Input The base Einstein Discovery model runtime input. Properties Inherited by [Smart Data Discovery Discovery Model Runtime Input](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_requests_smart_data_discovery_discovery_model_runtime_input.htm "The input to identify the model runtime type as Discovery."), [Smart Data Discovery H2O Model Runtime Input](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_requests_smart_data_discovery_h20_model_runtime_input.htm "The input to identify the model runtime type as H20."), [Smart Data Discovery ScikitLearn 120 Model Runtime Input](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_requests_smart_data_discovery_scikitlearn102_model_runtime_input.htm "The input to identify the model runtime type as Scikit Learn v1.0.2."), [Smart Data Discovery TensorFlow 27 Model Runtime Input](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_requests_smart_data_discovery_tensorflow27_model_runtime_input.htm "The input to identify the model runtime type as TensorFlow v2.7.0."), and [Smart Data Discovery TensorFlow Model Runtime Input](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_requests_smart_data_discovery_tensorflow_model_runtime_input.htm "The input to identify the model runtime type as TensorFlow.")
Property Name Type Description Required or Optional Available Version
type Smart​Data​Discovery​Model​Runtime​Type​Enum The runtime type for the model. Valid values are:
  • Discovery
  • H2O
  • Py36Tensorflow244 (TensorFlow)
  • Py37Scikitlearn102 (Scikit Learn v1.0.2)
  • Py37Tensorflow207 (TensorFlow v2.7.0)
Required 49.0
# Abstract Smart Data Discovery One To One Transformation Input The base input to identify the transformation as one to one. Properties Inherits properties from [Abstract​Smart​Data​Discovery​Transformation​Input](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_requests_abstract_smart_data_discovery_transformation_input.htm "The base Einstein Discovery transformation input."). Inherited by [Smart Data Discovery Extract Day Of Week Transformation Input](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_requests_extract_day_of_week_transformation_input.htm "The input for an extract day of week transformation."), [Smart Data Discovery Extract Month Of Year Transformation Input](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_requests_extract_month_of_year_transformation_input.htm "The input for an extract month of year transformation."), [Smart Data Discovery Free Text Clustering Transformation Input](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_requests_free_text_clustering_transformation_input.htm "The input for a free text clustering transformation."), [Smart Data Discovery Numerical Imputation Transformation Input](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_requests_numerical_imputation_transformation_input.htm "The input for a numerical imputation transformation."), [Smart Data Discovery Projected Predictions Transformation Input](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_requests_projected_predictions_transformation_input.htm "The input for a projected predictions transformation.") and [Smart Data Discovery Sentiment Analysis Transformation Input](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_requests_smart_data_discovery_sentiment_analysis_transformation_input.htm "The input for a sentiment analysis transformation.").
Property Name Type Description Required or Optional Available Version
post​Transformation​Filter Abstract​Smart​Data​Discovery​Transformation​Filter​Input The filter applied after the transformation is executed. Valid values are: Optional 55.0
source​Field​Names String[] A list of field names for the data to transform. Required 55.0
target​Field​Name String The field name to write the transformed value to. Required 55.0
# Abstract Smart Data Discovery Predict The base Einstein Discovery predict result. Properties Inherited by [Smart Data Discovery Multiclass Prediction](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_responses_smart_data_discovery_multiclass_predict.htm "An Einstein Discovery multiclass predict result."), [Smart Data Discovery Predict Error](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_responses_smart_data_discovery_predict_error.htm "An Einstein Discovery predict error result.") and [Smart Data Discovery Predict](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_responses_smart_data_discovery_predict.htm "An Einstein Discovery predict result."). | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | baseLine | Double | The base line metric for the predict result. | Small, 41.0 | 41.0 | | import​Warnings | [Smart​Data​Discovery​Predict​Import​Warnings](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_responses_smart_data_discovery_predict_import_warnings.htm "The import warnings for an Einstein Discovery prediction.") | The import warnings for the predict result. | Small, 41.0 | 41.0 | | other | Double | Any other values for the predict result. | Small, 41.0 | 41.0 | | small​Term​Count | Integer | The small term count for the predict result. | Small, 41.0 | 41.0 | | total | Integer | The total of the predict result. | Small, 41.0 | 41.0 | # Abstract Smart Data Discovery Predict Input The base predict input for Einstein Discovery. Properties Inherited by [Smart​Data​Discovery​Predict​Input](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_requests_smart_data_discovery_predict_input.htm "The predict input for Einstein Discovery."), [Smart​Data​Discovery​Predict​Raw​Data​Input](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_requests_smart_data_discovery_predict_raw_data_input.htm "The predict raw data input for Einstein Discovery."), [Smart​Data​Discovery​Predict​Record​Overrides​Input](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_requests_smart_data_discovery_predict_record_overrides_input.htm "The predict record overrides input for Einstein Discovery."), and [Smart​Data​Discovery​Predict​Record​Input](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_requests_smart_data_discovery_predict_record_input.htm "The predict record input for Einstein Discovery.").
Property Name Type Description Required or Optional Available Version
model Asset Reference Input The model for the predict Required 48.0
prediction​Definition String The prediction definition ID for the predict. Required 44.0
settings Smart Data Discover Predict Settings Input The settings to control the predict output. Optional 46.0
type 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)
Required 44.0
# Abstract Smart Data Discovery Prediction The base Einstein Discovery prediction result. Properties Inherited by [Smart Data Discovery Prediction](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_responses_smart_data_discovery_prediction.htm "An Einstein Discovery prediction result.") and [Smart Data Discovery Prediction Error](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_responses_smart_data_discovery_prediction_error.htm "An Einstein Discovery prediction error.").
Property Name Type Description Filter Group and Version Available Version
status Smart​Data​Discovery​Predict​Status​Enum The predict status. Valid values are:
  • Error
  • Success
 Small, 44.0 44.0
# Abstract Smart Data Discovery Prediction Property The base Einstein Discovery AI model prediction property. Properties Inherited by [Smart Data Discovery Classification Prediction Property](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_responses_smart_data_discovery_classification_prediction_property.htm "The classification prediction model type."), [Smart Data Discovery Multiclass Classification Prediction Property](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_responses_multiclass_classification_prediction_property.htm "The multiclass classification prediction model type."), and [Smart Data Discovery Regression Classification Prediction Property](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_responses_regression_classification_prediction_property.htm "The regression classification prediction model type.").
Property Name Type Description Filter Group and Version Available Version
type Smart​Data​Discovery​Prediction​Type​Enum The prediction type. Valid values are:
  • Classification
  • Multiclass​Classification
  • Regression
  • Unknown
 Small, 44.0 44.0
# Abstract Smart Data Discovery Prediction Property Input The base Einstein Discovery prediction property input. Properties Inherited by [Smart Data Discovery Classification Prediction Property Input](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_requests_classification_prediction_property_input.htm "The input to identify the prediction type as Classification."), [Smart Data Discovery Multiclass Classification Prediction Property Input](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_requests_multiclass_classification_prediction_property_input.htm "The input to identify the prediction type as Multiclass Classification."), and [Smart Data Discovery Regression Prediction Property Input](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_requests_smart_data_discovery_regression_prediction_property_input.htm "The input to identify the prediction type as Regression.").
Property Name Type Description Required or Optional Available Version
type Smart​Data​Discovery​Prediction​Type​Enum The prediction type for the model. Valid values are:
  • Classification
  • Multiclass​Classification
  • Regression
  • Unknown
 Required 55.0
# Abstract Smart Data Discovery Projected Prediction The base Einstein Discovery projected prediction result. Properties Inherited by [Smart Data Discovery Catagorical Projected Prediction](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_responses_smart_data_discovery_categorical_projected_prediction.htm "An Einstein Discovery categorical projected prediction.") and [Smart Data Discovery Numerical Projected Prediction](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_responses_smart_data_discovery_numerical_projected_prediction.htm "An Einstein Discovery numerical projected prediction.").
Property Name Type Description Filter Group and Version Available Version
type Smart​Data​Discovery​Projected​Predictions​Type​Enum The projected predictions type. Valid values are:
  • Categorical
  • Numerical
 Small, 54.0 54.0
# Abstract Smart Data Discovery Projected Predictions Interval Setting The base Einstein Discovery projected predictions interval settings. Properties Inherited by [Smart Data Discovery Projected Predictions Count From Date Interval Setting](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_responses_projected_predictions_count_from_date_interval_setting.htm "The settings for an Einstein Discovery count from date based projection interval."), [Smart Data Discovery Projected Predictions Count Interval Setting](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_responses_projected_predictions_count_interval_setting.htm "The settings for an Einstein Discovery count based projection interval."), and [Smart Data Discovery Projected Predictions Date Interval Setting](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_responses_projected_predictions_date_interval_setting.htm "The settings for an Einstein Discovery date interval.").
Property Name Type Description Filter Group and Version Available Version
type Smart​Data​Discovery​Projected​Predictions​Interval​Setting​Type​Enum The projected predictions interval setting type. Valid values are:
  • Count
  • Count​From​Date
  • Date
 Small, 55.0 55.0
# Abstract Smart Data Discovery Projected Predictions Interval Setting Input The base Einstein Discovery projected predictions interval settings input. Properties Inherited by [Smart Data Discovery Projected Predictions Count From Date Interval Setting Input](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_requests_projected_predictions_count_from_date_interval_setting_input.htm "The input for settings for an Einstein Discovery count from date based projection interval."), [Smart Data Discovery Projected Predictions Count Interval Setting Input](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_requests_projected_predictions_count_interval_setting_input.htm "The input for settings for an Einstein Discovery count based projection interval."), and [Smart Data Discovery Projected Predictions Date Interval Setting Input](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_requests_projected_predictions_date_interval_setting_input.htm "The input for settings for an Einstein Discovery date interval.").
Property Name Type Description Required and Optional Available Version
type Smart​Data​Discovery​Projected​Predictions​Interval​Setting​Type​Enum The projected predictions interval setting type. Valid values are:
  • Count
  • Count​From​Date
  • Date
 Required 55.0
# Abstract Smart Data Discovery Transformation Filter Input The base Einstein Discovery transformation filter input. Properties Inherited by [Smart Data Discovery Discovery Numeric Transformation Filter Input](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_requests_smart_data_discovery_numeric_transformation_filter_input.htm "The input for a numeric transformation filter.") and [Smart Data Discovery Discovery Text Transformation Filter Input](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_requests_smart_data_discovery_text_transformation_filter_input.htm "The input for a text transformation filter.")
Property Name Type Description Required or Optional Available Version
type Smart​Data​Discovery​Transformation​Filter​Type​Enum The transformation filter type for the model. Valid values are:
  • Number
  • Text
 Required 55.0
# Abstract Smart Data Discovery Transformation Input The base Einstein Discovery transformation input. Properties Inherited by [Abstract Smart Data Discovery Discovery Many To One Transformation Input](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_requests_abstract_many_to_one_transformation_input.htm "The base input to identify the transformation as many to one.") and [Abstract Smart Data Discovery Discovery One To One Transformation Input](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_requests_abstract_one_to_one_transformation_input.htm "The base input to identify the transformation as one to one.")
Property Name Type Description Required or Optional Available Version
type Smart​Data​Discovery​AI​Model​Transformation​Type​Enum The runtime type for the model. 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)
Required 55.0
# Abstract Smart Data Discovery Transformation Override The base Einstein Discovery transformation deploy overrides. Properties Inherited by [Smart Data Discovery Projected Predictions Override](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_responses_smart_data_discovery_projected_predictions_override.htm "The settings for an Einstein Discovery projected predictions override.").
Property Name Type Description Filter Group and Version Available Version
id String The ID of the override. Small, 55.0 55.0
input Asset​Reference A transformation asset associated with the override settings. Small, 55.0 55.0
type 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)
Small, 55.0 55.0
# Abstract Smart Data Discovery Transformation Override Input The base Einstein Discovery transformation deploy override input. Properties Inherited by [Smart Data Discovery Projected Predictions Override Input](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_requests_smart_data_discovery_projected_predictions_override_input.htm "The input for deploy time projected predictions transformation overrides.").
Property Name Type Description Required or Optional Available Version
input Asset​Reference​Input A transformation asset associated with the override settings. Required 55.0
type 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)
Required 55.0
# Abstract Smart Data Discovery Validation Configuration The base validation configuration output. Properties Inherited by [Validation Dataset](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_responses_validation_dataset.htm "The output for a validation dataset configuration.") and [Validation Ratio](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_responses_validation_ratio.htm "The output for a validation ratio configuration.").
Property Name Type Description Filter Group and Version Available Version
strategy Validation​Configuration​Strategy​Enum The validation strategy for the configuration. Valid values are:
  • Validation_Dataset
  • Validation_Set_Ratio
 Small, 57.0 57.0
# Abstract Story Data Property The base Einstein Discovery story data property filter. Properties Inherited by [Story All Other Field Value](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_responses_story_all_other_field_value.htm "The story data property for all other values in a field."), [Story Day Field Value](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_responses_story_day_field_value.htm "The story data day property."), [Story Day Of Week Field Value](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_responses_story_day_of_week_field_value.htm "The story data day of week property."), [Story Field Only](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_responses_story_field_only.htm "The story data field property."), [Story Month Field Value](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_responses_story_month_field_value.htm "The story data month property."), [Story Month Of Year Field Value](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_responses_story_month_of_year_field_value.htm "The story data month of year property."), [Story Null Field Value](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_responses_story_null_field_value.htm "The story data null property."), [Story Quarter Field Value](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_responses_story_quarter_field_value.htm "The story data quarter property."), [Story Quarter Of Year Field Value](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_responses_story_quarter_of_year_field_value.htm "The story data quarter of year property."), [Story Range Field Value](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_responses_story_range_field_value.htm "The story data range property."), [Story Text Field Value](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_responses_story_text_field_value.htm "The story data text property."), and [Story Year Field Value](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_responses_story_year_field_value.htm "The story data year property."). | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | field | String | The filter field developer name. | Small, 52.0 | 52.0 | | type | String | The filter field type. | Small, 52.0 | 52.0 | # Abstract Story Data Property Input The base Einstein Discovery story data property filter. Properties Inherited by [Story Day Field Value Input](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_requests_story_day_field_value_input.htm "The story data day property."), [Story Day Of Week Field Value Input](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_requests_story_day_of_week_field_value_input.htm "The story data day of week property."), [Story Field Only Input](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_requests_story_field_only_input.htm "The story data field property."), [Story Month Field Value Input](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_requests_story_month_field_value_input.htm "The story data month property."), [Story Month Of Year Field Value Input](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_requests_story_month_of_year_field_value_input.htm "The story data month of year property."), [Story Null Field Value Input](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_requests_story_null_field_value_input.htm "The story data null property."), [Story Quarter Field Value Input](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_requests_story_quarter_field_value_input.htm "The story data quarter property."), [Story Quarter Of Year Field Value Input](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_requests_story_quarter_of_year_field_value_input.htm "The story data quarter of year property."), [Story Range Field Value Input](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_requests_story_range_field_value_input.htm "The story data range property."), [Story Text Field Value Input](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_requests_story_text_field_value_input.htm "The story data text property."), and [Story Year Field Value Input](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_requests_story_year_field_value_input.htm "The story data year property."). | Property Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | field | String | The filter field developer name. | Required | 52.0 | | type | String | The filter field type. | Required | 52.0 | # Abstract Story Insights The base story insights. Properties Inherited by [Story​First​Order​Insights](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_responses_story_first_order_insights.htm "The first order insights for a story.") and [Story​Second​Order​Insights](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_responses_story_second_order_insights.htm "The second order insights for a story.").
Property Name Type Description Filter Group and Version Available Version
chart Story​Chart The insights chart for the story. Small, 54.0 54.0
details Story​Insights​Detail[] A list of insight details for the story. Small, 52.0 52.0
filter​Field Story​Field​Label​Value​Property The insights filter field details for the story. Small, 52.0 52.0
narrative Story​Narrative The insights narrative for the story. Small, 54.0 54.0
type Insights​Results​Type​Enum The descriptive insights result type. Valid values are:
  • First​Order
  • Second​Order
 Small, 52.0 52.0
# Abstract Story Insights Case The base story insights case. Properties Inherited by [Story​Descriptive​Insights​Case](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_responses_story_descriptive_insights_case.htm "A descriptive story insights case.") and [Story​Count​Insights​Case](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_responses_story_count_insights_case.htm "A count story insights case.").
Property Name Type Description Filter Group and Version Available Version
field Story​Field​Label​Value​Property The case field for the story insight. Small, 54.0 54.0
type Story​Analysis​Type​Enum The analysis type. Valid values are:
  • Count
  • Descriptive
 Small, 52.0 52.0
value String The field value for the story insight. Small, 52.0 52.0
# Abstract Story Narrative Element The base story narrative element. Properties Inherited by [Story​Narrative​Element​Text](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_responses_story_narrative_element_text.htm "The text element for a story narrative.").
Property Name Type Description Filter Group and Version Available Version
type 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
 Small, 54.0 54.0
# Abstract Story Source The base Einstein Discovery analysis source. Properties Inherited by [Analytics​Dataset​Source](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_responses_analytics_dataset_source.htm "An analytics dataset as the analysis source.") and [Report​Source](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_responses_report_source.htm "An analytics report as the analysis source.").
Property Name Type Description Filter Group and Version Available Version
type Analysis​Setup​Source​Type​Enum The source type of the analysis. Valid values are:
  • Analytics​Dataset
  • Live​Dataset
  • Report
 Small, 45.0 45.0
# Abstract Text Field Configuration The base Einstein Discovery text field configuration. Properties Inherits properties from [Abstract​Field​Configuration](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_responses_abstract_field_configuration.htm "The base Einstein Discovery field configuration."). Inherited by [Text​Field​Configuration](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_responses_text_field_configuration.htm "The text field configuration.").
Property Name Type Description Filter Group and Version Available Version
include​Other Boolean Indicates whether values that don't match the specified values should be grouped into other (true) or not (false). Small, 54.0 54.0
ordering Smart​Data​Discovery​Ordering​Enum The strategy for ordering text values. Valid values are:
  • Alphabetical
  • Numeric
  • Occurrence
 Small, 54.0 54.0
values Text​Field​Value​Configuration[] A list of values for the field. Small, 54.0 54.0
# Analytics Dataset Source An analytics dataset as the analysis source. Properties Inherits properties from [Abstract​Story​Source](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_responses_abstract_story_source.htm "The base Einstein Discovery analysis source."). | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | dataset | [Asset Reference](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_responses_asset_reference.htm "An Einstein Discovery asset reference. This wraps the BaseAssetReference") | The dataset for an analysis source. | Small, 45.0 | 45.0 | | dataset​Version | [Asset Reference](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_responses_asset_reference.htm "An Einstein Discovery asset reference. This wraps the BaseAssetReference") | The dataset version for an analysis source. | Small, 45.0 | 45.0 | # API End-of-Life Policy Salesforce is committed to supporting each API version for a minimum of three years from the date of first release. In order to mature and improve the quality and performance of the API, versions that are more than three years old might cease to be supported. When an API version is to be deprecated, advance notice is given at least one year before support ends. Salesforce will directly notify customers using API versions planned for deprecation. | Salesforce API Versions | Version Support Status | Version Retirement Info | | --- | --- | --- | | Versions 31.0 through 68.0 | Supported. | | | Versions 21.0 through 30.0 | As of Summer ’25, these versions are retired and unavailable. | [Salesforce Platform API Versions 21.0 through 30.0 Retirement](https://help.salesforce.com/s/articleView?id=000389618&type=1&language=en_US) | | Versions 7.0 through 20.0 | As of Summer ’22, these versions are retired and unavailable. | [Salesforce Platform API Versions 7.0 through 20.0 Retirement](https://help.salesforce.com/s/articleView?id=000380623&type=1&language=en_US) | If you request any resource or use an operation from a retired API version, REST API returns 410:GONE error code. To identify requests made from old or unsupported API versions of REST API, access the free API Total Usage event type. # Asset History The asset history record. Properties | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | created​By | [Wave​User](https://developer.salesforce.com/docs/atlas.en-us.264.0.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_wave_user.htm) | The user who created the asset history record. | Small, 46.0 | 46.0 | | created​Date | Date | The creation date of the asset history record. | Small, 46.0 | 46.0 | | history​Url | String | The URL to the asset history metadata details. | Small, 46.0 | 46.0 | | id | String | The ID for the asset history record. | Small, 46.0 | 46.0 | | is​Current | Boolean | Indicates whether this history record is the current version of the asset (true) or not (false). | Small, 47.0 | 47.0 | | label | String | The optional label tag for the asset history record. | Small, 46.0 | 46.0 | | name | String | The developer name for the asset history record. | Small, 46.0 | 46.0 | | preview​Url | String | The URL to preview how an asset looked at a particular point in time. This URL doesn't revert the current asset to the asset history record. | Small, 46.0 | 46.0 | | revert​Url | String | The URL to revert the current asset to this asset history record. | Small, 46.0 | 46.0 | | status | String | The status value of the asset. | Small, 49.0 | 49.0 | # Asset History Collection A collection of asset history items. Properties | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | histories | [Asset​History](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_responses_asset_history.htm "The asset history record.")\[\] | The list of asset histories. | Small, 46.0 | 46.0 | # Asset Reference An Einstein Discovery asset reference. This wraps the BaseAssetReference Properties [Base Asset Reference](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_responses_base_asset_reference.htm "The base Einstein Discovery asset, inherited by AssetReference.") # Asset Reference Input An Einstein Discovery asset reference. This wraps the BaseAssetReferenceInput Properties [Base Asset Reference Input](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_requests_base_asset_reference_input.htm "The base Einstein Discovery asset, inherited by AssetReferenceInput.") # Autopilot The setup for autopilot. Properties | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | enabled | Boolean | Indicates whether autopilot is enabled (true) or not (false). | Small, 55.0 | 55.0 | # Base Asset Reference The base Einstein Discovery asset, inherited by AssetReference. Properties | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | id | String | The ID of the asset. | Small, 42.0 | 42.0 | | label | String | The label of the asset. | Small, 42.0 | 42.0 | | name | String | The developer name of the asset. | Small, 42.0 | 42.0 | | namespace | String | The namespace that qualifies the asset name. | Small, 42.0 | 42.0 | | url | String | The URL of the asset. | Small, 42.0 | 42.0 | # Base Asset Reference Input The base Einstein Discovery asset, inherited by AssetReferenceInput. Properties | Property Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | id | String | The ID of the asset. | Required | 42.0 | | name | String | The developer name of the asset. | Required | 42.0 | | namespace | String | The namespace that qualifies the asset name. | Optional | 42.0 | # Binary Classification Threshold A binary classification threshold. Properties Inherits properties from [Abstract​Classification​Threshold](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_responses_abstract_classification_threshold.htm "The base classification threshold."). | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | value | Double | The data for a source analysis. | Small, 47.0 | 47.0 | # Binary Classification Threshold Input A binary classification threshold input. Properties Inherits properties from [Abstract​Classification​Threshold​Input](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_requests_abstract_classification_threshold_input.htm "The base classification threshold input."). | Property Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | value | Double | The data for a source analysis. | Required | 47.0 | # Connect REST API Authorization Connect REST API uses OAuth to securely identify your application before connecting to Salesforce. ## OAuth and Connect REST API For current OAuth information, see [OAuth and Connect REST API](https://developer.salesforce.com/docs/atlas.en-us.264.0.chatterapi.meta/chatterapi/intro_using_oauth.htm) in the Connect REST API developer guide. ## More Resources Salesforce offers the following resources to help you navigate connected apps and OAuth: - _Salesforce Help_: [Connected Apps](https://help.salesforce.com/articleView?id=connected_app_overview.htm&language=en_US "HTML (New Window)") - _Salesforce Help_: [Authorize Apps with OAuth](https://help.salesforce.com/articleView?id=remoteaccess_authenticate.htm&language=en_US "HTML (New Window)") - _Salesforce Help_: [OpenID Connect Token Introspection](https://help.salesforce.com/articleView?id=remoteaccess_oidc_token_introspection_endpoint.htm&language=en_US "HTML (New Window)") - _Trailhead_: [Build Integrations Using Connected Apps](https://trailhead.salesforce.com/en/content/learn/trails/build-integrations-using-connected-apps "HTML (New Window)") # Date Field Configuration The date field configuration. Properties Inherits properties from [Abstract​Date​Field​Configuration](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_responses_abstract_date_field_configuration.htm "The base Einstein Discovery date field configuration."). # Diagnostic Insights Case A story query diagnostic insights. Properties
Property Name Type Description Filter Group and Version Available Version
change​In​Outcome Double The change in outcome score. Small, 53.0 53.0
fields Story​Field​Label​Value​Property[] A list of fields responsible for impact on outcome due to the selected condition. Small, 53.0 53.0
global​Mean Double The global mean without any condition. Small, 53.0 53.0
has​Demographic​Changed Boolean Indicates whether the demographic changed due to this case (true) or not (false). Small, 53.0 53.0
mean​With​Condition Double The mean with the primary condition selected for diagnostic insight. Small, 53.0 53.0
outcome​Change​Type Insights​Outcome​Change​Enum The change in outcome value. Valid values are:
  • Decreased
  • Increased
 Small, 53.0 53.0
# Directory Item Collection A collection of directory items. Properties | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | items | String | A list of items in the collection and their URLs. | Small, 50.0 | 50.0 | # Einstein Discovery REST API Resources Overview The Einstein Discovery REST API provides resources so you can access your Einstein Discovery insights. All Einstein Discovery REST API resources are accessed using: - A base URL for your company (for example, https://yourInstance.salesforce.com) - Version information (for example, /services/data/v53.0) - A named resource (for example, /smartdatadiscovery) Put together, an example of the full URL to the resource is: https://yourInstance.salesforce.com/services/data/v55.0/smartdatadiscovery Org and Object Identifiers Id fields in Salesforce, and for Einstein Discovery, are typically 15-character, base-62, case-sensitive strings. However, many Salesforce APIs, including the Einstein Discovery REST API, use 18-character, case-insensitive strings—for example, the Id property of the Story resource /smartdatadiscovery/stories/. The last 3 digits are a checksum of the preceding 15 characters. The use of case-insensitive Id’s eases interaction with external applications and development environments that use case-insensitive references. To convert an 18-character Id back to a 15-character ID, simply remove the last 3 characters. General Resources General resources for Einstein Discovery are covered here, while specific features like prediction definitions and stories have their own sections. | Resource | Description | Supported HTTP Method | Resource URL | | --- | --- | --- | --- | | [Metrics Resource](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_resources_metrics.htm "Returns the metrics collection for Einstein Discovery.") | Returns the metrics for Einstein Discovery. | GET | /smartdatadiscovery/metrics | | [Narrative Resource](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_resources_narrative.htm "Returns the narrative data for an Einstein Discovery story.") | Returns the narrative data for an Einstein Discovery story. | POST | /smartdatadiscovery/narrative | | [Predict Resource](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_resources_predict.htm "Make an Einstein Discovery prediction.") | Creates an Einstein Discovery prediction. | POST | /smartdatadiscovery/predict | | [Predict History Resource](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_resources_predict_history.htm "Query the history of Einstein Discovery predictions.") | Query the history of Einstein Discovery predictions. | POST | /smartdatadiscovery/predict-history | | [Smart Data Discovery Resource](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_resources_smart_data_discovery.htm "Lists the top-level resources available for Einstein Discovery.") | Lists the top-level resources available for Einstein Discovery. | GET | /smartdatadiscovery | ## Filtering REST Responses In addition to Einstein Discovery REST API input parameters, you can use the following Connect REST API input parameters to filter the results returned from a request: filterGroup, external, and internal. For more information, see [Specifying Response Sizes](https://developer.salesforce.com/docs/atlas.en-us.264.0.chatterapi.meta/chatterapi/connect_returns_filters.htm) in the Connect REST API Developer Guide. # Einstein Discovery Connect REST API Release Notes Use the Salesforce Release Notes to learn about the most recent updates and changes to the Einstein Discovery Connect REST API. For new and changed Einstein Discovery Connect REST resources and request and response bodies see [CRM Analytics](https://help.salesforce.com/s/articleView?id=release-notes.rn_bi_analytics_cloud.htm&language=en_US) in the Salesforce Release Notes and look for Einstein Discovery REST API. ![Note](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/images/icon_note.png) #### Note If the API: New and Changed Items section in the Salesforce Release Notes isn’t present, there aren’t any updates for that release. # 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
# Einstein Discovery REST API Examples Use Einstein Discovery REST API examples to perform tasks. ## Considerations While using the Einstein Discovery REST API, keep this in mind: - Request parameters may be included as part of the Einstein Discovery REST API resource URL, for example, /smartdatadiscovery/models?q=status. A request body is a rich input which may be included as part of the request. When accessing a resource, you can use either a request body or request parameters. You cannot use both. - With a request body, use Content-Type: application/json or Content-Type: application/xml. - With request parameters, use Content-Type: application/x-www-form-urlencoded. - **[Get Predictions](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_edd_prediction_service_predict.htm)** The Einstein Prediction Service provides a REST API endpoint to request a prediction. - **[Manage Prediction Definitions](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_edd_prediction_service_prediction_definition.htm)** The Einstein Prediction Service provides REST API endpoints to manage prediction definitions. A prediction definition specifies what the model is trying to predict and the Salesforce entity associated with the prediction. Each prediction definition has a unique id. Only certain attributes of a prediction definition can be modified. - **[Manage Models](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_edd_prediction_service_model.htm)** The Einstein Prediction Service provides REST API endpoints to manage models. Each model has a unique id. A model is used to evaluate predictors and return predictions and improvements. These REST endpoints allow you to make updates to model metadata, but not update the actual predictive model. - **[Manage Prediction Jobs](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_edd_prediction_service_job.htm)** The Einstein Prediction Service provides REST API endpoints to run bulk scoring jobs for a prediction. Bulk scoring jobs enable you to score predictions on multiple records at a time. For example, after deploying an updated model, use bulk scoring to refresh all prediction scores. You can also run bulk scoring on historical data to see how well your model performs. With bulk scoring, you can score all records, a segment of the records, or records that haven’t reached the terminal state. - **[Manage Model Refresh Jobs](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_edd_prediction_service_refresh_job.htm)** The Einstein Prediction Service provides REST API endpoints to retrieve metadata for model refresh jobs. - **[Query Prediction History](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_edd_prediction_service_predict_history.htm)** The Einstein Prediction Service provides a REST API endpoint to query prediction histories. # Einstein Discovery REST API Overview You can access Einstein Discovery features such as predictions, models, and stories programmatically using the Einstein Discovery REST API. Using the Einstein Discovery REST API, you can: - Create and retrieve Einstein Discovery predictions. - Create and retrieve Einstein Discovery models. - Create and retrieve Einstein Discovery stories. For more information, see [Einstein Prediction Service](https://help.salesforce.com/articleView?id=bi_edd_prediction_service.htm&language=en_US). The Einstein Discovery REST API is based on the Connect REST API and follows its conventions. For more information about the Connect REST API, see the [Connect REST API Developer Guide](https://developer.salesforce.com/docs/atlas.en-us.264.0.chatterapi.meta/chatterapi/intro_what_is_chatter_connect.htm). - **[Einstein Discovery Connect REST API Release Notes](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_rest_sdd_releasenotes.htm)** Use the Salesforce Release Notes to learn about the most recent updates and changes to the Einstein Discovery Connect REST API. - **[Connect REST API Authorization](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_rest_authentication.htm)** Connect REST API uses OAuth to securely identify your application before connecting to Salesforce. - **[API End-of-Life Policy](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_rest_api_rest_eol.htm)** Salesforce is committed to supporting each API version for a minimum of three years from the date of first release. In order to mature and improve the quality and performance of the API, versions that are more than three years old might cease to be supported. # Einstein Discovery REST API Request Bodies To perform a POST, PATCH, or PUT request, pass query parameters or create a request body formatted in either XML or JSON. This chapter lists the request bodies. The query parameters are listed with each resource. To create a JSON request body, specify the properties of the request body in JSON format. This is an example of a Comment request body. { "body" : "Let's look for a new solution." } If a request body is top-level, it has a root XML tag listed. To create an XML request body, nest the properties as XML tags inside the root XML tag. This is the same Einstein Discovery request body in XML format: Let's look for a new solution. - **[Abstract Classification Threshold Input](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_requests_abstract_classification_threshold_input.htm)** The base classification threshold input. - **[Abstract Smart Data Discovery AI Model Source Input](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_requests_abstract_smart_data_discovery_ai_model_source_input.htm)** The base source input for an Einstein Discovery AI model. - **[Abstract Smart Data Discovery Field Mapping Source Input](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_requests_abstract_smart_data_discovery_field_mapping_source_input.htm)** The base Einstein Discovery field mapping source input. - **[Abstract Smart Data Discovery Many To One Transformation Input](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_requests_abstract_many_to_one_transformation_input.htm)** The base input to identify the transformation as many to one. - **[Abstract Smart Data Discovery Model Field Input](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_requests_abstract_smart_data_discovery_model_field_input.htm)** The base Einstein Discovery model field create or update. - **[Abstract Smart Data Discovery Model Runtime Input](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_requests_abstract_smart_data_discovery_model_runtime_input.htm)** The base Einstein Discovery model runtime input. - **[Abstract Smart Data Discovery One To One Transformation Input](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_requests_abstract_one_to_one_transformation_input.htm)** The base input to identify the transformation as one to one. - **[Abstract Smart Data Discovery Predict Input](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_requests_abstract_smart_data_discovery_predict_input.htm)** The base predict input for Einstein Discovery. - **[Abstract Smart Data Discovery Prediction Property Input](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_requests_abstract_smart_data_discovery_prediction_property_input.htm)** The base Einstein Discovery prediction property input. - **[Abstract Smart Data Discovery Projected Predictions Interval Setting Input](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_requests_abstract_projected_predictions_interval_setting_input.htm)** The base Einstein Discovery projected predictions interval settings input. - **[Abstract Smart Data Discovery Transformation Filter Input](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_requests_abstract_smart_data_discovery_transformation_filter_input.htm)** The base Einstein Discovery transformation filter input. - **[Abstract Smart Data Discovery Transformation Input](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_requests_abstract_smart_data_discovery_transformation_input.htm)** The base Einstein Discovery transformation input. - **[Abstract Smart Data Discovery Transformation Override Input](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_requests_abstract_smart_data_discovery_transformation_override_input.htm)** The base Einstein Discovery transformation deploy override input. - **[Abstract Story Data Property Input](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_requests_abstract_story_data_property_input.htm)** The base Einstein Discovery story data property filter. - **[Asset Reference Input](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_requests_asset_reference_input.htm)** An Einstein Discovery asset reference. This wraps the BaseAssetReferenceInput - **[Base Asset Reference Input](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_requests_base_asset_reference_input.htm)** The base Einstein Discovery asset, inherited by AssetReferenceInput. - **[Binary Classification Threshold Input](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_requests_binary_classification_threshold_input.htm)** A binary classification threshold input. - **[Predict History Input](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_requests_predict_history_input.htm)** The query input for prediction history. - **[Predict History Range Input](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_requests_predict_history_range_input.htm)** The range for prediction history query. - **[Smart Data Discovery AI Model Discovery Source Input](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_requests_smart_data_discovery_ai_model_discovery_source_input.htm)** The discovery source input for a Smart Data Discovery AI Model. - **[Smart Data Discovery AI Model Input](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_requests_smart_data_discovery_ai_model_input.htm)** The Einstein Discovery AI model to create or update. - **[Smart Data Discovery AI Model Transformation Input](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_requests_smart_data_discovery_ai_model_transformation_input.htm)** The input for an Einstein Discovery AI model transformation. - **[Smart Data Discovery AI Model User Upload Source Input](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_requests_smart_data_discovery_ai_model_user_upload_source_input.htm)** The user upload source input for a Smart Data Discovery AI Model. - **[Smart Data Discovery Categorical Imputation Transformation Input](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_requests_categorical_imputation_transformation_input.htm)** The input to identify the transformation as categorical imputation. - **[Smart Data Discovery Classification Prediction Property Input](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_requests_classification_prediction_property_input.htm)** The input to identify the prediction type as Classification. - **[Smart Data Discovery Cluster Input](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_requests_smart_data_discovery_cluster_input.htm)** The input for cluster definitions. - **[Smart Data Discovery Complex Filter Input](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_requests_smart_data_discovery_complex_filter_input.htm)** The complex filter input for Einstein Discovery. - **[Smart Data Discovery Custom Prescribable Field Definition Input](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_requests_custom_prescribable_field_definition_input.htm)** The input for a custom Einstein Discovery prescribable field definition to override default prescription text. - **[Smart Data Discovery Customizable Field Input](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_requests_smart_data_discovery_customizable_field_input.htm)** Input for an Einstein Discovery customizable field. - **[Smart Data Discovery Discovery Model Runtime Input](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_requests_smart_data_discovery_discovery_model_runtime_input.htm)** The input to identify the model runtime type as Discovery. - **[Smart Data Discovery Extract Day of Week Transformation Input](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_requests_extract_day_of_week_transformation_input.htm)** The input for an extract day of week transformation. - **[Smart Data Discovery Extract Month of Year Transformation Input](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_requests_extract_month_of_year_transformation_input.htm)** The input for an extract month of year transformation. - **[Smart Data Discovery Field Mapping Analytics Dataset Field Input](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_requests_field_mapping_analytics_dataset_field_input.htm)** Input for an Einstein Discovery field mapped from an analytics dataset source. - **[Smart Data Discovery Field Mapping Input](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_requests_smart_data_discovery_field_mapping_input.htm)** An Einstein Discovery field mapping. - **[Smart Data Discovery Field Mapping Salesforce Field Input](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_requests_smart_data_discovery_field_mapping_salesforce_field_input.htm)** Input for an Einstein Discovery field mapped from a Salesforce field source. - **[Smart Data Discovery Filter Input](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_requests_smart_data_discovery_filter_input.htm)** The filter input for Einstein Discovery. - **[Smart Data Discovery Filter Value Input](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_requests_smart_data_discovery_filter_value_input.htm)** The filter value input for Einstein Discovery. - **[Smart Data Discovery Free Text Clustering Transformation Input](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_requests_free_text_clustering_transformation_input.htm)** The input for a free text clustering transformation. - **[Smart Data Discovery H20 Model Runtime Input](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_requests_smart_data_discovery_h20_model_runtime_input.htm)** The input to identify the model runtime type as H20. - **[Smart Data Discovery Model Input](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_requests_smart_data_discovery_model_input.htm)** The Einstein Discovery model to create or update. - **[Smart Data Discovery Model Field Date Input](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_requests_smart_data_discovery_model_field_date_input.htm)** The Einstein Discovery date model field create or update. - **[Smart Data Discovery Model Field Numeric Input](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_requests_smart_data_discovery_model_field_numeric_input.htm)** The Einstein Discovery numeric model field create or update. - **[Smart Data Discovery Model Field Text Input](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_requests_smart_data_discovery_model_field_text_input.htm)** The Einstein Discovery text model field create or update. - **[Smart Data Discovery Multiclass Classification Prediction Property Input](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_requests_multiclass_classification_prediction_property_input.htm)** The input to identify the prediction type as Multiclass Classification. - **[Smart Data Discovery Narrative Filter Input](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_requests_smart_data_discovery_narrative_filter_input.htm)** The narrative filter metadata. - **[Smart Data Discovery Narrative Input](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_requests_smart_data_discovery_narrative_input.htm)** The Einstein Discovery story narrative to retrieve. - **[Smart Data Discovery Narrative Insight Input](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_requests_smart_data_discovery_narrative_insight_input.htm)** The narrative insight metadata. - **[Smart Data Discovery Narrative Query Input](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_requests_smart_data_discovery_narrative_query_input.htm)** The query metadata for the Einstein Discovery story narrative to retrieve. - **[Smart Data Discovery Numeric Range Input](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_requests_smart_data_discovery_numeric_range_input.htm)** A numeric range for a field. - **[Smart Data Discovery Numeric Transformation Filter Input](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_requests_smart_data_discovery_numeric_transformation_filter_input.htm)** The input for a numeric transformation filter. - **[Smart Data Discovery Numerical Imputation Transformation Input](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_requests_numerical_imputation_transformation_input.htm)** The input for a numerical imputation transformation. - **[Smart Data Discovery Predict Extension Input](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_requests_smart_data_discovery_predict_extension_input.htm)** The predict record extension input for Einstein Discovery. - **[Smart Data Discovery Predict Input](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_requests_smart_data_discovery_predict_input.htm)** The predict input for Einstein Discovery. - **[Smart Data Discovery Predict Nested Row List Input](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_requests_smart_data_discovery_predict_nested_row_list_input.htm)** The predict nested row list input for Einstein Discovery. - **[Smart Data Discovery Predict Job Input](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_requests_smart_data_discovery_predict_job_input.htm)** The predict job input for Einstein Discovery. - **[Smart Data Discovery Predict Job Update Input](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_requests_smart_data_discovery_predict_job_update_input.htm)** The input to update a predict job for Einstein Discovery. - **[Smart Data Discovery Predict Settings Input](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_requests_smart_data_discovery_predict_settings_input.htm)** The predict settings input for Einstein Discovery. - **[Smart Data Discovery Predict Raw Data Input](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_requests_smart_data_discovery_predict_raw_data_input.htm)** The predict raw data input for Einstein Discovery. - **[Smart Data Discovery Predict Record Overrides Input](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_requests_smart_data_discovery_predict_record_overrides_input.htm)** The predict record overrides input for Einstein Discovery. - **[Smart Data Discovery Predict Record Input](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_requests_smart_data_discovery_predict_record_input.htm)** The predict record input for Einstein Discovery. - **[Smart Data Discovery Prescribable Field Input](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_requests_smart_data_discovery_prescribable_field_input.htm)** Input for an Einstein Discovery prescribable field. - **[Smart Data Discovery Projected Prediction Settings Input](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_requests_smart_data_discovery_projected_prediction_settings_input.htm)** The projected prediction settings input for Einstein Discovery. - **[Smart Data Discovery Projected Predictions Count From Date Interval Setting Input](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_requests_projected_predictions_count_from_date_interval_setting_input.htm)** The input for settings for an Einstein Discovery count from date based projection interval. - **[Smart Data Discovery Projected Predictions Count Interval Setting Input](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_requests_projected_predictions_count_interval_setting_input.htm)** The input for settings for an Einstein Discovery count based projection interval. - **[Smart Data Discovery Projected Predictions Date Interval Setting Input](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_requests_projected_predictions_date_interval_setting_input.htm)** The input for settings for an Einstein Discovery date interval. - **[Smart Data Discovery Projected Predictions Historical Dataset Source Input](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_requests_projected_predictions_historical_dataset_source_input.htm)** The input for projected predictions transformation. - **[Smart Data Discovery Projected Predictions Override Input](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_requests_smart_data_discovery_projected_predictions_override_input.htm)** The input for deploy time projected predictions transformation overrides. - **[Smart Data Discovery Projected Predictions Transformation Input](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_requests_projected_predictions_transformation_input.htm)** The input for a projected predictions transformation. - **[Smart Data Discovery Regression Prediction Property Input](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_requests_smart_data_discovery_regression_prediction_property_input.htm)** The input to identify the prediction type as Regression. - **[Smart Data Discovery Scikit Learn 102 Model Runtime Input](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_requests_smart_data_discovery_scikitlearn102_model_runtime_input.htm)** The input to identify the model runtime type as Scikit Learn v1.0.2. - **[Smart Data Discovery Sentiment Analysis Transformation Input](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_requests_smart_data_discovery_sentiment_analysis_transformation_input.htm)** The input for a sentiment analysis transformation. - **[Smart Data Discovery TensorFlow 27 Model Runtime Input](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_requests_smart_data_discovery_tensorflow27_model_runtime_input.htm)** The input to identify the model runtime type as TensorFlow v2.7.0. - **[Smart Data Discovery TensorFlow Model Runtime Input](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_requests_smart_data_discovery_tensorflow_model_runtime_input.htm)** The input to identify the model runtime type as TensorFlow. - **[Smart Data Discovery Text Transformation Filter Input](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_requests_smart_data_discovery_text_transformation_filter_input.htm)** The input for a text transformation filter. - **[Story Day Field Value Input](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_requests_story_day_field_value_input.htm)** The story data day property. - **[Story Day of Week Field Value Input](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_requests_story_day_of_week_field_value_input.htm)** The story data day of week property. - **[Story Field Only Input](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_requests_story_field_only_input.htm)** The story data field property. - **[Story Month Field Value Input](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_requests_story_month_field_value_input.htm)** The story data month property. - **[Story Month of Year Field Value Input](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_requests_story_month_of_year_field_value_input.htm)** The story data month of year property. - **[Story Null Field Value Input](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_requests_story_null_field_value_input.htm)** The story data null property. - **[Story Quarter Field Value Input](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_requests_story_quarter_field_value_input.htm)** The story data quarter property. - **[Story Quarter of Year Field Value Input](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_requests_story_quarter_of_year_field_value_input.htm)** The story data quarter of year property. - **[Story Query Input](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_requests_story_query_input.htm)** The input to query an Einstein Discovery story. - **[Story Range Field Value Input](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_requests_story_range_field_value_input.htm)** The story data range property. - **[Story Text Field Value Input](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_requests_story_text_field_value_input.htm)** The story data text property. - **[Story Year Field Value Input](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_requests_story_year_field_value_input.htm)** The story data year property. # Einstein Discovery REST API Response Bodies The successful execution of a request to an Einstein Discovery REST API resource can return a response body in either JSON or XML format. A request to an Einstein Discovery REST API resource always returns an HTTP response code, whether the request was successful or not. - **[Abstract Bucketing Strategy](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_responses_abstract_bucketing_strategy.htm)** The base bucketing strategy. - **[Abstract Classification Threshold](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_responses_abstract_classification_threshold.htm)** The base classification threshold. - **[Abstract Date Field Configuration](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_responses_abstract_date_field_configuration.htm)** The base Einstein Discovery date field configuration. - **[Abstract Field Configuration](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_responses_abstract_field_configuration.htm)** The base Einstein Discovery field configuration. - **[Abstract Numeric Field Configuration](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_responses_abstract_numeric_field_configuration.htm)** The base Einstein Discovery numeric field configuration. - **[Abstract Smart Data Discovery Aggregate Prediction](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_responses_abstract_smart_data_discovery_aggregate_prediction.htm)** The base Einstein Discovery aggregate prediction result. - **[Abstract Smart Data Discovery AI Model Metrics](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_responses_abstract_smart_data_discovery_ai_model_metrics.htm)** The base Einstein Discovery AI model metric. - **[Abstract Smart Data Discovery AI Model Source](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_responses_abstract_smart_data_discovery_ai_model_source.htm)** The base Einstein Discovery AI model prediction property. - **[Abstract Smart Data Discovery Field Mapping Source](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_responses_abstract_smart_data_discovery_field_mapping_source.htm)** The base Einstein Discovery field mapping source. - **[Abstract Smart Data Discovery Model Field](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_responses_abstract_smart_data_discovery_model_field.htm)** The base Einstein Discovery model field. - **[Abstract Smart Data Discovery Model Runtime](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_responses_abstract_smart_data_discovery_model_runtime.htm)** The base Einstein Discovery model run time. - **[Abstract Smart Data Discovery Prediction Property](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_responses_abstract_smart_data_discovery_prediction_property.htm)** The base Einstein Discovery AI model prediction property. - **[Abstract Smart Data Discovery Prediction](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_responses_abstract_smart_data_discovery_prediction.htm)** The base Einstein Discovery prediction result. - **[Abstract Smart Data Discovery Predict](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_responses_abstract_smart_data_discovery_predict.htm)** The base Einstein Discovery predict result. - **[Abstract Smart Data Discovery Projected Prediction](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_responses_abstract_smart_data_discovery_projected_prediction.htm)** The base Einstein Discovery projected prediction result. - **[Abstract Smart Data Discovery Projected Predictions Interval Setting](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_responses_abstract_projected_predictions_interval_setting.htm)** The base Einstein Discovery projected predictions interval settings. - **[Abstract Smart Data Discovery Transformation Override](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_responses_abstract_smart_data_discovery_transformation_override.htm)** The base Einstein Discovery transformation deploy overrides. - **[Abstract Smart Data Discovery Validation Configuration](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_responses_abstract_smart_data_discovery_validation_configuration.htm)** The base validation configuration output. - **[Abstract Story Data Property](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_responses_abstract_story_data_property.htm)** The base Einstein Discovery story data property filter. - **[Abstract Story Insights Case](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_responses_abstract_story_insights_case.htm)** The base story insights case. - **[Abstract Story Insights](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_responses_abstract_story_insights.htm)** The base story insights. - **[Abstract Story Narrative Element](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_responses_abstract_story_narrative_element.htm)** The base story narrative element. - **[Abstract Story Source](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_responses_abstract_story_source.htm)** The base Einstein Discovery analysis source. - **[Abstract Text Field Configuration](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_responses_abstract_text_field_configuration.htm)** The base Einstein Discovery text field configuration. - **[Analytics Dataset Source](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_responses_analytics_dataset_source.htm)** An analytics dataset as the analysis source. - **[Asset History Collection](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_responses_asset_history_collection.htm)** A collection of asset history items. - **[Asset History](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_responses_asset_history.htm)** The asset history record. - **[Asset Reference](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_responses_asset_reference.htm)** An Einstein Discovery asset reference. This wraps the BaseAssetReference - **[Autopilot](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_responses_autopilot.htm)** The setup for autopilot. - **[Base Asset Reference](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_responses_base_asset_reference.htm)** The base Einstein Discovery asset, inherited by AssetReference. - **[Binary Classification Threshold](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_responses_binary_classification_threshold.htm)** A binary classification threshold. - **[Date Field Configuration](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_responses_date_field_configuration.htm)** The date field configuration. - **[Diagnostic Insights Case](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_responses_diagnostic_insights_case.htm)** A story query diagnostic insights. - **[Directory Item Collection](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_responses_directory_item_collection.htm)** A collection of directory items. - **[Even Width Bucketing Strategy](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_responses_even_width_bucketing_strategy.htm)** The even-width bucketing strategy. - **[Manual Bucketing Strategy](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_responses_manual_bucketing_strategy.htm)** The manual bucketing strategy. - **[Model Field Label Metrics](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_responses_model_field_label_metrics.htm)** Model field information that includes label, value and metrics data. - **[Numeric Field Configuration](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_responses_numeric_field_configuration.htm)** The numeric field configuration. - **[Percentile Bucketing Strategy](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_responses_percentile_bucketing_strategy.htm)** The percentile bucketing strategy. - **[Predict History Collection](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_responses_predict_history_collection.htm)** A collection of historical predictions for a goal. - **[Predict History](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_responses_predict_history.htm)** The historical predictions for a target. - **[Predict History Range](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_responses_predict_history_range.htm)** A range used for the historical prediction query. - **[Predict History Value](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_responses_predict_history_value.htm)** A historical prediction value at a specific point in time. - **[Report Source](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_responses_report_source.htm)** An analytics report as the analysis source. - **[Smart Data Discovery Aggregate Predict Condition](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_responses_smart_data_discovery_aggregate_predict_condition.htm)** The aggregate predict condition for a collection of Einstein Discover predictions. - **[Smart Data Discovery Aggregate Prediction Error](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_responses_smart_data_discovery_aggregate_prediction_error.htm)** An Einstein Discovery aggregate prediction error. - **[Smart Data Discovery Aggregate Prediction](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_responses_smart_data_discovery_aggregate_prediction.htm)** An Einstein Discovery aggregate prediction result. - **[Smart Data Discovery AI Model Classification Metrics](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_responses_smart_data_discovery_ai_model_classification_metrics.htm)** The binomial classification metrics for an Einstein Discovery AI model. - **[Smart Data Discovery AI Model Coefficient Collection](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_responses_smart_data_discovery_ai_model_coefficient_collection.htm)** A collection of Einstein Discovery AI model coefficients. - **[Smart Data Discovery AI Model Collection](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_responses_smart_data_discovery_ai_model_collection.htm)** A collection of Einstein Discovery AI models. - **[Smart Data Discovery AI Model Discovery Source](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_responses_smart_data_discovery_ai_model_discovery_source.htm)** The discovery source for an AI model. - **[Smart Data Discovery AI Model Multiclass Metrics](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_responses_smart_data_discovery_ai_model_multiclass_metrics.htm)** The multiclass metrics for an Einstein Discovery AI model. - **[Smart Data Discovery AI Model Regression Metrics](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_responses_smart_data_discovery_ai_model_regression_metrics.htm)** The regression metrics for an Einstein Discovery AI model. - **[Smart Data Discovery AI Model Residual Collection](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_responses_smart_data_discovery_ai_model_residual_collection.htm)** A collection of Einstein Discovery AI model residuals. - **[Smart Data Discovery AI Model Residual](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_responses_smart_data_discovery_ai_model_residual.htm)** AnEinstein Discovery AI model residual. - **[Smart Data Discovery AI Model Transformation](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_responses_smart_data_discovery_ai_model_transformation.htm)** An Einstein Discovery AI model transformation. - **[Smart Data Discovery AI Model User Upload Source](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_responses_smart_data_discovery_ai_model_user_upload_source.htm)** The user upload source for an AI model. - **[Smart Data Discovery AI Model](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_responses_smart_data_discovery_ai_model.htm)** An Einstein Discovery AI model to retrieve. - **[Smart Data Discovery Categorical Projected Prediction](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_responses_smart_data_discovery_categorical_projected_prediction.htm)** An Einstein Discovery categorical projected prediction. - **[Smart Data Discovery Classification Prediction Property](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_responses_smart_data_discovery_classification_prediction_property.htm)** The classification prediction model type. - **[Smart Data Discovery Contact](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_responses_smart_data_discovery_contact.htm)** An Einstein Discovery contact. - **[Smart Data Discovery Custom Prescribable Field Definition](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_responses_smart_data_discovery_custom_prescribable_field_definition.htm)** A custom Einstein Discovery prescribable field definition to override default prescription text. - **[Smart Data Discovery Customizable Field](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_responses_smart_data_discovery_customizable_field.htm)** An Einstein Discovery customizable field. - **[Smart Data Discovery Feature Importance Metric](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_responses_smart_data_discovery_feature_importance_metric.htm)** An importance metric for a Einstein Discovery model. - **[Smart Data Discovery Field Mapping](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_responses_smart_data_discovery_field_mapping.htm)** An Einstein Discovery field mapping. - **[Smart Data Discovery Field Mapping Analytics Dataset Field](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_responses_smart_data_discovery_field_mapping_analytics_dataset_field.htm)** An Einstein Discovery field mapped from an analytics dataset source. - **[Smart Data Discovery Field Mapping Mapped Field](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_responses_smart_data_discovery_field_mapping_mapped_field.htm)** A mapped field in a field mapping. - **[Smart Data Discovery Field Mapping Salesforce Field](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_responses_smart_data_discovery_field_mapping_salesforce_field.htm)** An Einstein Discovery field mapped from a Salesforce field source. - **[Smart Data Discovery Field](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_responses_smart_data_discovery_field.htm)** An Einstein Discovery field. - **[Smart Data Discovery Filter List](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_responses_smart_data_discovery_filter_list.htm)** A list of record filter conditions. - **[Smart Data Discovery Filter Value](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_responses_smart_data_discovery_filter_value.htm)** The value used in an Einstein Discovery filter. - **[Smart Data Discovery Filter](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_responses_smart_data_discovery_filter.htm)** An Einstein Discovery filter used to select a model. - **[Smart Data Discovery Impute Strategy](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_responses_smart_data_discovery_impute_strategy.htm)** The impute strategy. - **[Smart Data Discovery Insight](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_responses_smart_data_discovery_insights.htm)** An insight for an Einstein Discovery analysis. - **[Smart Data Discovery Live Metric Detail](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_responses_smart_data_discovery_live_metric_detail.htm)** A live AI Einstein Discovery metric. - **[Smart Data Discovery Live Metrics](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_responses_smart_data_discovery_live_metrics.htm)** The categorized live AI Einstein Discovery metrics. - **[Smart Data Discovery Metrics Collection](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_responses_smart_data_discovery_metrics_collection.htm)** A collection of Einstein Discovery metrics. - **[Smart Data Discovery Model Card](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_responses_smart_data_discovery_model_card.htm)** An Einstein Discovery model card. - **[Smart Data Discovery Prediction Definition Collection](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_responses_smart_data_discovery_model_collection.htm)** A collection of Einstein Discovery prediction definitions. - **[Smart Data Discovery Model Configuration](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_responses_smart_data_discovery_model_configuration.htm)** The configuration for an Einstein Discovery model. - **[Smart Data Discovery Model Field Date](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_responses_smart_data_discovery_model_field_date.htm)** An Einstein Discovery date model field. - **[Smart Data Discovery Model Field Numeric](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_responses_smart_data_discovery_model_field_numeric.htm)** An Einstein Discovery numeric model field. - **[Smart Data Discovery Model Field Text](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_responses_smart_data_discovery_model_field_text.htm)** An Einstein Discovery text model field. - **[Smart Data Discovery Model](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_responses_smart_data_discovery_model.htm)** An Einstein Discovery model. - **[Smart Data Discovery Multiclass Classification Prediction Property](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_responses_multiclass_classification_prediction_property.htm)** The multiclass classification prediction model type. - **[Smart Data Discovery Multiclass Predict](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_responses_smart_data_discovery_multiclass_predict.htm)** An Einstein Discovery multiclass predict result. - **[Smart Data Discovery Narrative Details](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_responses_smart_data_discovery_narrative_details.htm)** The textual narrative data for an Einstein Discovery story. - **[Smart Data Discovery Narrative Field Collection](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_responses_smart_data_discovery_narrative_field_collection.htm)** A collection of narrative data for an Einstein Discovery story. - **[Smart Data Discovery Narrative Field](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_responses_smart_data_discovery_narrative_field.htm)** A single row of narrative data for an Einstein Discovery story. - **[Smart Data Discovery Narrative Post Body Filter](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_responses_smart_data_discovery_narrative_post_body_filter.htm)** A query filter for narrative data of an Einstein Discovery story. - **[Smart Data Discovery Narrative Post Body Insight](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_responses_smart_data_discovery_narrative_post_body_insight.htm)** The narrative insight metadata. - **[Smart Data Discovery Narrative Post Body Query](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_responses_smart_data_discovery_narrative_post_body_query.htm)** A query for narrative data of an Einstein Discovery story. - **[Smart Data Discovery Narrative Post Body](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_responses_smart_data_discovery_narrative_post_body.htm)** A single row of narrative data for an Einstein Discovery story. - **[Smart Data Discovery Numeric Range](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_responses_smart_data_discovery_numeric_range.htm)** A numeric range for a field. - **[Smart Data Discovery Numerical Projected Prediction](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_responses_smart_data_discovery_numerical_projected_prediction.htm)** An Einstein Discovery numerical projected prediction. - **[Smart Data Discovery Predict Column Custom Text](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_responses_smart_data_discovery_predict_column_custom_text.htm)** The custom text for a predict column given by the Einstein Discovery prediction. - **[Smart Data Discovery Predict Column](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_responses_smart_data_discovery_predict_column.htm)** A column given from an Einstein Discovery prediction. - **[Smart Data Discovery Predict Condition](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_responses_smart_data_discovery_predict_condition.htm)** An Einstein Discovery predict condition. - **[Smart Data Discovery Prediction Definition Collection](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_responses_smart_data_discovery_prediction_definition_collection.htm)** A collection of Einstein Discovery prediction definitions. - **[Smart Data Discovery Prediction Definition](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_responses_smart_data_discovery_prediction_definition.htm)** An Einstein Discovery prediction definition. - **[Smart Data Discovery Prediction Error](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_responses_smart_data_discovery_prediction_error.htm)** An Einstein Discovery prediction error. - **[Smart Data Discovery Prediction](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_responses_smart_data_discovery_prediction.htm)** An Einstein Discovery prediction result. - **[Smart Data Discovery Predict Error](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_responses_smart_data_discovery_predict_error.htm)** An Einstein Discovery predict error result. - **[Smart Data Discovery Import Warnings](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_responses_smart_data_discovery_predict_import_warnings.htm)** The import warnings for an Einstein Discovery prediction. - **[Smart Data Discovery Predict Job Collection](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_responses_smart_data_discovery_predict_job_collection.htm)** A collection of Einstein Discovery predict jobs. - **[Smart Data Discovery Predict Job](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_responses_smart_data_discovery_predict_job.htm)** An Einstein Discovery predict job. - **[Smart Data Discovery Predict List](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_responses_smart_data_discovery_predict_list.htm)** A list of Einstein Discovery predictions. - **[Smart Data Discovery Predict Settings](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_responses_smart_data_discovery_predict_settings.htm)** The settings for an Einstein Discovery prediction. - **[Smart Data Discovery Predict](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_responses_smart_data_discovery_predict.htm)** An Einstein Discovery predict result. - **[Smart Data Discovery Prediction Definition Outcome Field](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_responses_smart_data_discovery_pred_def_outcome_field.htm)** An Einstein Discovery prediction definition outcome field. - **[Smart Data Discovery Prescribable Field](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_responses_smart_data_discovery_prescribable_field.htm)** An Einstein Discovery prescribable field. - **[Smart Data Discovery Projected Prediction Field](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_responses_smart_data_discovery_projected_prediction_field.htm)** An Einstein Discovery projected prediction field. - **[Smart Data Discovery Projected Prediction Settings](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_responses_smart_data_discovery_projected_prediction_settings.htm)** The settings for projected prediction fields. - **[Smart Data Discovery Projected Predictions Count From Date Interval Setting](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_responses_projected_predictions_count_from_date_interval_setting.htm)** The settings for an Einstein Discovery count from date based projection interval. - **[Smart Data Discovery Projected Predictions Count Interval Setting](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_responses_projected_predictions_count_interval_setting.htm)** The settings for an Einstein Discovery count based projection interval. - **[Smart Data Discovery Projected Predictions Date Interval Setting](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_responses_projected_predictions_date_interval_setting.htm)** The settings for an Einstein Discovery date interval. - **[Smart Data Discovery Projected Predictions Override](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_responses_smart_data_discovery_projected_predictions_override.htm)** The settings for an Einstein Discovery projected predictions override. - **[Smart Data Discovery Projected Predictions](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_responses_smart_data_discovery_projected_predictions.htm)** The projected predictions for an Einstein Discovery prediction result. - **[Smart Data Discovery Projected Value](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_responses_smart_data_discovery_projected_value.htm)** An Einstein Discovery projected value. - **[Smart Data Discovery Pushback Field](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_responses_smart_data_discovery_pushback_field.htm)** A pushback field for an Einstein Discovery prediction. - **[Smart Data Discovery Outcome](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_responses_smart_data_discovery_outcome.htm)** The analysis outcome for an Einstein Discovery story. - **[Smart Data Discovery Recipient](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_responses_smart_data_discovery_recipient.htm)** An Einstein Discovery recipient. - **[Smart Data Discovery Refresh Config](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_responses_smart_data_discovery_refresh_config.htm)** The refresh configuration for an Einstein Discovery prediction. - **[Smart Data Discovery Refresh Job Collection](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_responses_smart_data_discovery_refresh_job_collection.htm)** A collection of Einstein Discovery refresh jobs. - **[Smart Data Discovery Refresh Job](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_responses_smart_data_discovery_refresh_job.htm)** An Einstein Discovery refresh job. - **[Smart Data Discovery Refresh Task Collection](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_responses_smart_data_discovery_refresh_task_collection.htm)** A collection of Einstein Discovery refresh task. - **[Smart Data Discovery Refresh Task Source](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_responses_smart_data_discovery_refresh_task_source.htm)** The source for an Einstein Discovery refresh task. - **[Smart Data Discovery Refresh Task](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_responses_smart_data_discovery_refresh_task.htm)** An Einstein Discovery refresh task. - **[Smart Data Discovery Regression Classification Prediction Property](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_responses_regression_classification_prediction_property.htm)** The regression classification prediction model type. - **[Smart Data Discovery Training Metrics](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_responses_smart_data_discovery_training_metrics.htm)** A collection of Einstein Discovery metrics from training a model. - **[Smart Data Discovery User](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_responses_smart_data_discovery_user.htm)** An Einstein Discovery user. - **[Story Diagnostic Insights Detail](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_responses_story_diagnostic_insights_detail.htm)** The detail for story diagnostic insights. - **[Story All Other Field Value](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_responses_story_all_other_field_value.htm)** The story data property for all other values in a field. - **[Story Chart Value](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_responses_story_chart_value.htm)** A value in a story chart. - **[Story Chart Value Detail](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_responses_story_chart_value_detail.htm)** The detail for a value in a story chart. - **[Story Chart](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_responses_story_chart.htm)** A story chart. - **[Story Collection](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_responses_story_collection.htm)** A collection of Einstein Discovery stories. - **[Story Count Insights Case](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_responses_story_count_insights_case.htm)** A count story insights case. - **[Story Day Field Value](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_responses_story_day_field_value.htm)** The story data day property. - **[Story Day of Week Field Value](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_responses_story_day_of_week_field_value.htm)** The story data day of week property. - **[Story Descriptive Insights Case](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_responses_story_descriptive_insights_case.htm)** A descriptive story insights case. - **[Story Details](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_responses_story_details.htm)** The details for a story. These details are the top positive and negative factors contributing to story outcome. - **[Story Field Correlation](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_responses_story_field_correlation.htm)** The summary of each field in the dataset selected for story creation. - **[Story Field Impact Detail](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_responses_story_field_impact_detail.htm)** A story field impact details. - **[Story Field Label Value Property](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_responses_story_field_label_value_property.htm)** A story field. - **[Story Field Only](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_responses_story_field_only.htm)** The story data field property. - **[Story Field](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_responses_story_field.htm)** The field value combination that contributed to the story outcome result. - **[Story First Order Insights](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_responses_story_first_order_insights.htm)** The first order insights for a story. - **[Story Insights Detail](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_responses_story_insights_detail.htm)** The insights detail for a story. - **[Story Month Field Value](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_responses_story_month_field_value.htm)** The story data month property. - **[Story Month of Year Field Value](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_responses_story_month_of_year_field_value.htm)** The story data month of year property. - **[Story Narrative Element Text](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_responses_story_narrative_element_text.htm)** The text element for a story narrative. - **[Story Narrative](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_responses_story_narrative.htm)** A narrative for a story. - **[Story Null Field Value](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_responses_story_null_field_value.htm)** The story data null property. - **[Story Potential Bias](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_responses_story_potential_bias.htm)** The potential bias for a story. - **[Story Quarter Field Value](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_responses_story_quarter_field_value.htm)** The story data quarter property. - **[Story Quarter of Year Field Value](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_responses_story_quarter_of_year_field_value.htm)** The story data quarter of year property. - **[Story Query Diagnostic Insights](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_responses_story_query_diagnostic_insights.htm)** A story query diagnostic insights. - **[Story Query Disparate Impact Detail](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_responses_story_query_disparate_impact_detail.htm)** The detail for a story query disparate impact. - **[Story Query Disparate Impact](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_responses_story_query_disparate_impact.htm)** A disparate impact for a story query. - **[Story Query Input Parameter](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_responses_story_query_input_parameter.htm)** The input parameter for a story query. - **[Story Query](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_responses_story_query.htm)** A query for story insights. - **[Story Range Field Value](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_responses_story_range_field_value.htm)** The story data range property. - **[Story Second Order Insights](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_responses_story_second_order_insights.htm)** The second order insights for a story. - **[Story Summary Detail](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_responses_story_summary_detail.htm)** The summary detail for a story. - **[Story Text Field Value](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_responses_story_text_field_value.htm)** The story data text property. - **[Story Version Reference](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_responses_story_version_reference.htm)** The basic information for an Einstein Discovery story version. - **[Story Version](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_responses_story_version.htm)** An Einstein Discovery story version. - **[Story](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_responses_story.htm)** An Einstein Discovery story. - **[Story Year Field Value](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_responses_story_year_field_value.htm)** The story data year property. - **[Text Field Configuration](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_responses_text_field_configuration.htm)** The text field configuration. - **[Text Field Value Configuration](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_responses_text_field_value_configuration.htm)** The text field value configuration. - **[Validation Dataset](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_responses_validation_dataset.htm)** The output for a validation dataset configuration. - **[Validation Ratio](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_responses_validation_ratio.htm)** The output for a validation ratio configuration. # Einstein Discovery REST Resources REST API resources are sometimes called endpoints. - **[Smart Data Discovery Resource](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_resources_smart_data_discovery.htm)** Lists the top-level resources available for Einstein Discovery. - **[Model Resources](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_resources_models_overview.htm)** Einstein Discovery models are sophisticated, custom mathematical constructs that are used to predict particular outcomes. - **[Metrics Resource](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_resources_metrics.htm)** Returns the metrics collection for Einstein Discovery. - **[Narrative Resource](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_resources_narrative.htm)** Returns the narrative data for an Einstein Discovery story. - **[Prediction Definition Resources](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_resources_prediction_definition_overview.htm)** A prediction definition specifies what the model is trying to predict and the Salesforce entity associated with the prediction. Each prediction definition has a unique id. Only certain attributes of a prediction definition can be modified. - **[Predict Jobs Resources](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_resources_predict_jobs_overview.htm)** Predict jobs run bulk scoring jobs for predictions. Bulk scoring jobs enable scoring predictions on multiple records at a time. For example, after deploying an updated model, use bulk scoring to refresh all prediction scores. - **[Predict Resource](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_resources_predict.htm)** Make an Einstein Discovery prediction. - **[Predict History Resource](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_resources_predict_history.htm)** Query the history of Einstein Discovery predictions. - **[Refresh Jobs Resources](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_resources_refresh_jobs_overview.htm)** Refresh jobs run refresh Einstein Discovery models. - **[Stories Resources](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_resources_stories_overview.htm)** Einstein Discovery stories are used to analyze your data. The insights from stories show you what happened in your data, why it happened, and what could happen. # Even Width Bucketing Strategy The even-width bucketing strategy. Properties Inherits properties from [Abstract​Bucketing​Strategy](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_responses_abstract_bucketing_strategy.htm "The base bucketing strategy."). | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | number​Of​Buckets | Integer | The number of buckets for a numeric field. | Small, 54.0 | 54.0 | # Get Predictions The Einstein Prediction Service provides a REST API endpoint to request a prediction. ## Prediction Request POST ​/smartdatadiscovery​/predict ## POST Request Body Use one of the following to create your request body, [Smart Data Discovery Predict Input](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_requests_smart_data_discovery_predict_input.htm "The predict input for Einstein Discovery."), [Smart Data Discovery Predict Raw Data Input](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_requests_smart_data_discovery_predict_raw_data_input.htm "The predict raw data input for Einstein Discovery."), [Smart Data Discovery Predict Record Overrides Input](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_requests_smart_data_discovery_predict_record_overrides_input.htm "The predict record overrides input for Einstein Discovery."), or [Smart Data Discovery Predict Record Input](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_requests_smart_data_discovery_predict_record_input.htm "The predict record input for Einstein Discovery."). In the request body, you specify the prediction definition to use and the rows of data that you want to score. You can specify rows in one of three available formats: | Format | Description | | --- | --- | | Records | Salesforce record Ids associated with the subscribedEntity of the prediction definition (retrieved using a SOQL query). | | RawData | A two-dimensional array of row values in which each row is a comma-separated list of values. | | RecordOverrides | Array of objects containing the Salesforce record Ids. Optionally, override or append values in individual records with an array of row values (in which each row is a comma-separated list of values). | When you run a prediction, Salesforce applies the model specified in the prediction definition to the set of records and returns a prediction score for each record. If you specify 3 records, for example, you get 3 predictions in the order in which the records were specified in the request. Sample Request when type is Records The following example shows a request body in which type is Records. The records attribute provides a comma-separated list of Salesforce record Ids associated with the subscribedEntity of the prediction definition. You can retrieve a list of available prediction definition Ids using the following API request: GET ​/smartdatadiscovery​/predictiondefinitions You can specify up to 200 Salesforce record Ids. Two records are specified in the following example: { "predictionDefinition": "1ORRM00000000304AA", "type": "Records", "records": \["006RM000002bEfiYAE", "006RM000002bEflYAE" \] } Sample Request when type is RawData The following example shows a request body in which type is RawData. It names five columns and specifies two records with five data values each. The columns were selected during the story setup process. For more information, see [Create a Story](https://help.salesforce.com/s/articleView?id=analytics.bi_edd_create.htm&type=5&language=en_US). { "predictionDefinition": "0OR1H000000Gma9WAC", "type": "RawData", "columnNames": \["StageName","CloseDate","Account.BillingCountry","IsClosed","IsWon"\], "rows": \[ \["Prospecting","2020-06-30","USA","false","false"\], \["Qualification","2020-08-30","EMEA", "false","false"\] \] } Sample Request when type is RecordOverrides The following example shows a request body in which type is RecordOverrides. When specifying row data: - Each Salesforce record Id represents a record in the subscribedEntity associated with the prediction definition. - (Optional) Each row, where specified, contains the values to override or append to the data specified in the associated record. You can specify up to 200 entries (record entries plus row entries) in a request. For example, if you have 120 record entries, you can override up to 80 record entries with row entries. The following example specifies two columns with two record entries and two overrides. { "predictionDefinition": "0OR1H000000Gma9WAC", "type": "RecordOverrides", "columnNames": \["StageName", "CloseDate"\], "rows": \[ { "record": "0061H00000dnhQEQAY", "row": \["Prospecting", "2020-06-30"\] }, { "record": "0061H00000dnhPzQAI", "row": \["Qualification", "2020-08-30"\] } \] } Sample Request for Predictive Factors and Improvements Starting in 50.0, this API returns a single prediction value by default. To request prediction factors and improvements, you must ask for them explicitly in the request body. The following code snippet specifies settings to request prediction factors and improvements. { "predictionDefinition": "1ORB0000000TNYIOA4", "type": "Records", "records": \["006B0000002wvCtIAI"\], "settings": {"maxPrescriptions": 3, "maxMiddleValues": 3, "prescriptionImpactPercentage": 87 } } In this example: - maxPrescriptions specifies the maximum number of improvements (1-3) to return in the response - maxMiddleValues specifies the number of top predictors (1-3) to return in the response - prescriptionImpactPercentage specifies the threshold filter (minimum % improvement for the outcome, which in this example is 87%) needed for the improvement to be returned in the response To learn more about these settings and see these elements on an example Lightning page, see [Add Einstein Predictions to a Lightning Page](https://help.salesforce.com/s/articleView?id=analytics.bi_edd_einstein_predictions_lightning.htm&type=5&language=en_US). ## POST Response The POST response is a [Smart Data Discovery Predict List](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_responses_smart_data_discovery_predict_list.htm "A list of Einstein Discovery predictions.") response. Example POST Response { "predictionDefinition" : "1ORRM0000000030", "predictions" : \[ { "model" : { "id" : "1OtRM000000002b0AA" }, "prediction" : { "baseLine" : 799315.4282959097, "importWarnings" : { "mismatchedColumns" : \[ \], "missingColumns" : \[ "OpportunityAge", "Account.Owner.UniqueUserName", "Account.Industry", "Account.AccountSource", "Account.Owner.Name", "Account.BillingCountry", "Name" \], "outOfBoundsColumns" : \[ \] }, "middleValues" : \[ { "columns" : \[ { "columnName" : "Has Line Item", "columnValue" : "true" } \], "value" : 543763.66105859 } \], "other" : 0.0, "smallTermCount" : 0, "total" : 1343079.0893544997 }, "prescriptions" : \[ \], "status" : "Success" }, { "model" : { "id" : "1OtRM000000002b0AA" }, "prediction" : { "baseLine" : 799315.4282959097, "importWarnings" : { "mismatchedColumns" : \[ \], "missingColumns" : \[ "OpportunityAge", "Account.Owner.UniqueUserName", "Account.Industry", "Account.AccountSource", "Account.Owner.Name", "Account.BillingCountry", "Name" \], "outOfBoundsColumns" : \[ \] }, "middleValues" : \[ { "columns" : \[ { "columnName" : "Has Line Item", "columnValue" : "true" } \], "value" : 543763.66105859 } \], "other" : 0.0, "smallTermCount" : 0, "total" : 1343079.0893544997 }, "prescriptions" : \[ \], "status" : "Success" } \], "settings" : { "maxPrescriptions" : 0, "maxMiddleValues" : 0, "prescriptionImpactPercentage" : 0 } } # Manage Model Refresh Jobs The Einstein Prediction Service provides REST API endpoints to retrieve metadata for model refresh jobs. Model refresh jobs are configured in Model Manager. To set up model refresh jobs, see [Configure Automatic Model Refresh for a Prediction Definition](https://help.salesforce.com/s/articleView?id=analytics.bi_edd_model_manager_refresh.htm&type=5&language=en_US). ## Get Prediction Refresh Jobs GET /smartdatadiscovery​/refresh-jobs The following code shows an example [Smart Data Discovery Refresh Job Collection](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_responses_smart_data_discovery_refresh_job_collection.htm "A collection of Einstein Discovery refresh jobs.") response. { "refreshJobs" : \[ { "createdBy" : { "id" : "005B0000006DdetIAC", "name" : "YourUserName", "profilePhotoUrl" : "https://MyDomainName.file.force.com/profilephoto/729B0000000Eqe5/T" }, "createdDate" : "2020-09-09T16:16:39.000Z", "endTime" : "2020-09-09T16:20:02.000Z", "id" : "1OXB00000008OIPOA2", "refreshTarget" : { "id" : "1ORB0000000TNXyOAO" }, "refreshTasksUrl" : "/services/data/v52.0/smartdatadiscovery/refresh-jobs/1OXB00000008OIPOA2/refresh-tasks", "startTime" : "2020-09-09T16:16:41.000Z", "status" : "Success", "type" : "UserTriggered", "url" : "/services/data/v52.0/smartdatadiscovery/refresh-jobs/1OXB00000008OIPOA2" } \], "totalSize" : 1, "url" : "/services/data/v52.0/smartdatadiscovery/refresh-jobs" } ## Get Prediction Refresh Job Details GET /smartdatadiscovery/refresh-jobs​/ The following code shows an example response. { "refreshJobs" : \[ { "createdBy" : { "id" : "005B0000006DdetIAC", "name" : "YourUserName", "profilePhotoUrl" : "https://MyDomainName.file.force.com/profilephoto/729B0000000Eqe5/T" }, "createdDate" : "2020-09-09T16:16:39.000Z", "endTime" : "2020-09-09T16:20:02.000Z", "id" : "1OXB00000008OIPOA2", "refreshTarget" : { "id" : "1ORB0000000TNXyOAO" }, "refreshTasksUrl" : "/services/data/v52.0/smartdatadiscovery/refresh-jobs/1OXB00000008OIPOA2/refresh-tasks", "startTime" : "2020-09-09T16:16:41.000Z", "status" : "Success", "type" : "UserTriggered", "url" : "/services/data/v52.0/smartdatadiscovery/refresh-jobs/1OXB00000008OIPOA2" } ## Get Prediction Refresh Job Task Details GET /smartdatadiscovery/refresh-jobs​/​/refresh-tasks The following code shows an example [Smart Data Discovery Refresh Job](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_responses_smart_data_discovery_refresh_job.htm "An Einstein Discovery refresh job.") response. { "refreshTasks" : \[ { "createdBy" : { "id" : "005B0000006DdetIAC", "name" : "YourUserName", "profilePhotoUrl" : "https://MyDomainName.file.force.com/profilephoto/729B0000000Eqe5/T" }, "createdDate" : "2020-09-09T16:16:39.000Z", "endTime" : "2020-09-09T16:19:54.000Z", "id" : "1OxB00000008OIKKA2", "refreshTarget" : { "id" : "1OtB0000000TNdAKAW", "label" : "IsWon", "name" : "IsWon" }, "refreshedAIModel" : { "id" : "1OTB0000000PDeBOAW" }, "source" : { "story" : { "id" : "1Y3B00000004HOCKA2" }, "storyVersion" : { "id" : "9B4B00000008UrEKAU" } }, "startTime" : "2020-09-09T16:16:45.000Z", "status" : "Success" } \], "totalSize" : 1, "url" : "/services/data/v52.0/smartdatadiscovery/refresh-jobs/1OXB00000008OIPOA2/refresh-tasks" } # Manage Models The Einstein Prediction Service provides REST API endpoints to manage models. Each model has a unique id. A model is used to evaluate predictors and return predictions and improvements. These REST endpoints allow you to make updates to model metadata, but not update the actual predictive model. ## Get Available Models GET /smartdatadiscovery​/predictiondefinitions​/​/models This code shows an example response of a [Smart Data Discovery Model Collection](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_responses_smart_data_discovery_model_collection.htm "A collection of Einstein Discovery prediction definitions."). HTTP/1.1 200 OK Date: Thu, 30 Jan 2020 17:34:12 GMT Strict-Transport-Security: max-age=31536000; includeSubDomains X-Content-Type-Options: nosniff X-XSS-Protection: 1; mode=block X-Robots-Tag: none Cache-Control: no-cache,must-revalidate,max-age=0,no-store,private Set-Cookie: BrowserId=uqyLl0OGEeq2RPW2iPHbvQ; domain=.salesforce.com; path=/; expires=Fri, 29-Jan-2021 17:34:12 GMT; Max-Age=31536000 Content-Type: application/json;charset=UTF-8 Vary: Accept-Encoding Content-Encoding: gzip Transfer-Encoding: chunked { "models" : \[ { "actionableVariables" : \[ { "label" : "Type", "name" : "Type", "type" : "Text" }, { "label" : "Ownership", "name" : "Ownership", "type" : "Text" }, { "label" : "Rating", "name" : "Rating", "type" : "Text" }, { "label" : "Division", "name" : "Division", "type" : "Text" }, { "label" : "AccountScore", "name" : "AccountScore", "type" : "Text" } \], "createdBy" : { "id" : "005B0000002zz1lIAA", "name" : "MyUserName", "profilePhotoUrl" : "https://MyDomainName.file.force.com/profilephoto/729B00000009ttx/T" }, "createdDate" : "2020-01-17T00:24:35.000Z", "fieldMappingList" : \[ { "modelField" : { "label" : "CloseDate", "name" : "CloseDate", "type" : "Date" } }, { "modelField" : { "label" : "Industry", "name" : "Industry", "type" : "Text" } }, { "modelField" : { "label" : "StartDate", "name" : "StartDate", "type" : "Date" } }, { "modelField" : { "label" : "Ownership", "name" : "Ownership", "type" : "Text" } }, { "modelField" : { "label" : "Type", "name" : "Type", "type" : "Text" } }, { "modelField" : { "label" : "Rating", "name" : "Rating", "type" : "Text" } }, { "modelField" : { "label" : "BillingState", "name" : "BillingState", "type" : "Text" } }, { "modelField" : { "label" : "Division", "name" : "Division", "type" : "Text" } }, { "modelField" : { "label" : "AccountScore", "name" : "AccountScore", "type" : "Text" } } \], "filters" : \[ \], "id" : "1OtB00000004CApKAM", "label" : "CLV", "lastModifiedBy" : { "id" : "005B0000002zz1lIAA", "name" : "MyUserName", "profilePhotoUrl" : "https://MyDomainName.file.force.com/profilephoto/729B00000009ttx/T" }, "lastModifiedDate" : "2020-01-17T00:24:35.000Z", "model" : { "id" : "1OTB000000000ajOAA" }, "modelType" : "Regression", "name" : "CLV", "predictionDefinitionUrl" : "/services/data/v52.0/smartdatadiscovery/predictiondefinitions/1ORB00000004CApOAM", "sortOrder" : 0, "status" : "Enabled", "url" : "/services/data/v52.0/smartdatadiscovery/predictiondefinitions/1ORB00000004CApOAM/models/1OtB00000004CApKAM" }, { "actionableVariables" : \[ { "label" : "Industry", "name" : "Industry", "type" : "Text" }, { "label" : "Type", "name" : "Type", "type" : "Text" }, { "label" : "Ownership", "name" : "Ownership", "type" : "Text" }, { "label" : "Rating", "name" : "Rating", "type" : "Text" }, { "label" : "Division", "name" : "Division", "type" : "Text" } \], "createdBy" : { "id" : "005B0000002zz1lIAA", "name" : "MyUserName", "profilePhotoUrl" : "https://MyDomainName.file.force.com/profilephoto/729B00000009ttx/T" }, "createdDate" : "2020-01-17T00:26:14.000Z", "fieldMappingList" : \[ { "modelField" : { "label" : "CloseDate", "name" : "CloseDate", "type" : "Date" } }, { "modelField" : { "label" : "Industry", "name" : "Industry", "type" : "Text" } }, { "modelField" : { "label" : "StartDate", "name" : "StartDate", "type" : "Date" } }, { "modelField" : { "label" : "Ownership", "name" : "Ownership", "type" : "Text" } }, { "modelField" : { "label" : "Type", "name" : "Type", "type" : "Text" } }, { "modelField" : { "label" : "Rating", "name" : "Rating", "type" : "Text" } }, { "modelField" : { "label" : "BillingState", "name" : "BillingState", "type" : "Text" } }, { "modelField" : { "label" : "Division", "name" : "Division", "type" : "Text" } }, { "modelField" : { "label" : "AccountScore", "name" : "AccountScore", "type" : "Text" } } \], "filters" : \[ \], "id" : "1OtB00000004CAqKAM", "label" : "CLV", "lastModifiedBy" : { "id" : "005B0000002zz1lIAA", "name" : "MyUserName", "profilePhotoUrl" : "https://MyDomainName.file.force.com/profilephoto/729B00000009ttx/T" }, "lastModifiedDate" : "2020-01-17T00:26:14.000Z", "model" : { "id" : "1OTB000000000ajOAA" }, "modelType" : "Regression", "name" : "CLV", "predictionDefinitionUrl" : "/services/data/v52.0/smartdatadiscovery/predictiondefinitions/1ORB00000004CApOAM", "sortOrder" : 1, "status" : "Enabled", "url" : "/services/data/v52.0/smartdatadiscovery/predictiondefinitions/1ORB00000004CApOAM/models/1OtB00000004CAqKAM" } \], "totalSize" : 2, "url" : "/services/data/v52.0/smartdatadiscovery/predictiondefinitions/1ORB00000004CApOAM/models" } ## Get Metadata for a Model GET /smartdatadiscovery​/predictiondefinitions​/​/models/ ## Delete a Model DELETE /smartdatadiscovery​/predictiondefinitions​/​/models/ # Manage Prediction Definitions The Einstein Prediction Service provides REST API endpoints to manage prediction definitions. A prediction definition specifies what the model is trying to predict and the Salesforce entity associated with the prediction. Each prediction definition has a unique id. Only certain attributes of a prediction definition can be modified. ## Get Available Prediction Definitions GET ​/smartdatadiscovery​/predictiondefinitions The following code shows an example [Smart Data Discovery Prediction Definition Collection](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_responses_smart_data_discovery_prediction_definition_collection.htm "A collection of Einstein Discovery prediction definitions.") response: HTTP/1.1 200 OK Date: Tue, 15 Sep 2020 21:58:01 GMT Strict-Transport-Security: max-age=31536000; includeSubDomains X-Content-Type-Options: nosniff X-XSS-Protection: 1; mode=block X-Robots-Tag: none X-B3-TraceId: d16d33c8d031db6e X-B3-SpanId: d16d33c8d031db6e X-B3-Sampled: 0 Cache-Control: no-cache,must-revalidate,max-age=0,no-store,private Set-Cookie: BrowserId=hf3WNPeeEeqhuDcd5jEV6A; domain=.salesforce.com; path=/; expires=Wed, 15-Sep-2021 21:58:01 GMT; Max-Age=31536000 Content-Type: application/json;charset=UTF-8 Vary: Accept-Encoding Content-Encoding: gzip Transfer-Encoding: chunked { "nextPageUrl" : null, "predictionDefinitions" : \[ { "countOfActiveModels" : 1, "countOfModels" : 1, "createdBy" : { "id" : "005B0000001nz1lIAA", "name" : "MyUserName", "profilePhotoUrl" : "https://MyDomainName.file.force.com/profilephoto/729B00000008pwV/T" }, "createdDate" : "2020-04-22T01:25:19.000Z", "id" : "1ORB000000000bOOAQ", "label" : "Maximize CLV - first version", "lastModifiedBy" : { "id" : "005B0000001nz1lIAA", "name" : "MyUserName", "profilePhotoUrl" : "https://MyDomainName.file.force.com/profilephoto/729B00000008pwV/T" }, "lastModifiedDate" : "2020-04-22T01:25:19.000Z", "modelsUrl" : "/services/data/v52.0/smartdatadiscovery/predictiondefinitions/1ORB000000000bOOAQ/models", "name" : "Maximize\_CLV\_first\_version7c48e8db", "outcome" : { "goal" : "Maximize", "label" : "CLV", "name" : "CLV" }, "predictionType" : "Regression", "status" : "Enabled", "url" : "/services/data/v52.0/smartdatadiscovery/predictiondefinitions/1ORB000000000bOOAQ" }, { "countOfActiveModels" : 1, "countOfModels" : 1, "createdBy" : { "id" : "005B0000001nz1lIAA", "name" : "MyUserName", "profilePhotoUrl" : "https://MyDomainName.file.force.com/profilephoto/729B00000008pwV/T" }, "createdDate" : "2020-01-13T21:28:06.000Z", "id" : "1ORB00000004CAkOAM", "label" : "Won\_Won", "lastModifiedBy" : { "id" : "005B0000001nz1lIAA", "name" : "MyUserName", "profilePhotoUrl" : "https://MyDomainName.file.force.com/profilephoto/729B00000008pwV/T" }, "lastModifiedDate" : "2020-04-14T20:37:21.000Z", "modelsUrl" : "/services/data/v52.0/smartdatadiscovery/predictiondefinitions/1ORB00000004CAkOAM/models", "name" : "Won\_Wone329300b", "outcome" : { "goal" : "Maximize", "label" : "Won", "name" : "Won" }, "predictionType" : "Classification", "status" : "Enabled", "url" : "/services/data/v52.0/smartdatadiscovery/predictiondefinitions/1ORB00000004CAkOAM" }, { "countOfActiveModels" : 2, "countOfModels" : 2, "createdBy" : { "id" : "005B0000001nz1lIAA", "name" : "MyUserName", "profilePhotoUrl" : "https://MyDomainName.file.force.com/profilephoto/729B00000008pwV/T" }, "createdDate" : "2020-01-17T00:24:33.000Z", "id" : "1ORB00000004CApOAM", "label" : "CLV Prediction", "lastModifiedBy" : { "id" : "005B0000001nz1lIAA", "name" : "MyUserName", "profilePhotoUrl" : "https://MyDomainName.file.force.com/profilephoto/729B00000008pwV/T" }, "lastModifiedDate" : "2020-01-17T00:24:33.000Z", "modelsUrl" : "/services/data/v52.0/smartdatadiscovery/predictiondefinitions/1ORB00000004CApOAM/models", "name" : "CLV\_Prediction3d72828a", "outcome" : { "goal" : "Maximize", "label" : "CLV", "name" : "CLV" }, "predictionType" : "Regression", "status" : "Enabled", "url" : "/services/data/v52.0/smartdatadiscovery/predictiondefinitions/1ORB00000004CApOAM" }, { "countOfActiveModels" : 1, "countOfModels" : 1, "createdBy" : { "id" : "005B0000001nz1lIAA", "name" : "MyUserName", "profilePhotoUrl" : "https://MyDomainName.file.force.com/profilephoto/729B00000008pwV/T" }, "createdDate" : "2020-02-04T08:28:14.000Z", "id" : "1ORB00000004CCCOA2", "label" : "CLV\_CLV", "lastModifiedBy" : { "id" : "005B0000001nz1lIAA", "name" : "MyUserName", "profilePhotoUrl" : "https://MyDomainName.file.force.com/profilephoto/729B00000008pwV/T" }, "lastModifiedDate" : "2020-02-04T08:28:14.000Z", "modelsUrl" : "/services/data/v52.0/smartdatadiscovery/predictiondefinitions/1ORB00000004CCCOA2/models", "name" : "CLV\_CLVa7cf508c", "outcome" : { "goal" : "Maximize", "label" : "CLV", "name" : "CLV" }, "predictionType" : "Regression", "status" : "Enabled", "url" : "/services/data/v52.0/smartdatadiscovery/predictiondefinitions/1ORB00000004CCCOA2" } \], "totalSize" : 4, "url" : "/services/data/v52.0/smartdatadiscovery/predictiondefinitions" } ## Get Metadata for a Prediction Definition GET /smartdatadiscovery​/predictiondefinitions​/ The following code shows an example [Smart Data Discovery Prediction Definition](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_responses_smart_data_discovery_prediction_definition.htm "An Einstein Discovery prediction definition.") response: HTTP/1.1 200 OK Date: Thu, 17 Sep 2020 16:27:43 GMT Strict-Transport-Security: max-age=31536002; includeSubDomains Public-Key-Pins-Report-Only: pin-sha256="9n0izTnSRF+W4W4JTq51avSXkWhQB8duS2bxVLfzXsY="; pin-sha256="5kJvNEMw0KjrCAu7eXY5HZdvyCS13BbA0VJG1RSP91w="; pin-sha256="njN4rRG+22dNXAi+yb8e3UMypgzPUPHlv4+foULwl1g="; max-age=86400; includeSubDomains; report-uri="https://a.forcesslreports.com/hpkp-report/00DB0000000K2Uzm"; Expect-CT: max-age=86400, report-uri="https://a.forcesslreports.com/Expect-CT-report/00DB0000000K2Uzm" X-Content-Type-Options: nosniff X-XSS-Protection: 1; mode=block X-Robots-Tag: none X-B3-TraceId: da9949518cdecb56 X-B3-SpanId: da9949518cdecb56 X-B3-Sampled: 0 Cache-Control: no-cache,must-revalidate,max-age=0,no-store,private Set-Cookie: BrowserId=tsMTvvkCEeqU9WHivUXHfA; domain=.salesforce.com; path=/; expires=Fri, 17-Sep-2021 16:27:43 GMT; Max-Age=31536000 Content-Type: application/json;charset=UTF-8 Vary: Accept-Encoding Content-Encoding: gzip Transfer-Encoding: chunked { "countOfActiveModels" : 1, "countOfModels" : 1, "createdBy" : { "id" : "005B0000004iaa7IAA", "name" : "Admin User", "profilePhotoUrl" : "https://MyDomainName.file.force.com/profilephoto/729B0000000EmIX/T" }, "createdDate" : "2020-03-31T01:18:51.000Z", "id" : "1ORB000000000JuOAI", "label" : "ItalyInfo", "lastModifiedBy" : { "id" : "005B00000051RBqIAM", "name" : "YourUserName", "profilePhotoUrl" : "https://MyDomainName.file.force.com/profilephoto/729B00000003ARf/T" }, "lastModifiedDate" : "2020-08-18T23:09:25.000Z", "modelsUrl" : "/services/data/v52.0/smartdatadiscovery/predictiondefinitions/1ORB000000000JuOAI/models", "name" : "ItalyInfo9461190a", "outcome" : { "goal" : "Minimize", "label" : "Total Cases", "name" : "totale\_casi" }, "predictionType" : "Regression", "pushbackField" : { "label" : "mypredField", "name" : "Custom\_Opportunity\_\_c.mypredField\_\_c" }, "refreshConfig" : { "isEnabled" : true, "recipientList" : \[ { "displayName" : "YourUserName", "id" : "005B00000051RBqIAM", "type" : "User" } \], "schedule" : { "dayInWeek" : "wednesday", "frequency" : "monthlyrelative", "nextScheduledDate" : "2020-10-08T02:00:00.000Z", "time" : { "hour" : 19, "timeZone" : { "gmtOffset" : -7.0, "name" : "Pacific Daylight Time", "zoneId" : "America/Los\_Angeles" } }, "weekInMonth" : "first" }, "shouldScoreAfterRefresh" : false, "userContext" : { "id" : "005B00000051RBqIAM" }, "warningThresholdPercentage" : 0.05 }, "status" : "Enabled", "subscribedEntity" : "Custom\_Opportunity\_\_c", "url" : "/services/data/v52.0/smartdatadiscovery/predictiondefinitions/1ORB000000000JuOAI" } The refreshConfig section describes model refresh jobs for this prediction. Model refresh jobs are configured in Model Manager as described in [Configure Automatic Model Refresh for a Prediction](https://help.salesforce.com/s/articleView?id=analytics.bi_edd_model_manager_refresh.htm&type=5&language=en_US). ## Delete a Prediction Definition DELETE /smartdatadiscovery​/predictiondefinitions​/ # Manage Prediction Jobs The Einstein Prediction Service provides REST API endpoints to run bulk scoring jobs for a prediction. Bulk scoring jobs enable you to score predictions on multiple records at a time. For example, after deploying an updated model, use bulk scoring to refresh all prediction scores. You can also run bulk scoring on historical data to see how well your model performs. With bulk scoring, you can score all records, a segment of the records, or records that haven’t reached the terminal state. Bulk scoring jobs are configured in Model Manager. To set up Bulk Scoring jobs, see [Score Records in Bulk](https://help.salesforce.com/s/articleView?id=analytics.bi_edd_model_manager_score.htm&type=5&language=en_US). ![Note](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/images/icon_note.png) #### Note If the daily predictions limit is reached in your org, active scoring jobs are paused, then resumed the next day. ## Run a Bulk Scoring Job for a Prediction POST /smartdatadiscovery​/predict-jobs POST Request Body Use the [Smart Data Discovery Job Predict Input](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_requests_smart_data_discovery_predict_job_input.htm "The predict job input for Einstein Discovery.") to create your request body. In the request body, specify the prediction definition Id associated with the bulk scoring request job, along with a user-defined label, and optional filter settings. { "predictionDefinition":{ "id":"{{_predictionDefinitionId_}}" }, "label":"{{_label_}}", "useTerminalStateFilter" : false, "filters":{ "filters":\[ { "fieldName":"Opportunity.Name", "values":\[ "My Opportunity" \], "operator":"Equal" } \] } } You can retrieve a list of available prediction definition Ids using the following API request: GET ​/smartdatadiscovery​/predictiondefinitions ## Get Scoring Jobs GET smartdatadiscovery/predict-jobs # Manual Bucketing Strategy The manual bucketing strategy. Properties Inherits properties from [Abstract​Bucketing​Strategy](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_responses_abstract_bucketing_strategy.htm "The base bucketing strategy."). | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | cutoffs | Double\[\] | A list of manual buckets for a numeric field. | Small, 54.0 | 54.0 | # Metrics Resource Returns the metrics collection for Einstein Discovery. Resource URL /smartdatadiscovery/metrics Formats JSON Available Version 50.0 HTTP Methods GET Request parameters for GET
Parameter Name Type Description Required or Optional Available Version
count Integer The count for the collection. Optional 50.0
span Metric​Span​Enum The time span for the metrics. Valid values are:
  • Day
  • Month
  • Since​Last​Action
  • Week
 Optional 50.0
Response body for GET [Smart Data Discovery Metrics Collection](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_responses_smart_data_discovery_metrics_collection.htm "A collection of Einstein Discovery metrics.") # Model Coefficients Resource Returns a collection of coefficients for an Einstein Discovery model. Resource URL /smartdatadiscovery/models//coefficients Formats JSON Available Version 55.0 HTTP Methods GET Request parameters for GET | Parameter Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | model​Id | String | The ID of the model to retrieve the coefficients for. | Required | 55.0 | | page | String | A generated token that indicates the view of model metrics to be returned. | Optional | 55.0 | | page​Size | Integer | The number of items to be returned in a single page. Minimum is 1, maximum is 200, and default is 25. | Optional | 55.0 | Response body for GET [Smart Data Discovery AI Model Coefficient Collection](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_responses_smart_data_discovery_ai_model_coefficient_collection.htm "A collection of Einstein Discovery AI model coefficients.") # Model Field Label Metrics Model field information that includes label, value and metrics data. Properties | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | field​Label | String | The label of the model field. | Small, 56.0 | 56.0 | | field​Name | String | The name of the model field. | Small, 56.0 | 56.0 | | value | Double | The metrics value of the model field. | Small, 56.0 | 56.0 | # Model File Resource Returns a binary stream of the Einstein Discovery model file contents. Resource URL /smartdatadiscovery/models//file Formats JSON Available Version 49.0 GET HTTP Methods GET Request parameters for GET | Parameter Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | model​Id | String | The ID of the model to retrieve the file for. | Required | 49.0 | Response body for GET StreamedRepresentation. Returns a binary stream of the JSON contents of the specified file. # Model Metrics Feature Importances Resources Returns the importance metrics for an Einstein Discovery Model Resource URL /smartdatadiscovery/models/${modelId}/metrics/feature-importances Formats JSON Available Version 56.0 HTTP Methods GET Request parameters for GET | Parameter Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | model​Id | String | The ID of the model to retrieve the importance metrics. | Required | 56.0 | Response body for GET [Smart Data Discovery Feature Importance Metric](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_responses_smart_data_discovery_feature_importance_metric.htm "An importance metric for a Einstein Discovery model.") # Model Metrics Residuals Resource Returns the metrics residuals for an Einstein Discovery model. Resource URL /smartdatadiscovery/models//metrics/residuals Formats JSON Available Version 55.0 HTTP Methods GET Request parameters for GET | Parameter Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | model​Id | String | The ID of the model to retrieve the metrics residuals for. | Required | 55.0 | | page | String | A generated token that indicates the view of metrics residuals to be returned. | Optional | 55.0 | | page​Size | Integer | The number of items to be returned in a single page. Minimum is 1, maximum is 200, and default is 25. | Optional | 55.0 | Response body for GET [Smart Data Discovery AI Model Residual Collection](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_responses_smart_data_discovery_ai_model_residual_collection.htm "A collection of Einstein Discovery AI model residuals.") # Model Metrics Resource Returns the metrics for an Einstein Discovery model. Resource URL /smartdatadiscovery/models//metrics Formats JSON Available Version 54.0 HTTP Methods GET Request parameters for GET | Parameter Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | model​Id | String | The ID of the model to retrieve the metrics for. | Required | 54.0 | Response body for GET [Abstract Smart Data Discovery AI Model Metrics](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_responses_abstract_smart_data_discovery_ai_model_metrics.htm "The base Einstein Discovery AI model metric.") - Specific implementations include: [Smart Data Discovery AI Model Classification Metrics](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_responses_smart_data_discovery_ai_model_classification_metrics.htm "The binomial classification metrics for an Einstein Discovery AI model."), [Smart Data Discovery AI Model Multiclass Metrics](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_responses_smart_data_discovery_ai_model_multiclass_metrics.htm "The multiclass metrics for an Einstein Discovery AI model."), and [Smart Data Discovery AI Model Regression Metrics](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_responses_smart_data_discovery_ai_model_regression_metrics.htm "The regression metrics for an Einstein Discovery AI model.") # Model Resource Returns an Einstein Discovery model, updates a model, or deletes a model. Resource URL /smartdatadiscovery/models/ Formats JSON Available Version 48.0 GET DELETE, 50.0 PATCH HTTP Methods GET PATCH DELETE Request parameters for GET and DELETE | Parameter Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | model​Id | String | The ID of the model to retrieve, update, or delete. | Required | 48.0 | Response body for GET and PATCH [Smart Data Discovery AI Model](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_responses_smart_data_discovery_ai_model.htm "An Einstein Discovery AI model to retrieve.") Request parameters for PATCH | Parameter Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | model | [Smart​Data​Discovery​AI​Model​Input](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_requests_smart_data_discovery_ai_model_input.htm "The Einstein Discovery AI model to create or update.") | The model information to update. | Required | 50.0 | | model​Id | String | The ID of the model to retrieve, update, or delete. | Required | 50.0 | # Model Resources Einstein Discovery models are sophisticated, custom mathematical constructs that are used to predict particular outcomes. Available resources: | Resource | Description | Supported HTTP Method | Resource URL | | --- | --- | --- | --- | | [Models Resource](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_resources_models.htm "Returns a collection of Einstein Discovery models and creates a model.") | Returns a collection of Einstein Discovery models and creates a model. | GET POST | /smartdatadiscovery/models | | [Model Resource](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_resources_models_id.htm "Returns an Einstein Discovery model, updates a model, or deletes a model.") | Returns a model, updates a model, or deletes a model. | GET PATCH DELETE | /smartdatadiscovery/models/ | | [Model Coefficients Resource](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_resources_models_id_coefficients.htm "Returns a collection of coefficients for an Einstein Discovery model.") | Returns the coefficients for a model. | GET | /smartdatadiscovery/models/​/coefficients | | [Model File Resource](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_resources_models_id_file.htm "Returns a binary stream of the Einstein Discovery model file contents.") | Returns a binary stream of the model file contents. | GET | /smartdatadiscovery/models/​/file | | [Model Metrics Resource](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_resources_models_id_metrics.htm "Returns the metrics for an Einstein Discovery model.") | Returns the metrics for a specified model. | GET | /smartdatadiscovery/models/​/metrics | | [Model Metrics Residuals Resource](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_resources_models_id_metrics_residuals.htm "Returns the metrics residuals for an Einstein Discovery model.") | Returns the metrics residuals for a specified model. | GET | /smartdatadiscovery/models/​/metrics​/residuals | | [Model Metrics Feature Importances Resource](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_resources_models_id_metrics_feature_importances.htm "Returns the importance metrics for an Einstein Discovery Model") | Returns the importance metrics for a specified model. | GET | /smartdatadiscovery/models/​/metrics​/feature-importances | - **[Models Resource](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_resources_models.htm)** Returns a collection of Einstein Discovery models and creates a model. - **[Model Resource](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_resources_models_id.htm)** Returns an Einstein Discovery model, updates a model, or deletes a model. - **[Model Coefficients Resource](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_resources_models_id_coefficients.htm)** Returns a collection of coefficients for an Einstein Discovery model. - **[Model File Resource](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_resources_models_id_file.htm)** Returns a binary stream of the Einstein Discovery model file contents. - **[Model Metrics Resource](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_resources_models_id_metrics.htm)** Returns the metrics for an Einstein Discovery model. - **[Model Metrics Residuals Resource](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_resources_models_id_metrics_residuals.htm)** Returns the metrics residuals for an Einstein Discovery model. - **[Model Metrics Feature Importances Resources](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_resources_models_id_metrics_feature_importances.htm)** Returns the importance metrics for an Einstein Discovery Model # Models Resource Returns a collection of Einstein Discovery models and creates a model. Resource URL /smartdatadiscovery/models Formats JSON Available Version 48.0 HTTP Methods GET POST Request parameters for GET
Parameter Name Type Description Required or Optional Available Version
order Smart​Data​Discovery​Sort​Order​Enum The sort order for the collection. Valid values are:
  • Ascending
  • Descending
 Optional 48.0
page String A generated token that indicates the view of models to be returned. Optional 48.0
page​Size Integer The number of items to be returned in a single page. Minimum is 1, maximum is 200, and default is 25. Optional 48.0
q String Search terms. Individual terms are separated by spaces. A wildcard is automatically appended to the last token in the query string. If the user’s search query contains quotation marks or wildcards, those symbols are automatically removed from the query string in the URI along with any other special characters. Optional 48.0
sort 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
 Optional 48.0
source​Type Smart​Data​Discovery​Model​Source​Type​Enum Filters the collection by source type. Valid values are:
  • Discovery
  • User​Upload
 Optional 48.0
status Smart​Data​Discovery​AI​Model​Status​Enum Filters the collection by status. Valid values are:
  • Disabled
  • Enabled
  • Upload​Completed
  • Upload​Failed
  • Uploading
  • Validating
  • Validation​Completed
  • Validation​Failed
 Optional 48.0
story​History​Id String Filters the collection by story history ID (9B4). Optional 48.0
story​Id String Filters the collection by story ID (1Y3). Optional 48.0
Response body for GET [Smart Data Discovery AI Model Collection](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_responses_smart_data_discovery_ai_model_collection.htm "A collection of Einstein Discovery AI models.") Request body for POST [Smart Data Discovery AI Model Input](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_requests_smart_data_discovery_ai_model_input.htm "The Einstein Discovery AI model to create or update.") Response body for POST [Smart Data Discovery AI Model](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_responses_smart_data_discovery_ai_model.htm "An Einstein Discovery AI model to retrieve.") # Narrative Resource Returns the narrative data for an Einstein Discovery story. Resource URL /smartdatadiscovery/narrative Formats JSON Available Version 51.0 HTTP Methods POST Request body for POST | Parameter Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | narrative | [Smart​Data​Discovery​Narrative​Input](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_requests_smart_data_discovery_narrative_input.htm "The Einstein Discovery story narrative to retrieve.") | The narrative to return data for. | Optional | 51.0 | Response body for POST [Smart Data Discovery Narrative Field Collection](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_responses_smart_data_discovery_narrative_field_collection.htm "A collection of narrative data for an Einstein Discovery story.") # Numeric Field Configuration The numeric field configuration. Properties Inherits properties from [Abstract​Numeric​Field​Configuration](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_responses_abstract_numeric_field_configuration.htm "The base Einstein Discovery numeric field configuration."). # Percentile Bucketing Strategy The percentile bucketing strategy. Properties Inherits properties from [Abstract​Bucketing​Strategy](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_responses_abstract_bucketing_strategy.htm "The base bucketing strategy."). | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | number​Of​Buckets | Integer | The number of buckets for a numeric field. | Small, 54.0 | 54.0 | # Predict History The historical predictions for a target. Properties | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | predictions | [Predict​History​Value](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_responses_predict_history_value.htm "A historical prediction value at a specific point in time.")\[\] | A list of the predictions that were made. | Small, 56.0 | 56.0 | | target | String | The ID of prediction target. | Small, 56.0 | 56.0 | # Predict History Collection A collection of historical predictions for a goal. Properties | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | goal | [Asset​Reference](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_responses_asset_reference.htm "An Einstein Discovery asset reference. This wraps the BaseAssetReference") | The prediction goal. | Small, 56.0 | 56.0 | | history | [Predict​History](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_responses_predict_history.htm "The historical predictions for a target.") | The prediction history. | Small, 56.0 | 56.0 | | range | [Predict​History​Range](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_responses_predict_history_range.htm "A range used for the historical prediction query.") | The range used to query the prediction history. | Small, 56.0 | 56.0 | # Predict History Input The query input for prediction history. Properties | Property Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | goal​Id | ID | The ID of the goal. | Required | 56.0 | | range | [Predict​History​Range​Input](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_requests_predict_history_range_input.htm "The range for prediction history query.") | The range for the prediction history query. | Required | 56.0 | | targets | String\[\] | The list of targets to query. | Optional | 56.0 | # Predict History Range A range used for the historical prediction query. Properties
Property Name Type Description Filter Group and Version Available Version
interval Predict​History​Interval​Enum The interval for look back. Valid values are:
  • None
  • Weekly
 Small, 56.0 56.0
max​Look​Back Integer The maximum look back period. Small, 56.0 56.0
# Predict History Range Input The range for prediction history query. Properties
Property Name Type Description Required or Optional Available Version
interval Predict​History​Interval​Enum The interval for look back. Valid values are:
  • None
  • Weekly
 Optional 56.0
max​Look​Back Integer The maximum look back period. Optional 56.0
# Predict History Resource Query the history of Einstein Discovery predictions. Resource URL /smartdatadiscovery/predict-history Formats JSON Available Version 56.0 HTTP Methods POST Request body for POST | Parameter Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | predict​History | [Predict​History​Input](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_requests_predict_history_input.htm "The query input for prediction history.") | The input for the predict history query. | Required | 56.0 | Response body for POST [Predict History Collection](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_responses_predict_history_collection.htm "A collection of historical predictions for a goal.") Example For use cases for querying prediction history, see [Query Prediction History](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_edd_prediction_service_predict_history.htm "The Einstein Prediction Service provides a REST API endpoint to query prediction histories."). # Predict History Value A historical prediction value at a specific point in time. Properties | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | created​Date | Date | The date the prediction was made. | Small, 56.0 | 56.0 | | model | [Asset​Reference](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_responses_asset_reference.htm "An Einstein Discovery asset reference. This wraps the BaseAssetReference") | The model used to make the prediction. | Small, 56.0 | 56.0 | | value | String | The prediction value. | Small, 56.0 | 56.0 | # Predict Job Resource Returns an Einstein Discovery predict job. Resource URL /smartdatadiscovery/predict-jobs/ Formats JSON Available Version 48.0 HTTP Methods GET PATCH DELETE Request parameters for GET and DELETE | Parameter Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | predict​Job​Id | String | The ID of the predict job to retrieve or delete. | Required | 48.0 | Response body for GET and PATCH [Smart Data Discovery Predict Job](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_responses_smart_data_discovery_predict_job.htm "An Einstein Discovery predict job.") Request parameters for PATCH | Parameter Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | predict​Job | [Smart​Data​Discovery​Predict​Job​Update​Input](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_requests_smart_data_discovery_predict_job_update_input.htm "The input to update a predict job for Einstein Discovery.") | The predict job to update. | Required | 49.0 | | predict​Job​Id | String | The ID of the predict job to update. | Required | 49.0 | # Predict Jobs Resource Returns a collection of Einstein Discovery predict jobs and creates a predict job. Resource URL /smartdatadiscovery/predict-jobs Formats JSON Available Version 48.0 HTTP Methods GET POST Response body for GET [Smart Data Discovery Predict Job Collection](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_responses_smart_data_discovery_predict_job_collection.htm "A collection of Einstein Discovery predict jobs.") Request body for POST | Parameter Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | predict​Job | [Smart​Data​Discovery​Predict​Job​Input](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_requests_smart_data_discovery_predict_job_input.htm "The predict job input for Einstein Discovery.") | The predict job information. | Required | 48.0 | Response body for POST [Smart Data Discovery Predict Job](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_responses_smart_data_discovery_predict_job.htm "An Einstein Discovery predict job.") Example For use cases for running a bulk scoring job, see [Manage Prediction Jobs](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_edd_prediction_service_job.htm "The Einstein Prediction Service provides REST API endpoints to run bulk scoring jobs for a prediction. Bulk scoring jobs enable you to score predictions on multiple records at a time. For example, after deploying an updated model, use bulk scoring to refresh all prediction scores. You can also run bulk scoring on historical data to see how well your model performs. With bulk scoring, you can score all records, a segment of the records, or records that haven’t reached the terminal state."). # Predict Jobs Resources Predict jobs run bulk scoring jobs for predictions. Bulk scoring jobs enable scoring predictions on multiple records at a time. For example, after deploying an updated model, use bulk scoring to refresh all prediction scores. Available resources: | Resource | Description | Supported HTTP Method | Resource URL | | --- | --- | --- | --- | | [Predict Jobs Resource](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_resources_predict_jobs.htm "Returns a collection of Einstein Discovery predict jobs and creates a predict job.") | Returns a collection of Einstein Discovery predict jobs and creates a predict job. | GET POST | /smartdatadiscovery/predict-jobs | | [Predict Job Resource](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_resources_predict_jobs_id.htm "Returns an Einstein Discovery predict job.") | Returns an Einstein Discovery predict job. | GET PATCH DELETE | /smartdatadiscovery/predict-jobs​/ | - **[Predict Jobs Resource](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_resources_predict_jobs.htm)** Returns a collection of Einstein Discovery predict jobs and creates a predict job. - **[Predict Job Resource](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_resources_predict_jobs_id.htm)** Returns an Einstein Discovery predict job. # Predict Resource Make an Einstein Discovery prediction. Resource URL /smartdatadiscovery/predict Formats JSON Available Version 41.0 HTTP Methods POST Request body for POST
Parameter Name Type Description Required or Optional Available Version
discovery​Client String The discovery client. Required 41.0
predict Abstract​Smart​Data​Discovery​Predict​Input The predict information. Valid values are: Required 41.0
Response body for POST [Smart Data Discovery Predict List](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_responses_smart_data_discovery_predict_list.htm "A list of Einstein Discovery predictions.") Example For use cases for requesting a prediction, see [Get Predictions](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_edd_prediction_service_predict.htm "The Einstein Prediction Service provides a REST API endpoint to request a prediction."). # Prediction Definition Model Card Resource Deletes a prediction definition model card. Resource URL /smartdatadiscovery/predictiondefinitions//modelcards/ Formats JSON Available Version 51.0 HTTP Methods DELETE Request parameters for DELETE | Parameter Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | model​Card​Id | String | The ID of the model card to delete. | Required | 41.0 | | prediction​Definition​Id​Or​Name | String | The ID or developer name of the prediction definition to delete the model card from. | Required | 41.0 | # Prediction Definition Model Cards Resource Returns a model card for an Einstein Discovery prediction definition. Resource URL /smartdatadiscovery/predictiondefinitions//modelcards Formats JSON Available Version 51.0 HTTP Methods GET Request parameters for GET | Parameter Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | prediction​Definition​Id​Or​Name | String | The ID or developer name of the prediction definition to retrieve the model card for. | Required | 41.0 | Response body for GET [Smart Data Discovery Model Card](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_responses_smart_data_discovery_model_card.htm "An Einstein Discovery model card.") # Prediction Definition Resource Returns or deletes an Einstein Discovery prediction definition. Resource URL /smartdatadiscovery/predictiondefinitions/ Formats JSON Available Version 41.0 HTTP Methods GET DELETE Request parameters for GET and DELETE | Parameter Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | prediction​Definition​Id​Or​Name | String | The ID or developer name of the prediction definition to retrieve or delete. | Required | 41.0 | Response body for GET [Smart Data Discovery Prediction Definition](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_responses_smart_data_discovery_prediction_definition.htm "An Einstein Discovery prediction definition.") # Prediction Definition Resources A prediction definition specifies what the model is trying to predict and the Salesforce entity associated with the prediction. Each prediction definition has a unique id. Only certain attributes of a prediction definition can be modified. Available resources: | Resource | Description | Supported HTTP Method | Resource URL | | --- | --- | --- | --- | | [Prediction Definitions Resource](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_resources_prediction_definitions.htm "Returns a collection of Einstein Discovery prediction definitions.") | Returns a collection of Einstein Discovery prediction definitions. | GET | /smartdatadiscovery​/predictiondefinitions | | [Prediction Definition Resource](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_resources_prediction_definitions_id.htm "Returns or deletes an Einstein Discovery prediction definition.") | Returns or deletes a prediction definition. | GET DELETE | /smartdatadiscovery​/predictiondefinitions​/ | | [Prediction Definition Model Cards Resource](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_resources_prediction_definitions_id_model_cards.htm "Returns a model card for an Einstein Discovery prediction definition.") | Returns a model card for an Einstein Discovery prediction definition. | GET | /smartdatadiscovery​/predictiondefinitions​/​/modelcards | | [Prediction Definition Model Card Resource](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_resources_prediction_definitions_id_model_cards_id.htm "Deletes a prediction definition model card.") | Deletes a prediction definition model card. | DELETE | /smartdatadiscovery​/predictiondefinitions​/​/modelcards/ | | [Prediction Definition Models Resource](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_resources_prediction_definitions_id_models.htm "Returns a collection of Einstein Discovery prediction definition models.") | Returns a collection of Einstein Discovery prediction definition models. | GET POST | /smartdatadiscovery​/predictiondefinitions​/​/models | | [Prediction Definition Model Resource](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_resources_prediction_definitions_id_models_id.htm "Returns or deletes a model for an Einstein Discovery prediction definition.") | Returns or deletes a model for an Einstein Discovery prediction definition. | GET PATCH DELETE | /smartdatadiscovery​/predictiondefinitions​/​/models/ | | [Prediction Definition Model Metrics Resource](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_resources_prediction_definitions_id_models_id_metrics.htm "Returns a collection of metrics for a prediction definition model.") | Returns a collection of metrics for a prediction definition model. | GET | /smartdatadiscovery​/predictiondefinitions​/​/models//metrics | Examples For use cases to manage prediction definitions, see [Manage Prediction Definitions](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_edd_prediction_service_prediction_definition.htm "The Einstein Prediction Service provides REST API endpoints to manage prediction definitions. A prediction definition specifies what the model is trying to predict and the Salesforce entity associated with the prediction. Each prediction definition has a unique id. Only certain attributes of a prediction definition can be modified."). For use cases to manage models, see [Manage Models](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_edd_prediction_service_model.htm "The Einstein Prediction Service provides REST API endpoints to manage models. Each model has a unique id. A model is used to evaluate predictors and return predictions and improvements. These REST endpoints allow you to make updates to model metadata, but not update the actual predictive model."). - **[Prediction Definitions Resource](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_resources_prediction_definitions.htm)** Returns a collection of Einstein Discovery prediction definitions. - **[Prediction Definition Resource](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_resources_prediction_definitions_id.htm)** Returns or deletes an Einstein Discovery prediction definition. - **[Prediction Definition Model Cards Resource](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_resources_prediction_definitions_id_model_cards.htm)** Returns a model card for an Einstein Discovery prediction definition. - **[Prediction Definition Model Card Resource](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_resources_prediction_definitions_id_model_cards_id.htm)** Deletes a prediction definition model card. - **[Prediction Definitions Models Resource](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_resources_prediction_definitions_id_models.htm)** Returns a collection of Einstein Discovery prediction definition models. - **[Prediction Definitions Model Resource](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_resources_prediction_definitions_id_models_id.htm)** Returns or deletes a model for an Einstein Discovery prediction definition. - **[Prediction Definitions Model Metrics Resource](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_resources_prediction_definitions_id_models_id_metrics.htm)** Returns a collection of metrics for a prediction definition model. # Prediction Definitions Model Metrics Resource Returns a collection of metrics for a prediction definition model. Resource URL /smartdatadiscovery/predictiondefinitions//models//metrics Formats JSON Available Version 50.0 HTTP Methods GET Request parameters for GET
Parameter Name Type Description Required or Optional Available Version
count Int The count of metrics to return. Optional 50.0
model​Id String The ID of the model to retrieve or delete. Required 41.0
prediction​Definition​Id​Or​Name String The ID or developer name of the prediction definition to retrieve or delete the model for. Required 41.0
span Metric​Span​Enum The time span for the metrics. Valid values are:
  • Day
  • Month
  • Since​Last​Action
  • Week
 Optional 50.0
Response body for GET [Smart Data Discovery Metrics Collection](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_responses_smart_data_discovery_metrics_collection.htm "A collection of Einstein Discovery metrics.") # Prediction Definitions Model Resource Returns or deletes a model for an Einstein Discovery prediction definition. Resource URL /smartdatadiscovery/predictiondefinitions//models/ Formats JSON Available Version 41.0 HTTP Methods GET PATCH DELETE Request parameters for GET and DELETE | Parameter Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | model​Id | String | The ID of the model to retrieve or delete. | Required | 41.0 | | prediction​Definition​Id​Or​Name | String | The ID or developer name of the prediction definition to retrieve or delete the model for. | Required | 41.0 | Response body for GET and PATCH [Smart Data Discovery Model](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_responses_smart_data_discovery_model.htm "An Einstein Discovery model.") Request parameters for POST | Parameter Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | model | [Smart Data Discovery Model Input](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_requests_smart_data_discovery_model_input.htm "The Einstein Discovery model to create or update.") | The model to create. | Required | 41.0 | | model​Id | String | The ID of the model to retrieve or delete. | Required | 41.0 | | prediction​Definition​Id​Or​Name | String | The ID or developer name of the prediction definition to retrieve or delete the model for. | Required | 41.0 | # Prediction Definitions Models Resource Returns a collection of Einstein Discovery prediction definition models. Resource URL /smartdatadiscovery/predictiondefinitions//models Formats JSON Available Version 41.0 HTTP Methods GET POST Request parameters for GET
Parameter Name Type Description Required or Optional Available Version
prediction​Definition​Id​Or​Name String The ID or developer name of the prediction definition to retrieve the models for. Required 41.0
status Smart​Data​Discovery​Status​Enum Filters the collection by status. Valid values are:
  • Disabled
  • Enabled
 Optional 41.0
Response body for GET [Smart Data Discovery Model Collection](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_responses_smart_data_discovery_model_collection.htm "A collection of Einstein Discovery prediction definitions.") Request parameters for POST | Parameter Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | model | [Smart Data Discovery Model Input](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_requests_smart_data_discovery_model_input.htm "The Einstein Discovery model to create or update.") | The model to create. | Required | 41.0 | | prediction​Definition​Id​Or​Name | String | The ID or developer name of the prediction definition to create a model for. | Required | 41.0 | Response body for POST [Smart Data Discovery Model](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_responses_smart_data_discovery_model.htm "An Einstein Discovery model.") # Prediction Definitions Resource Returns a collection of Einstein Discovery prediction definitions. Resource URL /smartdatadiscovery/predictiondefinitions Formats JSON Available Version 41.0 HTTP Methods GET Request parameters for GET
Parameter Name Type Description Required or Optional Available Version
model​Source Smart​Data​Discovery​Model​Source​Type​Enum The model source type to filter the collection by. Valid values are:
  • Discovery
  • User​Upload
 Optional 41.0
order Smart​Data​Discovery​Sort​Order​Enum The sort order for the collection. Valid values are:
  • Ascending
  • Descending
 Optional 41.0
outcome​Field String The outcome field to filter the collection by. Optional 41.0
outcome​Goal Connect​Smart​Data​Discovery​Outcome​Goal​Enum The outcome goal to filter the collection by. Valid values are:
  • Maximize
  • Minimize
  • None
 Optional 41.0
page String A generated token that indicates the view of models to be returned. Optional 41.0
page​Size Integer The number of items to be returned in a single page. Minimum is 1, maximum is 200, and default is 25. Optional 41.0
prediction​Type Connect​Smart​Data​Discovery​Prediction​Type​Enum The prediction type to filter the collection by. Valid values are:
  • Classification
  • Multiclass​Classification
  • Regression
  • Unknown
 Optional 41.0
q String Search terms. Individual terms are separated by spaces. A wildcard is automatically appended to the last token in the query string. If the user’s search query contains quotation marks or wildcards, those symbols are automatically removed from the query string in the URI along with any other special characters. Optional 41.0
sort Prediction​Definition​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
 Optional 41.0
source​Type Smart​Data​Discovery​Model​Source​Type​Enum Filters the collection by source type. Valid values are:
  • Discovery
  • User​Upload
 Optional 41.0
status Smart​Data​Discovery​Status​Enum Filters the collection by status. Valid values are:
  • Disabled
  • Enabled
 Optional 41.0
story​Id Id Filters the collection by story ID (1Y3). Optional 41.0
subscribed​Entity String Filters the collection by subscribed entity. Optional 41.0
Response body for GET [Smart Data Discovery Prediction Definition Collection](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_responses_smart_data_discovery_prediction_definition_collection.htm "A collection of Einstein Discovery prediction definitions.") # Query Prediction History The Einstein Prediction Service provides a REST API endpoint to query prediction histories. ## Predict History Request POST ​/smartdatadiscovery​/predict-history ## POST Request Body Use the [Predict History Input](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_requests_predict_history_input.htm "The query input for prediction history.") to create your request body. In the request body, you specify the ID of the goal, the prediction history range, and a list of targets.
Format Description
goalId The ID of the prediction definition to query for historical predictions.
targets A list of opportunity IDs as strings to use for the target entities of the query. The list is limited to 1 entry.
range An optional range for the query. Use the Predict History Range Input to specify the range. The range includes:
  • maxLookBack an optional value to specify the number of prediction history values. 1-3 are the valid values, with a default value of 1.
  • interval an optional value to specify the prediction history interval. Valid values are Weekly or None, with a default value of Weekly.
## Query prediction history with a maxLookBack of 2 Query the prediction history using the following API request: POST ​/smartdatadiscovery​/predict-history Request body: { "targets" : \[ "1Otxx00000000304AA" \], "goalId" : "1ORxx00000000509BA", "range" : { "maxLookBack" : 2 } } ## POST Response Body The POST response is a [Predict History Collection](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_responses_predict_history_collection.htm "A collection of historical predictions for a goal."). ## Response body: { "history" : \[ { "target" : "006xx000001a2p3AAA", "predictions" : \[ { "createdDate" : "2022-09-16T19:47:14.000Z", "value" : "21.69962721629", "model" { "id" : "1Otxx00000000304AA" } }, { "createdDate" : "2022-09-16T19:47:15.000Z", "value" : "21.83126271983", "model" { "id" : "1Otxx00000000304AA" } } \] } \], "range" : { "maxLookBack" : 2, "interval" : "Weekly" } } # Refresh Job Refresh Tasks Resource Returns a collection of refresh tasks for an Einstein Discovery refresh job. Resource URL /smartdatadiscovery/refresh-jobs//refresh-tasks Formats JSON Available Version 50.0 HTTP Methods GET Request parameters for GET | Parameter Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | refresh​Job​Id | String | The ID of the refresh job to retrieve the refresh tasks for. | Required | 50.0 | Response body for GET [Smart Data Discovery Refresh Task Collection](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_responses_smart_data_discovery_refresh_task_collection.htm "A collection of Einstein Discovery refresh task.") # Refresh Job Resource Returns an Einstein Discovery refresh job. Resource URL /smartdatadiscovery/refresh-jobs/ Formats JSON Available Version 50.0 HTTP Methods GET Request parameters for GET | Parameter Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | refresh​Job​Id | String | The ID of the refresh job to retrieve. | Required | 50.0 | Response body for GET [Smart Data Discovery Refresh Job](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_responses_smart_data_discovery_refresh_job.htm "An Einstein Discovery refresh job.") # Refresh Jobs Resource Returns a collection of Einstein Discovery refresh jobs. Resource URL /smartdatadiscovery/refresh-jobs Formats JSON Available Version 50.0 HTTP Methods GET POST Response body for GET [Smart Data Discovery Refresh Job Collection](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_responses_smart_data_discovery_refresh_job_collection.htm "A collection of Einstein Discovery refresh jobs.") # Refresh Jobs Resources Refresh jobs run refresh Einstein Discovery models. Available resources: | Resource | Description | Supported HTTP Method | Resource URL | | --- | --- | --- | --- | | [Refresh Jobs Resource](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_resources_refresh_jobs.htm "Returns a collection of Einstein Discovery refresh jobs.") | Returns a collection of Einstein Discovery refresh jobs. | GET | /smartdatadiscovery/refresh-jobs | | [Refresh Job Resource](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_resources_refresh_jobs_id.htm "Returns an Einstein Discovery refresh job.") | Returns an Einstein Discovery refresh job. | GET | /smartdatadiscovery/refresh-jobs​/ | | [Refresh Job Refresh Tasks Resource](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_resources_refresh_jobs_id_refresh_tasks.htm "Returns a collection of refresh tasks for an Einstein Discovery refresh job.") | Returns a collection of refresh tasks for an Einstein Discovery refresh job. | GET | /smartdatadiscovery/refresh-jobs​/​/refresh-tasks | Examples For use cases to manage refresh jobs, see [Manage Model Refresh Jobs](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_edd_prediction_service_refresh_job.htm "The Einstein Prediction Service provides REST API endpoints to retrieve metadata for model refresh jobs."). - **[Refresh Jobs Resource](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_resources_refresh_jobs.htm)** Returns a collection of Einstein Discovery refresh jobs. - **[Refresh Job Resource](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_resources_refresh_jobs_id.htm)** Returns an Einstein Discovery refresh job. - **[Refresh Job Refresh Tasks Resource](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_resources_refresh_jobs_id_refresh_tasks.htm)** Returns a collection of refresh tasks for an Einstein Discovery refresh job. # Report Source An analytics report as the analysis source. Properties Inherits properties from [Abstract​Story​Source](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_responses_abstract_story_source.htm "The base Einstein Discovery analysis source."). | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | report | [Asset Reference](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_responses_asset_reference.htm "An Einstein Discovery asset reference. This wraps the BaseAssetReference") | The report for an analysis source. | Small, 45.0 | 45.0 | | report​Instance | [Asset Reference](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_responses_asset_reference.htm "An Einstein Discovery asset reference. This wraps the BaseAssetReference") | The report instance for an analysis source. | Small, 45.0 | 45.0 | # Smart Data Discovery Aggregate Predict Condition The aggregate predict condition for a collection of Einstein Discover predictions. Properties | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | count | Integer | The count of rows included in the aggregate condition | Small, 55.0 | 55.0 | # Smart Data Discovery Aggregate Prediction An Einstein Discovery aggregate prediction result. Properties Inherits properties from [Abstract​Smart​Data​Discovery​Aggregate​Prediction](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_responses_abstract_smart_data_discovery_aggregate_prediction.htm "The base Einstein Discovery aggregate prediction result."). | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | value | Double | The value of the aggregate result. | Small, 55.0 | 55.0 | # Smart Data Discovery Aggregate Prediction Error An Einstein Discovery aggregate prediction error. Properties Inherits properties from [Abstract​Smart​Data​Discovery​Aggregate​Prediction](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_responses_abstract_smart_data_discovery_aggregate_prediction.htm "The base Einstein Discovery aggregate prediction result."). | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | error​Code | Integer | The error code. | Small, 55.0 | 55.0 | | message | String | The error message. | Small, 55.0 | 55.0 | # Smart Data Discovery AI Model An Einstein Discovery AI model to retrieve. Properties
Property Name Type Description Filter Group and Version Available Version
coefficients​Url String The coefficients URL for the AI model. Small, 55.0 55.0
created​By Smart​Data​Discovery​User The user that created the AI model Small, 48.0 48.0
created​Date Date The date on which the AI model was created. Small, 48.0 48.0
description String The description for the AI model. Small, 48.0 48.0
id String The ID for the AI model. Small, 48.0 48.0
input Abstract​Smart​Data​Discovery​AI​Model​Source The input source for the AI model. Valid data properties are: Small, 48.0 48.0
label String The label for the AI model. Small, 48.0 48.0
last​Modified​By Smart​Data​Discovery​User The user who last modified the AI model Small, 48.0 48.0
last​Modified​Date Date The date on which the AI model was last modified. Small, 48.0 48.0
metrics​Url String The metrics URL for the AI model. Small, 54.0 54.0
model​Fields Abstract​Smart​Data​Discovery​Model​Field[] The list of model fields for the AI model. Valid values are: Small, 48.0 48.0
model​File​Url String The file URL for the AI model. Small, 49.0 49.0
model​Runtime Abstract​Smart​Data​Discovery​Model​Runtime The run time model for the AI model. Small, 48.0 48.0
name String The developer name for the AI model. Small, 48.0 48.0
namespace String The namespace for the AI model. Small, 51.0 51.0
predicted​Field String The predicted field name for the AI model. Small, 48.0 48.0
prediction​Property Abstract​Smart​Data​Discovery​Prediction​Property The prediction property for the AI model. Valid prediction properties are: Small, 48.0 48.0
status 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
 Small, 48.0 48.0
transformations Smart​Data​Discovery​AI​Model​Transformation[] The list of transformations associated with the AI model. Small, 48.0 48.0
url String The URL for the AI model. Small, 48.0 48.0
validation​Result Map<Object, Object> The validation result for the AI model, when available. Small, 50.0 50.0
# Smart Data Discovery AI Model Classification Metrics The binomial classification metrics for an Einstein Discovery AI model. Properties Inherits properties from [Abstract​Smart​Data​Discovery​AI​Model​Metrics](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_responses_abstract_smart_data_discovery_ai_model_metrics.htm "The base Einstein Discovery AI model metric."). | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | auc | Double | The AUC for the model. | Small, 54.0 | 54.0 | | false​Negative​Rate | Double | The false negative rate for the model. | Small, 54.0 | 54.0 | | false​Positive​Rate | Double | The false positive rate for the model. | Small, 54.0 | 54.0 | | gini | Double | The GINI for the model. | Small, 54.0 | 54.0 | | mcc | Double | The MCC for the model. | Small, 54.0 | 54.0 | | true​Negative​Rate | Double | The true negative rate for the model. | Small, 54.0 | 54.0 | | true​Positive​Rate | Double | The true positive rate for the model. | Small, 54.0 | 54.0 | # Smart Data Discovery AI Model Coefficient Collection A collection of Einstein Discovery AI model coefficients. Properties | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | coefficients | [Smart​Data​Discovery​Predict​Condition](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_responses_smart_data_discovery_predict_condition.htm "An Einstein Discovery predict condition.")\[\] | The list of coefficients for the model. | Small, 55.0 | 55.0 | | next​Page​Url | String | The URL to get the next page of results. | Small, 55.0 | 55.0 | | total​Size | Integer | The total count of items in the collection. | Small, 55.0 | 55.0 | | url | String | The URL to get the collection. | Small, 55.0 | 55.0 | # Smart Data Discovery AI Model Collection A collection of Einstein Discovery AI models. Properties | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | models | [Smart​Data​Discovery​AI​Model](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_responses_smart_data_discovery_ai_model.htm "An Einstein Discovery AI model to retrieve.")\[\] | The list of AI models available to the current user. | Small, 48.0 | 48.0 | | next​Page​Url | String | The URL to get the next page of results. | Small, 51.0 | 51.0 | | total​Size | Integer | The total count of items in the collection. | Small, 48.0 | 48.0 | | url | String | The URL to get the collection. | Small, 48.0 | 48.0 | # Smart Data Discovery AI Model Discovery Source The discovery source for an AI model. Properties Inherits properties from [Abstract​Smart​Data​Discovery​AI​Model​Source](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_responses_abstract_smart_data_discovery_ai_model_source.htm "The base Einstein Discovery AI model prediction property."). | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | story | [Asset Reference](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_responses_asset_reference.htm "An Einstein Discovery asset reference. This wraps the BaseAssetReference") | The source story asset. | Small, 48.0 | 48.0 | | story​History | [Asset Reference](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_responses_asset_reference.htm "An Einstein Discovery asset reference. This wraps the BaseAssetReference") | The source story history asset. | Small, 48.0 | 48.0 | # Smart Data Discovery AI Model Discovery Source Input The discovery source input for a Smart Data Discovery AI Model. Properties Inherits properties from [Abstract​Smart​Data​Discovery​AI​Model​Discovery​Source​Input](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_requests_abstract_smart_data_discovery_ai_model_source_input.htm "The base source input for an Einstein Discovery AI model."). | Property Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | run​Id | [Asset Reference Input](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_requests_asset_reference_input.htm "An Einstein Discovery asset reference. This wraps the BaseAssetReferenceInput") | The run ID that created this AI model. | Required | 48.0 | # Smart Data Discovery AI Model Input The Einstein Discovery AI model to create or update. Properties
Property Name Type Description Required or Optional Available Version
description String The description for the AI model. Optional 48.0
input Abstract​Smart​Data​Discovery​AI​Model​Source​Input The input source for the AI model. Valid data properties are: Required 48.0
label String The label for the AI model. Optional 48.0
model​Fields Abstract​Smart​Data​Discovery​Model​Field​Input[] The list of model fields for the AI model. Valid values are: Required 48.0
input Abstract​Smart​Data​Discovery​Model​Runtime​Input The runtime for the AI model. Valid runtimes are: Required 48.0
name String The developer name for the AI model. Required 48.0
predicted​Field String The field name that the AI model is trying to predict. Optional 48.0
prediction​Property Abstract​Smart​Data​Discovery​Prediction​Property​Input The prediction property of the AI model. Valid prediction properties are: Optional 48.0
status Connect​ED​Insight​Type​Enum The status of the AI model. Valid values are:
  • Disabled
  • Enabled
  • Upload​Completed
  • Upload​Failed
  • Uploading
  • Validating
  • Validation​Completed
  • Validation​Failed
 Optional 49.0
transformations Smart Data Discovery AI Model Transformation Input[] A list of transformations associated with this AI model. Small, 48.0 48.0
validation​Result Object The validation result of the AI model. Optional 50.0
# Smart Data Discovery AI Model Multiclass Metrics The multiclass metrics for an Einstein Discovery AI model. Properties Inherits properties from [Abstract​Smart​Data​Discovery​AI​Model​Metrics](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_responses_abstract_smart_data_discovery_ai_model_metrics.htm "The base Einstein Discovery AI model metric."). # Smart Data Discovery AI Model Regression Metrics The regression metrics for an Einstein Discovery AI model. Properties Inherits properties from [Abstract​Smart​Data​Discovery​AI​Model​Metrics](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_responses_abstract_smart_data_discovery_ai_model_metrics.htm "The base Einstein Discovery AI model metric."). | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | mae | Double | The MAE for the model. | Small, 54.0 | 54.0 | | residuals​Url | String | The residuals URL for the model. | Small, 55.0 | 55.0 | | rmse | Double | The RMSE for the model. | Small, 54.0 | 54.0 | | rsquared | Double | The R Squared for the model. | Small, 54.0 | 54.0 | # Smart Data Discovery AI Model Residual AnEinstein Discovery AI model residual. Properties | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | actual | Double | The actual value. | Small, 55.0 | 55.0 | | predicted | Double | The predicted value. | Small, 55.0 | 55.0 | # Smart Data Discovery AI Model Residual Collection A collection of Einstein Discovery AI model residuals. Properties | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | next​Page​Url | String | The URL to get the next page of results. | Small, 55.0 | 55.0 | | residuals | [Smart​Data​Discovery​AI​Model​Residual](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_responses_smart_data_discovery_ai_model_residual.htm "AnEinstein Discovery AI model residual.")\[\] | The list of residuals for the model. | Small, 55.0 | 55.0 | | total​Size | Integer | The total count of items in the collection. | Small, 55.0 | 55.0 | | url | String | The URL to get the collection. | Small, 55.0 | 55.0 | # Smart Data Discovery AI Model Transformation An Einstein Discovery AI model transformation. Properties
Property Name Type Description Filter Group and Version Available Version
id String The ID for the AI model. Small, 55.0 55.0
source​Fields Abstract​Smart​Data​Discovery​Model​Field[] A list of the model field names used as input parameters by the transformation. Valid values are: Small, 54.0 54.0
state Map<Object, Object> A map of the model transformation state. Small, 51.0 51.0
target​Fields Abstract​Smart​Data​Discovery​Model​Field[] A list of the model field names modified by the transformation. Valid values are: Small, 54.0 54.0
type Smart​Data​Discovery​AI​Model​Transformation​Type​Enum The model 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)
Small, 51.0 51.0
# Smart Data Discovery AI Model Transformation Input The input for an Einstein Discovery AI model transformation. Properties
Property Name Type Description Required or Optional Available Version
source​Fields​Names String[] A list of the model field names to use as input parameters by the transformation. Required 54.0
state Object The model transformation state. Required 51.0
target​Fields​Names String[] A list of the model field names to modify with the transformation. Required 54.0
type Smart​Data​Discovery​AI​Model​Transformation​Type​Enum The model 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)
Required 51.0
# Smart Data Discovery AI Model User Upload Source The user upload source for an AI model. Properties Inherits properties from [Abstract​Smart​Data​Discovery​AI​Model​Source](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_responses_abstract_smart_data_discovery_ai_model_source.htm "The base Einstein Discovery AI model prediction property."). # Smart Data Discovery AI Model User Upload Source Input The user upload source input for a Smart Data Discovery AI Model. Properties Inherits properties from [Abstract​Smart​Data​Discovery​AI​Model​Discovery​Source​Input](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_requests_abstract_smart_data_discovery_ai_model_source_input.htm "The base source input for an Einstein Discovery AI model."). # Smart Data Discovery Categorical Imputation Transformation Input The input to identify the transformation as categorical imputation. Properties Inherits properties from [Abstract​Smart​Data​Discovery​Many​To​One​Transformation​Input](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_requests_abstract_many_to_one_transformation_input.htm "The base input to identify the transformation as many to one.").
Property Name Type Description Required or Optional Available Version
impute​Method Smart​Data​Discovery​Categorical​Imputation​Method​Enum The algorithm type for the classification. Valid values are:
  • Auto
 Required 55.0
# Smart Data Discovery Categorical Projected Prediction An Einstein Discovery categorical projected prediction. Properties Inherits properties from [Abstract​Smart​Data​Discovery​Projected​Prediction](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_responses_abstract_smart_data_discovery_projected_prediction.htm "The base Einstein Discovery projected prediction result."). | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | class​Probabilities | Double | The predict probabilities for each class. | Small, 55.0 | 55.0 | | prediction | String | The prediction outcome. | Small, 54.0 | 54.0 | # Smart Data Discovery Classification Prediction Property The classification prediction model type. Properties Inherits properties from [Abstract​Smart​Data​Discovery​Prediction​Property](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_responses_abstract_smart_data_discovery_prediction_property.htm "The base Einstein Discovery AI model prediction property.").
Property Name Type Description Filter Group and Version Available Version
algorithm​Type 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)
Small, 49.0 49.0
classification​Threshold Binary​Classification​Threshold The classification threshold (e.g. binary classification threshold for logistic regression models). Small, 48.0 48.0
# Smart Data Discovery Classification Prediction Property Input The input to identify the prediction type as Classification. Properties Inherits properties from [Abstract​Smart​Data​Discovery​Prediction​Property​Input](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_requests_abstract_smart_data_discovery_prediction_property_input.htm "The base Einstein Discovery prediction property input.").
Property Name Type Description Required or Optional Available Version
algorithm​Type Smart​Data​Discovery​Classification​Algorithm​Type​Enum The algorithm type for the classification. Valid values are:
  • Best (Model tournament)
  • Drf (Distributed Random Forest)
  • Gbm (GBM)
  • Glm (GLM)
  • Xgboost (XGBoost)
Required 49.0
classification​Threshold Abstract​Classification​Threshold​Input The classification threshold for the model. Valid values are: Required 48.0
# Smart Data Discovery Cluster Input The input for cluster definitions. Properties | Property Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | ignored | Boolean | Indicates whether the cluster is ignored (true) or not (false). | Required | 55.0 | | label | String | The label for the cluster. | Optional | 55.0 | | name | String | The name for the cluster. | Required | 55.0 | | values | String\[\] | A list of values in the cluster. | Required | 55.0 | # Smart Data Discovery Complex Filter Input The complex filter input for Einstein Discovery. Properties | Property Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | filters | [Smart​Data​Discovery​Filter​Input](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_requests_smart_data_discovery_filter_input.htm "The filter input for Einstein Discovery.")\[\] | The list of filters that make up the complex filter. | Required | 46.0 | # Smart Data Discovery Contact An Einstein Discovery contact. Properties | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | email | String | The email for the contact. | Small, 51.0 | 51.0 | | name | String | The name of the contact. | Small, 51.0 | 51.0 | # Smart Data Discovery Custom Prescribable Field Definition A custom Einstein Discovery prescribable field definition to override default prescription text. Properties | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | filters | [Smart​Data​Discovery​Filter](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_responses_smart_data_discovery_filter.htm "An Einstein Discovery filter used to select a model.")\[\] | A list of filter rules for enabling custom text. | Small, 50.0 | 50.0 | | template​Text | String | The template text to use in replacements. | Small, 50.0 | 50.0 | # Smart Data Discovery Custom Prescribable Field Definition Input The input for a custom Einstein Discovery prescribable field definition to override default prescription text. Properties | Property Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | filters | [Smart​Data​Discovery​Filter​Input](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_requests_smart_data_discovery_filter_input.htm "The filter input for Einstein Discovery.")\[\] | A list of filter rules for enabling custom text. | Required | 50.0 | | template​Text | String | The template text to use in replacements. | Required | 50.0 | # Smart Data Discovery Customizable Field An Einstein Discovery customizable field. Properties | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | custom​Definitions | [Smart​Data​Discovery​Custom​Prescribable​Field​Definition](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_responses_smart_data_discovery_custom_prescribable_field_definition.htm "A custom Einstein Discovery prescribable field definition to override default prescription text.")\[\] | A list of custom field definitions. | Small, 57.0 | 57.0 | | field​Name | String | The name of the customizable field. | Small, 57.0 | 57.0 | # Smart Data Discovery Customizable Field Input Input for an Einstein Discovery customizable field. Properties | Property Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | custom​Definitions | [Smart​Data​Discovery​Custom​Prescribable​Field​Definition​Input](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_requests_custom_prescribable_field_definition_input.htm "The input for a custom Einstein Discovery prescribable field definition to override default prescription text.")\[\] | A list of custom field definitions. | Required | 57.0 | | field​Name | String | The name of the customizable field. | Required | 57.0 | # Smart Data Discovery Discovery Model Runtime Input The input to identify the model runtime type as Discovery. Properties Inherits properties from [Abstract​Smart​Data​Discovery​Model​Runtime​Input](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_requests_abstract_smart_data_discovery_model_runtime_input.htm "The base Einstein Discovery model runtime input."). # Smart Data Discovery Extract Day of Week Transformation Input The input for an extract day of week transformation. Properties Inherits properties from [Abstract​Smart​Data​Discovery​OneToOne​Transformation​Input](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_requests_abstract_one_to_one_transformation_input.htm "The base input to identify the transformation as one to one."). # Smart Data Discovery Extract Month of Year Transformation Input The input for an extract month of year transformation. Properties Inherits properties from [Abstract​Smart​Data​Discovery​OneToOne​Transformation​Input](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_requests_abstract_one_to_one_transformation_input.htm "The base input to identify the transformation as one to one."). # Smart Data Discovery Feature Importance Metric An importance metric for a Einstein Discovery model. Properties | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | feature​Importance | [Model​Field​Label​Metrics](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_responses_model_field_label_metrics.htm "Model field information that includes label, value and metrics data.")\[\] | The list of importance metrics. | Small, 56.0 | 56.0 | | url | String | The URL to the importance metrics. | Small, 56.0 | 56.0 | # Smart Data Discovery Field An Einstein Discovery field. Properties Inherited by [Smart Data Discovery Pushback Field](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_responses_smart_data_discovery_pushback_field.htm "A pushback field for an Einstein Discovery prediction."). | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | label | String | The label of the field. | Small, 46.0 | 46.0 | | name | String | The name of the field. | Small, 46.0 | 46.0 | # Smart Data Discovery Field Mapping An Einstein Discovery field mapping. Properties
Property Name Type Description Filter Group and Version Available Version
input Abstract​Smart​Data​Discovery​Field​Mapping​Source The field mapping source. Valid values are: Small, 48.0 48.0
mapped​Field Smart​Data​Discovery​Field​Mapping​Mapped​Field The mapped field. Small, 48.0 48.0
model​Field Abstract​Smart​Data​Discovery​Model​Field[] The model field. Valid values are: Small, 48.0 48.0
# Smart Data Discovery Field Mapping Analytics Dataset Field An Einstein Discovery field mapped from an analytics dataset source. Properties Inherits properties from [Abstract​Smart​Data​Discovery​Field​Mapping​Source](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_responses_abstract_smart_data_discovery_field_mapping_source.htm "The base Einstein Discovery field mapping source."). | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | sobject​Field​Join​Key | String | The sObject field name used as the join key. | Small, 48.0 | 48.0 | | source | [Asset​Reference](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_responses_asset_reference.htm "An Einstein Discovery asset reference. This wraps the BaseAssetReference") | A source ID of the analytics dataset asset. | Small, 48.0 | 48.0 | | source​Field​Join​Key | String | The source dataset field name used as the join key. | Small, 48.0 | 48.0 | # Smart Data Discovery Field Mapping Analytics Dataset Field Input Input for an Einstein Discovery field mapped from an analytics dataset source. Properties Inherits properties from [Abstract​Smart​Data​Discovery​Field​Mapping​Source​Input](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_requests_abstract_smart_data_discovery_field_mapping_source_input.htm "The base Einstein Discovery field mapping source input."). | Property Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | sobject​Field​Join​Key | String | The sObject field name used as the join key. | Required | 48.0 | | source | [Asset​Reference​Input](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_requests_asset_reference_input.htm "An Einstein Discovery asset reference. This wraps the BaseAssetReferenceInput") | A source ID of the analytics dataset asset. | Required | 48.0 | | source​Field​Join​Key | String | The source dataset field name used as the join key. | Required | 48.0 | # Smart Data Discovery Field Mapping Input An Einstein Discovery field mapping. Properties
Property Name Type Description Required or Optional Available Version
input Abstract​Smart​Data​Discovery​Field​Mapping​Source​Input The field mapping source. Valid values are: Required 48.0
mapped​Field​Name String The mapped field name. Required 48.0
model​Field​Name String The model field. Required 48.0
# Smart Data Discovery Field Mapping Mapped Field A mapped field in a field mapping. Properties | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | label | String | The label of the mapped field. | Small, 48.0 | 48.0 | | name | String | The name of the mapped field. | Small, 48.0 | 48.0 | | type | String | The type of the mapped field. | Small, 48.0 | 48.0 | # Smart Data Discovery Field Mapping Salesforce Field An Einstein Discovery field mapped from a Salesforce field source. Properties Inherits properties from [Abstract​Smart​Data​Discovery​Field​Mapping​Source](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_responses_abstract_smart_data_discovery_field_mapping_source.htm "The base Einstein Discovery field mapping source."). # Smart Data Discovery Field Mapping Salesforce Field Input Input for an Einstein Discovery field mapped from a Salesforce field source. Properties Inherits properties from [Abstract​Smart​Data​Discovery​Field​Mapping​Source​Input](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_requests_abstract_smart_data_discovery_field_mapping_source_input.htm "The base Einstein Discovery field mapping source input."). # Smart Data Discovery Filter An Einstein Discovery filter used to select a model. Properties
Property Name Type Description Filter Group and Version Available Version
field​Name String The developer name of the field to apply the filter to. Small, 41.0 41.0
filter​Values Smart​Data​Discovery​Filter​Value[] An ordered list of values to be applied in the filter. Small, 50.0 50.0
operator 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
 Small, 54.0 54.0
type Smart​Data​Discovery​Filter​Field​Type​Enum The filter field type. Valid values are:
  • Boolean
  • Date
  • Date​Time
  • Number
  • Text
 Small, 48.0 48.0
# Smart Data Discovery Filter Input The filter input for Einstein Discovery. Properties
Property Name Type Description Required or Optional Available Version
field​Name String The developer name of the field the filter applies to. Required 41.0
filter​Values Smart​Data​Discovery​Filter​Value​Input[] An ordered list of the values to compare with. Required 50.0
operator Connect​Smart​Data​Discovery​Filter​Operator​Enum The operator to use in the 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
 Required 41.0
type ​Smart​Data​Discovery​Filter​Field​Type​Enum The field type for the filter. Valid values are:
  • Boolean
  • Date
  • Date​Time
  • Number
  • Text
 Required 48.0
# Smart Data Discovery Filter List A list of record filter conditions. Properties | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | filters | [Smart​Data​Discovery​Filter](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_responses_smart_data_discovery_filter.htm "An Einstein Discovery filter used to select a model.")\[\] | The list of filter conditions. | Small, 46.0 | 46.0 | # Smart Data Discovery Filter Value The value used in an Einstein Discovery filter. Properties
Property Name Type Description Filter Group and Version Available Version
type Smart​Data​Discovery​Filter​Value​Type​Enum The type of the filter value. Valid values are:
  • Constant
  • Placeholder
 Small, 50.0 50.0
value String The value of the filter. The value can be a constant or a valid placeholder. Small, 50.0 50.0
# Smart Data Discovery Filter Value Input The filter value input for Einstein Discovery. Properties
Property Name Type Description Required or Optional Available Version
type Smart​Data​Discovery​Filter​Value​Type​Enum The type of the filter value. Valid values are:
  • Constant
  • Placeholder
 Required 50.0
value String The value for the filter. The value is a constant or a placeholder Required 50.0
# Smart Data Discovery Free Text Clustering Transformation Input The input for a free text clustering transformation. Properties Inherits properties from [Abstract​Smart​Data​Discovery​OneToOne​Transformation​Input](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_requests_abstract_one_to_one_transformation_input.htm "The base input to identify the transformation as one to one."). # Smart Data Discovery H20 Model Runtime Input The input to identify the model runtime type as H20. Properties Inherits properties from [Abstract​Smart​Data​Discovery​Model​Runtime​Input](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_requests_abstract_smart_data_discovery_model_runtime_input.htm "The base Einstein Discovery model runtime input."). # Smart Data Discovery Import Warnings The import warnings for an Einstein Discovery prediction. Properties | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | mismatched​Columns | String\[\] | A list of mismatched columns for the predict result. | Small, 42.0 | 42.0 | | missing​Columns | String\[\] | A list of missing columns for the predict result. | Small, 42.0 | 42.0 | | out​Of​Bounds​Columns | [Smart​Data​Discovery​Predict​Column](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_responses_smart_data_discovery_predict_column.htm "A column given from an Einstein Discovery prediction.")\[\] | A list of out of bounds columns for the predict result. | Small, 42.0 | 42.0 | # Smart Data Discovery Impute Strategy The impute strategy. Properties
Property Name Type Description Filter Group and Version Available Version
groupByFieldName String The field name value to group by. Small, 54.0 54.0
method Smart​Data​Discovery​Impute​Method​Enum The impute method. Valid values are:
  • Mean
  • Median
  • Mode
  • None
 Small, 54.0 54.0
# Smart Data Discovery Insight An insight for an Einstein Discovery analysis. Properties | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | id | ID | The id of the insight. | Small, 44.0 | 44.0 | | properties | Map | A map of the properties for the insight. | Small, 44.0 | 44.0 | | sort​Order | Integer | The sort order of the insight. | Small, 44.0 | 44.0 | # Smart Data Discovery Live Metric Detail A live AI Einstein Discovery metric. Properties | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | end​Date | Date | The end date of this metric. | Small, 50.0 | 50.0 | | row​Count | Integer | The row count of this metric. | Small, 50.0 | 50.0 | | start​Date | Date | The start date of this metric. | Small, 50.0 | 50.0 | | value | Map | The complex value of this metric represented as a Map. | Small, 50.0 | 50.0 | # Smart Data Discovery Live Metrics The categorized live AI Einstein Discovery metrics. Properties | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | disparate​Impacts | [Smart​Data​Discovery​Live​Metric​Detail](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_responses_smart_data_discovery_live_metric_detail.htm "A live AI Einstein Discovery metric.")\[\] | A list of disparateImpact metrics during the span. | Small, 55.0 | 55.0 | | missing​Columns | [Smart​Data​Discovery​Live​Metric​Detail](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_responses_smart_data_discovery_live_metric_detail.htm "A live AI Einstein Discovery metric.")\[\] | A list of missing column metrics during the span. | Small, 50.0 | 50.0 | | out​Of​Bounds​Columns | [Smart​Data​Discovery​Live​Metric​Detail](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_responses_smart_data_discovery_live_metric_detail.htm "A live AI Einstein Discovery metric.")\[\] | A list of out of bounds column metrics during the span. | Small, 50.0 | 50.0 | | predictions | [Smart​Data​Discovery​Live​Metric​Detail](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_responses_smart_data_discovery_live_metric_detail.htm "A live AI Einstein Discovery metric.")\[\] | A list of the total predictions during the span. | Small, 50.0 | 50.0 | | warnings | [Smart​Data​Discovery​Live​Metric​Detail](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_responses_smart_data_discovery_live_metric_detail.htm "A live AI Einstein Discovery metric.")\[\] | A list of the total warnings during the span. | Small, 50.0 | 50.0 | # Smart Data Discovery Metrics Collection A collection of Einstein Discovery metrics. Properties | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | live​Metrics | [Smart​Data​Discovery​Live​Metrics](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_responses_smart_data_discovery_live_metrics.htm "The categorized live AI Einstein Discovery metrics.") | The live metrics from running predictions. | Small, 50.0 | 50.0 | | total​Active​Models | Integer | The total number of active models. | Small, 51.0 | 51.0 | | total​Models | Integer | The total number of models. | Small, 51.0 | 51.0 | | training​Metrics | [Smart​Data​Discovery​Training​Metrics](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_responses_smart_data_discovery_live_metrics.htm "The categorized live AI Einstein Discovery metrics.") | The model level metrics from training. | Small, 50.0 | 50.0 | | url | Integer | The URL to get the metrics results. | Small, 50.0 | 50.0 | # Smart Data Discovery Model An Einstein Discovery model. Properties
Property Name Type Description Filter Group and Version Available Version
classification​Threshold Abstract​Classification​Threshold The classification threshold for the model. Valid values are: Small, 48.0 48.0
created​By Smart​Data​Discovery​User The user who created the model. Small, 41.0 41.0
created​Date Date The creation date of the model. Small, 41.0 41.0
customizable​Factors Smart​Data​Discovery​Customizable​Field[] A list of customizable top factors for the model. Small, 57.0 57.0
field​Mapping​List Smart​Data​Discovery​Field​Mapping[] A list mapping the model fields to Salesforce fields. Small, 48.0 48.0
filters Smart​Data​Discovery​Filter[] A list of filters used to determine whether this model should be applied to a record. Small, 41.0 41.0
history​Url String The URL for the model history. Small, 49.0 49.0
id String The ID of the model. Small, 41.0 41.0
is​Refresh​Enabled Boolean Indicates whether this model is included in the refresh schedule (true) or not (false). Small, 50.0 50.0
label String The label of the model. Small, 41.0 41.0
last​Modified​By Smart​Data​Discovery​User The user who last modified the model. Small, 41.0 41.0
last​Modified​Date Date The last modified date of the model. Small, 41.0 41.0
model Asset​Reference A ID for the AI model. Small, 48.0 48.0
model​Type String The type of the model. Small, 47.0 47.0
name String The developer name of the model. Small, 41.0 41.0
prediction​Definition​Url String The URL to the prediction definition for the model. Small, 41.0 41.0
prescribable​Fields Smart​Data​Discovery​Prescribable​Field[] A list of the prescribable fields for the model. Small, 48.0 48.0
sort​Order Integer A unique number indicating the order in which this model's filters are evaluated compared to all other models in the parent prediction definition. Small, 41.0 41.0
status Smart​Data​Discovery​Status​Enum The status of the model. Valid values are:
  • Disabled
  • Enabled
 Small, 46.0 46.0
story Asset​Reference A story asset reference information. Small, 52.0 52.0
transformation​Overrides Abstract​Smart​Data​Discovery​Transformation​Override[] A list of the transformation overrides for the model. Valid values are: Small, 55.0 55.0
url String The URL for the model. Small, 41.0 41.0
# Smart Data Discovery Model Card An Einstein Discovery model card. Properties | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | contact | [Smart​Data​Discovery​Contact](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_responses_smart_data_discovery_contact.htm "An Einstein Discovery contact.") | The contact person for the model card. | Small, 51.0 | 51.0 | | created​By | [Smart​Data​Discovery​User](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_responses_smart_data_discovery_user.htm "An Einstein Discovery user.") | The user who created the model card. | Small, 51.0 | 51.0 | | created​Date | Date | The creation date of the model card. | Small, 51.0 | 51.0 | | id | String | The ID of the model card. | Small, 51.0 | 51.0 | | label | String | The label of the model card. | Small, 51.0 | 51.0 | | last​Modified​By | [Smart​Data​Discovery​User](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_responses_smart_data_discovery_user.htm "An Einstein Discovery user.") | The user who last modified the model card. | Small, 51.0 | 51.0 | | last​Modified​Date | Date | The last modified date of the model card. | Small, 51.0 | 51.0 | | sections | Map | A map of the user customizable description for the model card. | Small, 51.0 | 51.0 | | url | String | The URL for the model card. | Small, 51.0 | 51.0 | # Smart Data Discovery Model Configuration The configuration for an Einstein Discovery model. Properties
Property Name Type Description Filter Group and Version Available Version
algorithm​Type Smart​Data​Discovery​Classification​Algorithm​Type​Enum The algorithm type for the model. Valid values are:
  • Best (Model tournament)
  • Drf (Distributed Random Forest)
  • Gbm (GBM)
  • Glm (GLM)
  • Xgboost (XGBoost)
Small, 54.0 54.0
# Smart Data Discovery Model Field Date An Einstein Discovery date model field. Properties Inherits properties from [Abstract​Smart​Data​Discovery​Model​Field](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_responses_abstract_smart_data_discovery_model_field.htm "The base Einstein Discovery model field."). | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | values | String\[\] | A list of model field unique values. | Small, 56.0 | 56.0 | # Smart Data Discovery Model Field Date Input The Einstein Discovery date model field create or update. Properties Inherits properties from [Abstract​Smart​Data​Discovery​Model​Field​Input](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_requests_abstract_smart_data_discovery_model_field_input.htm "The base Einstein Discovery model field create or update."). | Property Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | values | String\[\] | A list of model field unique values. | Required | 56.0 | # Smart Data Discovery Model Field Numeric An Einstein Discovery numeric model field. Properties Inherits properties from [Abstract​Smart​Data​Discovery​Model​Field](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_responses_abstract_smart_data_discovery_model_field.htm "The base Einstein Discovery model field."). | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | values | [Smart​Data​Discovery​Numeric​Range](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_responses_smart_data_discovery_numeric_range.htm "A numeric range for a field.")\[\] | A list of model field unique values. | Small, 56.0 | 56.0 | # Smart Data Discovery Model Field Numeric Input The Einstein Discovery numeric model field create or update. Properties Inherits properties from [Abstract​Smart​Data​Discovery​Model​Field​Input](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_requests_abstract_smart_data_discovery_model_field_input.htm "The base Einstein Discovery model field create or update."). | Property Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | values | [Smart​Data​Discovery​Numeric​Range​Input](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_requests_smart_data_discovery_numeric_range_input.htm "A numeric range for a field.")\[\] | A list of model field unique values. | Required | 56.0 | # Smart Data Discovery Model Field Text An Einstein Discovery text model field. Properties Inherits properties from [Abstract​Smart​Data​Discovery​Model​Field](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_responses_abstract_smart_data_discovery_model_field.htm "The base Einstein Discovery model field."). | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | values | String\[\] | A list of model field unique values. | Small, 56.0 | 56.0 | # Smart Data Discovery Model Field Text Input The Einstein Discovery text model field create or update. Properties Inherits properties from [Abstract​Smart​Data​Discovery​Model​Field​Input](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_requests_abstract_smart_data_discovery_model_field_input.htm "The base Einstein Discovery model field create or update."). | Property Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | values | String\[\] | A list of model field unique values. | Required | 56.0 | # Smart Data Discovery Model Input The Einstein Discovery model to create or update. Properties
Property Name Type Description Required or Optional Available Version
analysis Asset​Reference​Input The analysis connected with the given model. Optional 46.0
classification​Threshold Abstract​Classification​Threshold​Input The classification threshold for the model. Valid values are: Required 48.0
customizable​Factors Smart​Data​Discovery​Customizable​Field​Input[] A list of customizable top factors for the model. Optional 57.0
field​Mapping Smart​Data​Discovery​Field​Mapping​Input[] A list mapping the model fields to Salesforce fields. Required 48.0
filter​List Smart​Data​Discovery​Complex​Filter​Input[] A list of filters used to determine whether a row can be evaluated by this model. Required 41.0
is​Refresh​Enabled Boolean Indicates whether this model is included in the refresh schedule (true) or not (false). Optional 50.0
label String The label of the model. Required 41.0
model Asset​Reference​Input A ID for the associated AI model. Required 48.0
name String The developer name of the model. Small, 41.0 41.0
prescribable​Fields Smart​Data​Discovery​Prescribable​Field​Input[] A list of the prescribable fields for the model. Required 48.0
sort​Order Integer A unique number indicating the order in which this model's filters are evaluated compared to all other models in the parent prediction definition. Required 41.0
status Smart​Data​Discovery​Status​Enum The status of the model. Valid values are:
  • Disabled
  • Enabled
 Required 46.0
transformation​Overrides Abstract​Smart​Data​Discovery​Prescribable​Field[] A list of the transformation overrides for the model. Valid values are: Required 48.0
# Smart Data Discovery Multiclass Classification Prediction Property The multiclass classification prediction model type. Properties Inherits properties from [Abstract​Smart​Data​Discovery​Prediction​Property](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_responses_abstract_smart_data_discovery_prediction_property.htm "The base Einstein Discovery AI model prediction property.").
Property Name Type Description Filter Group and Version Available Version
algorithm​Type 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)
Small, 49.0 49.0
# Smart Data Discovery Multiclass Classification Prediction Property Input The input to identify the prediction type as Multiclass Classification. Properties Inherits properties from [Abstract​Smart​Data​Discovery​Prediction​Property​Input](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_requests_abstract_smart_data_discovery_prediction_property_input.htm "The base Einstein Discovery prediction property input.").
Property Name Type Description Required or Optional Available Version
algorithm​Type Smart​Data​Discovery​Classification​Algorithm​Type​Enum The algorithm type for the classification. Valid values are:
  • Best (Model tournament)
  • Drf (Distributed Random Forest)
  • Gbm (GBM)
  • Glm (GLM)
  • Xgboost (XGBoost)
Required 52.0
# Smart Data Discovery Multiclass Predict An Einstein Discovery multiclass predict result. Properties Inherits properties from [Abstract​Smart​Data​Discovery​Predict](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_responses_abstract_smart_data_discovery_predict.htm "The base Einstein Discovery predict result."). | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | class​Probabilities | Map | A map of predict probabilities for each class. | Small, 52.0 | 52.0 | | predicted​Class | String | The predict value. | Small, 52.0 | 52.0 | | type | String | The type of the predict result. | Small, 52.0 | 52.0 | # Smart Data Discovery Narrative Details The textual narrative data for an Einstein Discovery story. Properties | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | text | String | The text for the narrative data. | Small, 51.0 | 51.0 | # Smart Data Discovery Narrative Field A single row of narrative data for an Einstein Discovery story. Properties | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | field | String | The field name for the narrative data. | Small, 51.0 | 51.0 | | narrative | [Smart​Data​Discovery​Narrative​Details](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_responses_smart_data_discovery_narrative_details.htm "The textual narrative data for an Einstein Discovery story.") | The interpreted narrative for the condition. | Small, 51.0 | 51.0 | | score | Double | The score for the condition. | Small, 51.0 | 51.0 | # Smart Data Discovery Narrative Field Collection A collection of narrative data for an Einstein Discovery story. Properties | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | post​Body | [Smart​Data​Discovery​Narrative​Post​Body](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_responses_smart_data_discovery_narrative_post_body.htm "A single row of narrative data for an Einstein Discovery story.") | The live metrics from running predictions. | Small, 51.0 | 51.0 | | results | [Smart​Data​Discovery​Narrative​Field](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_responses_smart_data_discovery_narrative_field.htm "A single row of narrative data for an Einstein Discovery story.")\[\] | The list of fields for the narrative. | Small, 51.0 | 51.0 | # Smart Data Discovery Narrative Filter Input The narrative filter metadata. Properties
Property Name Type Description Required or Optional Available Version
columns String The columns to use in the filter. Required 51.0
property Abstract​Story​Data​Property​Input The filter for the query service to use. Valid data properties are: Required 51.0
values String[] The list of values to use with the fields in the filter. Required 51.0
# Smart Data Discovery Narrative Input The Einstein Discovery story narrative to retrieve. Properties | Property Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | include​Warnings | Boolean | Indicates whether the warning data should be included (true) or not (false). | Optional | 51.0 | | query | [Smart​Data​Discovery​Narrative​Query​Input](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_requests_smart_data_discovery_narrative_query_input.htm "The query metadata for the Einstein Discovery story narrative to retrieve.") | The query body containing the information for generating the narrative. | Required | 51.0 | | story | [Asset​Reference​Input](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_requests_asset_reference_input.htm "An Einstein Discovery asset reference. This wraps the BaseAssetReferenceInput") | The story to use for generating the narrative. | Required | 51.0 | | story​Id | String | The ID of the story to use for generating the narrative. | Required | 51.0 | | type | String | The type of the narrative source. | Required | 51.0 | # Smart Data Discovery Narrative Insight Input The narrative insight metadata. Properties
Property Name Type Description Required or Optional Available Version
insight​Type Connect​ED​Insight​Type​Enum The insight type to return. Valid values are:
  • Descriptive
  • Summary
 Required 51.0
narrative​Type Connect​ED​Narrative​Type​Enum The narrative type to return. Valid values are:
  • Positive
  • Negative
 Required 51.0
num​Insights Integer The number of insights to return. Required 51.0
# Smart Data Discovery Narrative Post Body A single row of narrative data for an Einstein Discovery story. Properties | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | include​Warnings | Boolean | Indicates whether warnings are detected in this narrative (true) or not (false). | Small, 51.0 | 51.0 | | query | [Smart​Data​Discovery​Narrative​Post​Body​Query](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_responses_smart_data_discovery_narrative_post_body_query.htm "A query for narrative data of an Einstein Discovery story.") | The query parameters passed for the narrative. | Small, 51.0 | 51.0 | | story | [Asset​Reference](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_responses_asset_reference.htm "An Einstein Discovery asset reference. This wraps the BaseAssetReference") | The story for the narrative. | Small, 51.0 | 51.0 | | story​Id | String | The ID of the story for this narrative. | Small, 51.0 | 51.0 | # Smart Data Discovery Narrative Post Body Filter A query filter for narrative data of an Einstein Discovery story. Properties
Property Name Type Description Filter Group and Version Available Version
columns String[] The list of columns for filtering the query. Small, 51.0 51.0
property Abstract​Story​Data​Property The filter for the query service to use. Valid data properties are: Small, 52.0 52.0
values String[] The list of values to used to filter the query. Small, 51.0 51.0
# Smart Data Discovery Narrative Post Body Insight The narrative insight metadata. Properties
Property Name Type Description Filter Group and Version Available Version
insight​Type Connect​ED​Insight​Type​Enum The requested insight type. Valid values are:
  • Descriptive
  • Summary
 Small, 51.0 51.0
narrative​Type Connect​ED​Narrative​Type​Enum The requested narrative type. Valid values are:
  • Positive
  • Negative
 Small, 51.0 51.0
num​Insights Integer The number of insights returned. Small, 51.0 51.0
# Smart Data Discovery Narrative Post Body Query A query for narrative data of an Einstein Discovery story. Properties | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | filters | [Smart​Data​Discovery​Narrative​Post​Body​Filter](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_responses_smart_data_discovery_narrative_post_body_filter.htm "A query filter for narrative data of an Einstein Discovery story.")\[\] | The list of filters for the query. | Small, 51.0 | 51.0 | | insight | [Smart​Data​Discovery​Narrative​Post​Body​Insight](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_responses_smart_data_discovery_narrative_post_body_insight.htm "The narrative insight metadata.") | The insight for the query. | Small, 51.0 | 51.0 | # Smart Data Discovery Narrative Query Input The query metadata for the Einstein Discovery story narrative to retrieve. Properties | Property Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | filters | [Smart​Data​Discovery​Narrative​Filter​Input](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_requests_smart_data_discovery_narrative_filter_input.htm "The narrative filter metadata.")\[\] | The list of filters for the query. | Required | 51.0 | | insight | [Smart​Data​Discovery​Narrative​Query​Input](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_requests_smart_data_discovery_narrative_insight_input.htm "The narrative insight metadata.") | The insights for the query. | Required | 51.0 | # Smart Data Discovery Numeric Range A numeric range for a field. Properties | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | max | Double | The maximum value for the range. | Small, 57.0 | 57.0 | | min | Double | The minimum value for the range. | Small, 57.0 | 57.0 | # Smart Data Discovery Numeric Range Input A numeric range for a field. Properties | Property Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | max | Double | The maximum value for the range. | Required | 57.0 | | min | Double | The minimum value for the range. | Required | 57.0 | # Smart Data Discovery Numeric Transformation Filter Input The input for a numeric transformation filter. Properties Inherits properties from [Abstract​Smart​Data​Discovery​Transformation​Filter​Input](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_requests_abstract_smart_data_discovery_transformation_filter_input.htm "The base Einstein Discovery transformation filter input."). | Property Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | max | Double | The upper bound to be included. | Required | 55.0 | | min | Double | The lower bound to be included. | Required | 55.0 | # Smart Data Discovery Numerical Imputation Transformation Input The input for a numerical imputation transformation. Properties Inherits properties from [Abstract​Smart​Data​Discovery​OneToOne​Transformation​Input](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_requests_abstract_one_to_one_transformation_input.htm "The base input to identify the transformation as one to one.").
Property Name Type Description Required or Optional Available Version
impute​Method Smart​Data​Discovery​Numerical​Imputation​Method​Enum The numerical imputation method. Valid values are:
  • Mean
  • Median
  • Mode
 Required 51.0
# Smart Data Discovery Numerical Projected Prediction An Einstein Discovery numerical projected prediction. Properties Inherits properties from [Abstract​Smart​Data​Discovery​Projected​Prediction](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_responses_abstract_smart_data_discovery_projected_prediction.htm "The base Einstein Discovery projected prediction result."). | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | prediction | String | The prediction outcome. | Small, 54.0 | 54.0 | # Smart Data Discovery Outcome The analysis outcome for an Einstein Discovery story. Properties
Property Name Type Description Filter Group and Version Available Version
prediction​Type Analysis​Prediction​Type​Enum The analysis prediction type. Valid values are:
  • Binary
  • Count
  • Multi​Class
  • None
  • Numeric
 Small, 54.0 54.0
type Analysis​Outcome​Type​Enum The analysis outcome type. Valid values are:
  • Categorical
  • Count
  • Number
  • Text
 Small, 44.0 44.0
# Smart Data Discovery Predict An Einstein Discovery predict result. Properties Inherits properties from [Abstract​Smart​Data​Discovery​Predict](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_responses_abstract_smart_data_discovery_predict.htm "The base Einstein Discovery predict result."). # Smart Data Discovery Predict Column A column given from an Einstein Discovery prediction. Properties | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | column​Label | String | The label of the column. | Small, 51.0 | 51.0 | | column​Name | String | The name of the column. | Small, 41.0 | 41.0 | | column​Value | String | The value of the column. | Small, 51.0 | 51.0 | | custom​Text | [Smart​Data​Discovery​Predict​Column​Custom​Text](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_responses_smart_data_discovery_predict_column_custom_text.htm "The custom text for a predict column given by the Einstein Discovery prediction.") | The custom text definition, if it's defined for the column name. | Small, 50.0 | 50.0 | | input​Value | String | The input value that created this prediction column. | Small, 50.0 | 50.0 | # Smart Data Discovery Predict Column Custom Text The custom text for a predict column given by the Einstein Discovery prediction. Properties | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | mapping | Map | A placeholder to the resolved value defined in the template text. The map is null if there are no placeholders. | Small, 50.0 | 50.0 | | template​Text | String | The template text if a custom override is defined for the column. When the column value should be skipped, this is an empty string. | Small, 50.0 | 50.0 | # Smart Data Discovery Predict Condition An Einstein Discovery predict condition. Properties | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | columns | [Smart​Data​Discovery​Predict​Column](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_responses_smart_data_discovery_predict_column.htm "A column given from an Einstein Discovery prediction.")\[\] | The list of column information for the prediction. | Small, 41.0 | 41.0 | | value | Double | The value of the prediction. | Small, 41.0 | 41.0 | # Smart Data Discovery Predict Error An Einstein Discovery predict error result. Properties Inherits properties from [Abstract​Smart​Data​Discovery​Predict](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_responses_abstract_smart_data_discovery_predict.htm "The base Einstein Discovery predict result."). | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | error​Code | Integer | The error code. | Small, 44.0 | 44.0 | | message | String | The error message. | Small, 44.0 | 44.0 | # Smart Data Discovery Predict Extension Input The predict record extension input for Einstein Discovery. Properties | Property Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | record | ID | The ID of the record. | Required | 44.0 | | row | String\[\] | A list of the rows for the extension. | Required | 44.0 | # Smart Data Discovery Predict Input The predict input for Einstein Discovery. Properties Inherits properties from [Abstract​Smart​Data​Discovery​Predict​Input](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_requests_abstract_smart_data_discovery_predict_input.htm "The base predict input for Einstein Discovery."). | Property Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | entity​Id | String | The entity ID to run a prediction on. | Required | 43.0 | | exploratory​Values | Map | A map of data values. | Required | 43.0 | | prediction​Definition​Id | String | The model ID to use for the prediction. | Required | 43.0 | # Smart Data Discovery Predict Job An Einstein Discovery predict job. Properties
Property Name Type Description Filter Group and Version Available Version
batch​Size Integer The number of records processed per batch. Small, 49.0 49.0
created​By Smart​Data​Discovery​User The user who created the predict job. Small, 48.0 48.0
created​Date Date The creation date of the predict job. Small, 48.0 48.0
failed​Records Integer The total number of records that failed to process. Small, 49.0 49.0
filters Smart​Data​Discovery​Filter[] A list of filters applied to determine whether a row was scored by the predict job. Small, 48.0 48.0
id String The ID of the predict job. Small, 48.0 48.0
label String The label of the predict job. Small, 48.0 48.0
last​Modified​By Smart​Data​Discovery​User The user who last modified the predict job. Small, 48.0 48.0
last​Modified​Date Date The last modified date of the predict job. Small, 48.0 48.0
message String The extended message for the status of the predict job, if available. Small, 48.0 48.0
name String The developer name of the predict job. Small, 48.0 48.0
prediction​Definition Asset​Reference The prediction definition information for the predict job. Small, 48.0 48.0
processed​Records Integer The total number of records that processed, including failures. Small, 49.0 49.0
status Smart​Data​Discovery​Predict​Job​Status​Enum The status of the predict job. Valid values are:
  • Cancelled
  • Completed
  • Failed
  • In​Progress
  • Not​Started
  • Paused
 Small, 48.0 48.0
subscribed​Entity String The entity the predict job is subscribed to. Small, 48.0 48.0
total​Records Integer The total number of records that processed. Small, 49.0 49.0
url String The URL for the predict job. Small, 48.0 48.0
use​Terminal​State​Filter Boolean Indicates whether the job scored any record NOT matching the terminal state filter on the goal (true) or not (false). Small, 49.0 49.0
# Smart Data Discovery Predict Job Collection A collection of Einstein Discovery predict jobs. Properties | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | predict​Jobs | [Smart​Data​Discovery​Predict​Job](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_responses_smart_data_discovery_predict_job.htm "An Einstein Discovery predict job.")\[\] | A list of predict jobs available to the current user. | Small, 48.0 | 48.0 | | total​Size | Integer | The total size of the items in the collection. | Small, 48.0 | 48.0 | | url | Integer | The URL to get the predict job results. | Small, 48.0 | 48.0 | # Smart Data Discovery Predict Job Input The predict job input for Einstein Discovery. Properties | Property Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | filter | [Smart​Data​Discovery​Complex​Filter​Input](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_requests_smart_data_discovery_complex_filter_input.htm "The complex filter input for Einstein Discovery.") | The filters to score a portion of the records. If no filters are specified, then all records are scored. If specified, use one type of filter, either useTerminalStateFilter or filters, but not both. | Optional | 48.0 | | label | String | The label for the scoring job. | Required | 48.0 | | prediction​Definition | [Asset​Reference​Input](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_requests_asset_reference_input.htm "An Einstein Discovery asset reference. This wraps the BaseAssetReferenceInput") | The ID of the prediction definition for the scoring job. | Required | 48.0 | | use​Terminal​State​Filter | Boolean | Indicates whether the job should score any record NOT matching the terminal state filter on the goal (true) or not (false). | Optional | 49.0 | # Smart Data Discovery Predict Job Update Input The input to update a predict job for Einstein Discovery. Properties
Property Name Type Description Required or Optional Available Version
status Smart​Data​Discovery​Predict​Job​Status​Enum The status of the predict job. Valid values are:
  • Cancelled
  • Completed
  • Failed
  • In​Progress
  • Not​Started
  • Paused
 Required 46.0
# Smart Data Discovery Predict List A list of Einstein Discovery predictions. Properties
Property Name Type Description Filter Group and Version Available Version
aggregate​Predictions Abstract​Smart​Data​Discovery​Aggregate​Prediction[] A list of aggregate prediction results. Valid values are: Small, 55.0 55.0
prediction​Definition String The ID of the prediction definition used to make the prediction. Small, 44.0 44.0
prediction​Type Smart​Data​Discovery​Prediction​Type​Enum The prediction type. Valid values are:
  • Classification
  • Multiclass​Classification
  • Regression
  • Unknown
 Small, 55.0 55.0
predictions Abstract​Smart​Data​Discovery​Prediction[] A list of predictions. Valid values are: Small, 55.0 55.0
settings Smart​Data​Discovery​Predict​Settings The settings used for improvements. Small, 46.0 46.0
# Smart Data Discovery Predict Nested Row List Input The predict nested row list input for Einstein Discovery. Properties | Property Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | row | String\[\] | A list of the rows. | Required | 44.0 | # Smart Data Discovery Predict Raw Data Input The predict raw data input for Einstein Discovery. Properties | Property Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | column​Names | String\[\] | A comma-separated list of column names representing the columns that the model analyzes. | Required | 44.0 | | rows | [Smart​Data​Discovery​Predict​Nested​Row​List​Input](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_requests_smart_data_discovery_predict_nested_row_list_input.htm "The predict nested row list input for Einstein Discovery.")\[\] | A list of row names and values. | Required | 44.0 | # Smart Data Discovery Predict Record Input The predict record input for Einstein Discovery. Properties | Property Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | records | String\[\] | A list of comma-separated Salesforce record IDs associated with the subscribedEntity of the prediction definition. Maximum of 200 records allowed. | Required | 44.0 | # Smart Data Discovery Predict Record Overrides Input The predict record overrides input for Einstein Discovery. Properties | Property Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | column​Names | String\[\] | A comma-separated list of column names representing the columns that the model analyzes. | Required | 44.0 | | rows | [Smart​Data​Discovery​Predict​Extension​Input](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_requests_smart_data_discovery_predict_extension_input.htm "The predict record extension input for Einstein Discovery.")\[\] | A list of containing the Salesforce record IDs. | Required | 44.0 | # Smart Data Discovery Predict Settings The settings for an Einstein Discovery prediction. Properties | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | aggregate​Functions | String\[\] | The list of the aggregate functions used to make the prediction. | Small, 55.0 | 55.0 | | max​Middle​Values | Integer | The maximum middle values. Range is \[0, 3\]. | Small, 50.0 | 50.0 | | max​Prescriptions | Integer | The maximum prescription count. Range is \[-1, 200\], where -1 indicates unlimited. | Small, 41.0 | 41.0 | | prescription​Impact​Percentage | Integer | The impact percentage of prescriptions. If the value is 0, the default value, then all prescriptions are returned. If the value is 5, then only prescriptions that will improve the prediction by at least 5% are returned. | Small, 47.0 | 47.0 | | settings | [Smart​Data​Discovery​Projected​Prediction​Settings](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_responses_smart_data_discovery_projected_prediction_settings.htm "The settings for projected prediction fields.") | The setting overrides for projected predictions. | Small, 54.0 | 54.0 | # Smart Data Discovery Predict Settings Input The predict settings input for Einstein Discovery. Properties | Property Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | aggregate​Functions | String\[\] | A list of the aggregate functions to use. | Optional | 55.0 | | max​Middle​Values | Integer | The maximum middle value count. The default value is 0 and the allowed range is \[0, 3\]. | Optional | 50.0 | | max​Prescriptions | Integer | The maximum prescription count. The default value is -1 (unlimited) and the allowed range is \[-1, 200\]. | Optional | 46.0 | | prescription​Impact​Percentage | Integer | The impact percentage of the prescriptions. The default value is 0. | Optional | 47.0 | | projected​Predictions | [Smart​Data​Discovery​Projected​Prediction​Settings​Input](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_requests_smart_data_discovery_projected_prediction_settings_input.htm "The projected prediction settings input for Einstein Discovery.") | The setting overrides for projected predictions. | Optional | 54.0 | # Smart Data Discovery Prediction An Einstein Discovery prediction result. Properties Inherits properties from [Abstract​Smart​Data​Discovery​Prediction](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_responses_abstract_smart_data_discovery_prediction.htm "The base Einstein Discovery prediction result.").
Property Name Type Description Filter Group and Version Available Version
model Asset​Reference The model information of a success prediction. Small, 47.0 47.0
prediction Abstract​Smart​Data​Discovery​Predict The raw prediction, including prediction value, predictive factors, and warnings. Valid values are: Small, 41.0 41.0
prescriptions Smart​Data​Discovery​Predict​Condition[] The details of how actionable values could be used to improve the prediction. Small, 41.0 41.0
projected​Predictions Smart​Data​Discovery​Projected​Predictions The projected predictions for the prediction, if available. Small, 54.0 54.0
# Smart Data Discovery Prediction Definition An Einstein Discovery prediction definition. Properties
Property Name Type Description Filter Group and Version Available Version
count​Of​Active​Models Integer The number of active models currently present for the prediction model. Small, 48.0 48.0
count​Of​Models Integer The number of all models currently present for the prediction model. Small, 41.0 41.0
created​By Smart​Data​Discovery​User The user who created the prediction definition. Small, 41.0 41.0
created​Date Date The creation date of the prediction definition. Small, 41.0 41.0
id String The ID of the prediction definition. Small, 41.0 41.0
label String The label of the prediction definition. Small, 41.0 41.0
last​Modified​By Smart​Data​Discovery​User The user who last modified the prediction definition. Small, 41.0 41.0
last​Modified​Date Date The last modified date of the prediction definition. Small, 41.0 41.0
mapped​Outcome​Field Integer The mapped outcome field for Salesforce. Small, 47.0 47.0
models​Url String The URL for the prediction definition's models. Small, 41.0 41.0
name String The developer name of the prediction definition. Small, 41.0 41.0
namespace String The qualified namespace of the prediction definition. Small, 51.0 51.0
ninety​Day​Warning​Count Integer The total number of warnings for the prediction model over the last 90 days. Supplemental, 50.0 50.0
outcome Smart​Data​Discovery​Pred​Def​Outcome​Field The outcome information of the prediction definition. Small, 46.0 46.0
prediction​Type Smart​Data​Discovery​Prediction​Type​Enum The prediction type. Valid values are:
  • Classification
  • Multiclass​Classification
  • Regression
  • Unknown
 Small, 48.0 48.0
pushback​Field Smart​Data​Discovery​Pushback​Field The pushback of the prediction definition. Small, 46.0 46.0
pushback​Type Smart​Data​Discovery​Pushback​Type​Enum The pushback type. Valid values are:
  • Ai​Record​Insight
  • Direct
 Small, 52.0 52.0
refresh​Config Smart​Data​Discovery​Refresh​Config The refresh configuration of the prediction definition. Small, 50.0 50.0
status Smart​Data​Discovery​Status​Enum The status of the prediction definition. Valid values are:
  • Disabled
  • Enabled
 Small, 46.0 46.0
subscribed​Entity String The entity the prediction definition is subscribed to. Small, 41.0 41.0
terminal​State​Filter Smart​Data​Discovery​Filter​List The terminal state filter of the prediction definition. Small, 46.0 46.0
total​Predictions​Count Integer The total number of predictions for the prediction definition. Supplemental, 50.0 50.0
total​Warnings​Count Integer The total number of warnings for the prediction definition. Supplemental, 50.0 50.0
url String The URL for the prediction definition. Small, 41.0 41.0
# Smart Data Discovery Prediction Definition Collection A collection of Einstein Discovery prediction definitions. Properties | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | models | [Smart​Data​Discovery​Model](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_responses_smart_data_discovery_model.htm "An Einstein Discovery model.")\[\] | The list of models. | Small, 41.0 | 41.0 | | total​Size | Integer | The total count of items in the collection. | Small, 41.0 | 41.0 | | url | String | The URL to get the collection. | Small, 41.0 | 41.0 | # Smart Data Discovery Prediction Definition Collection A collection of Einstein Discovery prediction definitions. Properties | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | next​Page​Url | String | The URL to get the next page of results. | Small, 50.0 | 50.0 | | prediction​Definitions | [Smart​Data​Discovery​Prediction​Definition](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_responses_smart_data_discovery_prediction_definition.htm "An Einstein Discovery prediction definition.")\[\] | The list of prediction definitions. | Small, 41.0 | 41.0 | | total​Size | Integer | The total count of items in the collection. | Small, 41.0 | 41.0 | | url | String | The URL to get the collection. | Small, 41.0 | 41.0 | # Smart Data Discovery Prediction Definition Outcome Field An Einstein Discovery prediction definition outcome field. Properties
Property Name Type Description Filter Group and Version Available Version
goal Connect​Smart​Data​Discovery​Outcome​Goal​Enum The prediction definition outcome goal. Valid values are:
  • Maximize
  • Minimize
  • None
 Small, 46.0 46.0
# Smart Data Discovery Prediction Error An Einstein Discovery prediction error. Properties Inherits properties from [Abstract​Smart​Data​Discovery​Prediction](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_responses_abstract_smart_data_discovery_prediction.htm "The base Einstein Discovery prediction result."). | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | error​Code | Integer | The error code. | Small, 44.0 | 44.0 | | message | String | The error message. | Small, 44.0 | 44.0 | # Smart Data Discovery Prescribable Field An Einstein Discovery prescribable field. Properties
Property Name Type Description Filter Group and Version Available Version
custom​Definitions Smart​Data​Discovery​Custom​Prescribable​Field​Definition[] A list of custom prescribable field definitions to override default prescription text. Small, 50.0 50.0
field Abstract​Smart​Data​Discovery​Model​Field[] A prescribable field. Valid values are: Small, 50.0 50.0
# Smart Data Discovery Prescribable Field Input Input for an Einstein Discovery prescribable field. Properties | Property Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | custom​Definitions | [Smart​Data​Discovery​Custom​Prescribable​Field​Definition​Input](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_requests_custom_prescribable_field_definition_input.htm "The input for a custom Einstein Discovery prescribable field definition to override default prescription text.")\[\] | A list of custom prescribable field definitions to override default prescription text. | Required | 50.0 | | field​Name | String | The name of the prescribable field. | Required | 50.0 | # Smart Data Discovery Projected Prediction Field An Einstein Discovery projected prediction field. Properties
Property Name Type Description Filter Group and Version Available Version
interval​Type Smart​Data​Discovery​Projected​Predictions​Interval​Type​Enum The projected predictions internal type. Valid values are:
  • Day
  • Month
  • Quarter
  • Week
 Small, 54.0 54.0
name String The name of the field. Small, 54.0 54.0
number​Of​Intervals Integer The number of intervals used to produce the results in projected prediction for all fields. Small, 54.0 54.0
projected​Values Smart​Data​Discovery​Projected​Value[] A list of projected values for each interval. Small, 54.0 54.0
# Smart Data Discovery Projected Prediction Settings The settings for projected prediction fields. Properties | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | confidence​Interval | Integer | The confidence interval to display at each point. Allowed values are 80 and 95. | Small, 55.0 | 55.0 | | number​Of​Intervals​To​Predict​Ahead | Integer | The override value for the number of intervals to predict ahead. Range is \[1, 12\]. | Small, 41.0 | 41.0 | | show​Projected​Predictions​By​Interval | Boolean | Indicates whether to enable projected prediction calculation for every interval into the future (true) or not (false). | Small, 54.0 | 54.0 | # Smart Data Discovery Projected Prediction Settings Input The projected prediction settings input for Einstein Discovery. Properties | Property Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | confidence​Interval | Integer | The confidence interval to display at each point. Allowed values are 80 and 95. | Optional | 55.0 | | number​Of​Intervals​To​Project​Ahead | Integer | Override the number of intervals to project ahead. The allowed range is \[1, 12\]. | Optional | 54.0 | | show​Projected​Prediction​By​Interval | Boolean | Indicates whether the projected prediction calculation is enabled for every interval into the future (true) or not (false). | Optional | 54.0 | # Smart Data Discovery Projected Predictions The projected predictions for an Einstein Discovery prediction result. Properties
Property Name Type Description Filter Group and Version Available Version
fields Smart​Data​Discovery​Projected​Prediction​Field[] The field level information for each projected prediction transformation. Small, 54.0 54.0
interval​Setting Abstract​Smart​Data​Discovery​Projected​Predictions​Interval​Setting The setting used for calculating projected prediction interval. Valid values are: Small, 55.0 55.0
interval​Type Smart​Data​Discovery​Projected​Predictions​Interval​Type​Enum The projected predictions interval type. Valid values are:
  • Day
  • Month
  • Quarter
  • Week
 Small, 54.0 54.0
number​Of​Intervals​Projected​Ahead Integer The number of intervals used to produce the results in projected prediction for all fields. Small, 54.0 54.0
predictions Abstract​Smart​Data​Discovery​Projected​Prediction[] A list of projected prediction results per interval. Valid values are: Small, 54.0 54.0
# Smart Data Discovery Projected Predictions Count From Date Interval Setting The settings for an Einstein Discovery count from date based projection interval. Properties Inherits properties from [Abstract​Smart​Data​Discovery​Projected​Predictions​Interval​Setting](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_responses_abstract_projected_predictions_interval_setting.htm "The base Einstein Discovery projected predictions interval settings."). | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | date​Field | String | The date field to use for calculating projection intervals. | Small, 55.0 | 55.0 | | date​Field​Label | String | The label for the date field. | Small, 55.0 | 55.0 | | num​Intervals | Integer | The number of intervals to project ahead. | Small, 55.0 | 55.0 | # Smart Data Discovery Projected Predictions Count From Date Interval Setting Input The input for settings for an Einstein Discovery count from date based projection interval. Properties Inherits properties from [Abstract​Smart​Data​Discovery​Projected​Predictions​Interval​Setting​Input](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_requests_abstract_projected_predictions_interval_setting_input.htm "The base Einstein Discovery projected predictions interval settings input."). | Property Name | Type | Description | Required and Optional | Available Version | | --- | --- | --- | --- | --- | | date​Field | String | The date field to use for calculating projection intervals. | Required | 55.0 | | num​Intervals | Integer | The number of intervals to project ahead. | Required | 55.0 | # Smart Data Discovery Projected Predictions Count Interval Setting The settings for an Einstein Discovery count based projection interval. Properties Inherits properties from [Abstract​Smart​Data​Discovery​Projected​Predictions​Interval​Setting](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_responses_abstract_projected_predictions_interval_setting.htm "The base Einstein Discovery projected predictions interval settings."). | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | num​Intervals | Integer | The number of intervals to project ahead. | Small, 55.0 | 55.0 | # Smart Data Discovery Projected Predictions Count Interval Setting Input The input for settings for an Einstein Discovery count based projection interval. Properties Inherits properties from [Abstract​Smart​Data​Discovery​Projected​Predictions​Interval​Setting​Input](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_requests_abstract_projected_predictions_interval_setting_input.htm "The base Einstein Discovery projected predictions interval settings input."). | Property Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | num​Intervals | Integer | The number of intervals to project ahead. | Required | 55.0 | # Smart Data Discovery Projected Predictions Date Interval Setting The settings for an Einstein Discovery date interval. Properties Inherits properties from [Abstract​Smart​Data​Discovery​Projected​Predictions​Interval​Setting](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_responses_abstract_projected_predictions_interval_setting.htm "The base Einstein Discovery projected predictions interval settings."). | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | date​Field | String | The date field to use for calculating projection intervals. | Small, 55.0 | 55.0 | | date​Field​Label | String | The label for the date field. | Small, 55.0 | 55.0 | # Smart Data Discovery Projected Predictions Date Interval Setting Input The input for settings for an Einstein Discovery date interval. Properties Inherits properties from [Abstract​Smart​Data​Discovery​Projected​Predictions​Interval​Setting​Input](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_requests_abstract_projected_predictions_interval_setting_input.htm "The base Einstein Discovery projected predictions interval settings input."). | Property Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | date​Field | String | The date field to use for calculating projection intervals. | Required | 55.0 | # Smart Data Discovery Projected Predictions Historical Dataset Source Input The input for projected predictions transformation. Properties | Property Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | dataset​Id | ID | The ID of the historical dataset used to extract and build time series for each asset ID. | Required | 55.0 | | dataset​Version​Id | ID | The ID of the specific dataset version used for extraction. | Required | 55.0 | # Smart Data Discovery Projected Predictions Override The settings for an Einstein Discovery projected predictions override. Properties Inherits properties from [Abstract​Smart​Data​Discovery​Transformation​Override](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_responses_abstract_smart_data_discovery_transformation_override.htm "The base Einstein Discovery transformation deploy overrides.").
Property Name Type Description Filter Group and Version Available Version
asset​Id​Field String The Salesforce object field name to use as a look-up for a record ID in a historical dataset. Small, 55.0 55.0
interval​Override Abstract​Smart​Data​Discovery​Projected​Predictions​Interval​Setting The projected predictions interval settings. Valid values are: Small, 55.0 55.0
# Smart Data Discovery Projected Predictions Override Input The input for deploy time projected predictions transformation overrides. Properties Inherits properties from [Abstract​Smart​Data​Discovery​Transformation​Override​Input](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_requests_abstract_smart_data_discovery_transformation_override_input.htm "The base Einstein Discovery transformation deploy override input.").
Property Name Type Description Required or Optional Available Version
asset​Id​Field String The Salesforce object field name to use as a look-up for a record ID in a historical dataset. Required 55.0
interval​Override Abstract​Smart​Data​Discovery​Projected​Predictions​Interval​Setting​Input The projected predictions interval settings. Valid values are: Required 55.0
# Smart Data Discovery Projected Predictions Transformation Input The input for a projected predictions transformation. Properties Inherits properties from [Abstract​Smart​Data​Discovery​OneToOne​Transformation​Input](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_requests_abstract_one_to_one_transformation_input.htm "The base input to identify the transformation as one to one.").
Property Name Type Description Required or Optional Available Version
asset​Id​Field​Name String The group by column, used for building time series for each asset ID. Required 55.0
date​Field​Name String The field used for the time series time axis. Required 55.0
input Smart​Data​Discovery​Projected​Predictions​Historical​Dataset​Source​Input The historical dataset input. Required 55.0
num​Intervals Integer The default number of intervals to project forward. Required 55.0
projected​Predictions​Interval​Type Smart​Data​Discovery​Projected​Predictions​Interval​Type​Enum The interval type for forward projections. Valid values are:
  • Day
  • Month
  • Quarter
  • Week
 Required 55.0
projection​Field​Name String The time series y axis. This is the value column projected for each asset ID. Required 55.0
seasonality​Period Integer The seasonality period. Use 0 for no seasonality, or [2-24]. Required 55.0
# Smart Data Discovery Projected Value An Einstein Discovery projected value. Properties | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | confidence​Interval​Lower​Bound | Double | The confidence interval lower bound at the interval. | Small, 55.0 | 55.0 | | confidence​Interval​Upper​Bound | Double | The confidence interval upper bound at the interval. | Small, 55.0 | 55.0 | | value | Double | The projected value at the interval. | Small, 54.0 | 54.0 | # Smart Data Discovery Pushback Field A pushback field for an Einstein Discovery prediction. Properties Inherits properties from [Smart​Data​Discovery​Field](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_responses_smart_data_discovery_field.htm "An Einstein Discovery field."). # Smart Data Discovery Recipient An Einstein Discovery recipient. Properties
Property Name Type Description Filter Group and Version Available Version
display​Name String The display name of the recipient. Small, 50.0 50.0
id String The ID of the recipient. Small, 50.0 50.0
type Smart​Data​Discovery​Recipient​Type​Enum The type of the recipient. Valid values are:
  • Group
  • User
 Small, 50.0 50.0
# Smart Data Discovery Refresh Config The refresh configuration for an Einstein Discovery prediction. Properties | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | is​Enabled | Boolean | Indicates whether scheduled refresh is enabled (true) or not (false). | Small, 50.0 | 50.0 | | recipient​List | [Smart​Data​Discovery​Recipient](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_responses_smart_data_discovery_recipient.htm "An Einstein Discovery recipient.")\[\] | A list of recipients for email notification. | Small, 50.0 | 50.0 | | schedule | [Schedule](https://developer.salesforce.com/docs/atlas.en-us.264.0.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_schedule.htm) | The schedule for the refresh job. | Small, 50.0 | 50.0 | | should​Score​After​Refresh | Boolean | Indicates whether to automatically rescore records after a successful refresh (true) or not (false). | Small, 50.0 | 50.0 | | user​Context | [Smart​Data​Discovery​User](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_responses_smart_data_discovery_user.htm "An Einstein Discovery user.") | The user context for the refresh job. | Small, 50.0 | 50.0 | | warning​Threshold​Percentage | Double | The refresh warning threshold percentage for auto model deploy. | Small, 50.0 | 50.0 | # Smart Data Discovery Refresh Job An Einstein Discovery refresh job. Properties
Property Name Type Description Filter Group and Version Available Version
created​By Smart​Data​Discovery​User The user who created the refresh job. Small, 50.0 50.0
created​Date Date The creation date of the refresh job. Small, 50.0 50.0
end​Time Date The end time of the refresh job. Small, 50.0 50.0
id String The ID of the refresh job. Small, 50.0 50.0
message String The extended message for the status of the refresh job, if available. Small, 50.0 50.0
refresh​Target Asset​Reference The refresh target for the refresh job. Small, 50.0 50.0
refresh​Tasks​Url String The URL to the refresh tasks collection for the refresh job. Small, 50.0 50.0
start​Time Date The start time of the refresh job. Small, 50.0 50.0
status 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
 Small, 50.0 50.0
type Smart​Data​Discovery​Refresh​Job​Type​Enum The type of the refresh job. Valid values are:
  • Scheduled
  • User​Triggered
 Small, 50.0 50.0
url String The URL for the predict job. Small, 48.0 48.0
# Smart Data Discovery Refresh Job Collection A collection of Einstein Discovery refresh jobs. Properties | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | refresh​Jobs | [Smart​Data​Discovery​Refresh​Job](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_responses_smart_data_discovery_refresh_job.htm "An Einstein Discovery refresh job.")\[\] | The list of refresh jobs available to the current user. | Small, 50.0 | 50.0 | | total​Size | Integer | The total count of items in the collection. | Small, 50.0 | 50.0 | | url | String | The URL to get the collection. | Small, 50.0 | 50.0 | # Smart Data Discovery Refresh Task An Einstein Discovery refresh task. Properties
Property Name Type Description Filter Group and Version Available Version
created​By Smart​Data​Discovery​User The user who created the refresh task. Small, 50.0 50.0
created​Date Date The creation date of the refresh task. Small, 50.0 50.0
end​Time Date The end time of the refresh task. Small, 50.0 50.0
id String The ID of the refresh task. Small, 50.0 50.0
message String The extended message for the status of the refresh task, if available. Small, 50.0 50.0
refresh​Target Asset​Reference The refresh target for the refresh task. Small, 50.0 50.0
refreshed​AI​Model Asset​Reference The refreshed AI model. Small, 50.0 50.0
source Smart​Data​Discovery​Refresh​Task​Source The input source used for the refresh task. Small, 50.0 50.0
start​Time Date The start time of the refresh job. Small, 50.0 50.0
status 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
 Small, 50.0 50.0
url String The URL for the predict job. Small, 48.0 48.0
# Smart Data Discovery Refresh Task Collection A collection of Einstein Discovery refresh task. Properties | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | refresh​Tasks | [Smart​Data​Discovery​Refresh​Task](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_responses_smart_data_discovery_refresh_task.htm "An Einstein Discovery refresh task.")\[\] | The list of refresh task available to the current user. | Small, 50.0 | 50.0 | | total​Size | Integer | The total count of items in the collection. | Small, 50.0 | 50.0 | | url | String | The URL to get the collection. | Small, 50.0 | 50.0 | # Smart Data Discovery Refresh Task Source The source for an Einstein Discovery refresh task. Properties | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | dataset​Version | [Asset​Reference](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_responses_asset_reference.htm "An Einstein Discovery asset reference. This wraps the BaseAssetReference") | The specific dataset version used for this refresh. | Small, 50.0 | 50.0 | | story | [Asset​Reference](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_responses_asset_reference.htm "An Einstein Discovery asset reference. This wraps the BaseAssetReference") | The specific story used for this refresh. | Small, 50.0 | 50.0 | | story​Version | [Asset​Reference](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_responses_asset_reference.htm "An Einstein Discovery asset reference. This wraps the BaseAssetReference") | The specific story version used for this refresh. | Small, 50.0 | 50.0 | # Smart Data Discovery Regression Classification Prediction Property The regression classification prediction model type. Properties Inherits properties from [Abstract​Smart​Data​Discovery​Prediction​Property](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_responses_abstract_smart_data_discovery_prediction_property.htm "The base Einstein Discovery AI model prediction property.").
Property Name Type Description Filter Group and Version Available Version
algorithm​Type Smart​Data​Discovery​Regression​Algorithm​Type​Enum The regression algorithm type. Valid values are:
  • Drf (Distributed Random Forest)
  • Gbm (GBM)
  • Glm (GLM)
  • Xgboost (XGBoost)
Small, 49.0 49.0
classification​Threshold Binary​Classification​Threshold The classification threshold (e.g. binary classification threshold for logistic regression models). Small, 48.0 48.0
# Smart Data Discovery Regression Prediction Property Input The input to identify the prediction type as Regression. Properties Inherits properties from [Abstract​Smart​Data​Discovery​Prediction​Property​Input](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_requests_abstract_smart_data_discovery_prediction_property_input.htm "The base Einstein Discovery prediction property input.").
Property Name Type Description Required or Optional Available Version
algorithm​Type Smart​Data​Discovery​Regression​Algorithm​Type​Enum The algorithm type for the classification. Valid values are:
  • Drf (Distributed Random Forest)
  • Gbm (GBM)
  • Glm (GLM)
  • Xgboost (XGBoost)
Required 52.0
# Smart Data Discovery Resource Lists the top-level resources available for Einstein Discovery. Resource URL /smartdatadiscovery Formats JSON Available Version 46.0 HTTP Methods GET Response body for GET [Directory Item Collection](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_responses_directory_item_collection.htm "A collection of directory items.") # Smart Data Discovery Scikit Learn 102 Model Runtime Input The input to identify the model runtime type as Scikit Learn v1.0.2. Properties Inherits properties from [Abstract​Smart​Data​Discovery​Model​Runtime​Input](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_requests_abstract_smart_data_discovery_model_runtime_input.htm "The base Einstein Discovery model runtime input."). # Smart Data Discovery Sentiment Analysis Transformation Input The input for a sentiment analysis transformation. Properties Inherits properties from [Abstract​Smart​Data​Discovery​OneToOne​Transformation​Input](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_requests_abstract_one_to_one_transformation_input.htm "The base input to identify the transformation as one to one."). # Smart Data Discovery TensorFlow 27 Model Runtime Input The input to identify the model runtime type as TensorFlow v2.7.0. Properties Inherits properties from [Abstract​Smart​Data​Discovery​Model​Runtime​Input](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_requests_abstract_smart_data_discovery_model_runtime_input.htm "The base Einstein Discovery model runtime input."). # Smart Data Discovery TensorFlow Model Runtime Input The input to identify the model runtime type as TensorFlow. Properties Inherits properties from [Abstract​Smart​Data​Discovery​Model​Runtime​Input](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_requests_abstract_smart_data_discovery_model_runtime_input.htm "The base Einstein Discovery model runtime input."). # Smart Data Discovery Text Transformation Filter Input The input for a text transformation filter. Properties Inherits properties from [Abstract​Smart​Data​Discovery​Transformation​Filter​Input](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_requests_abstract_smart_data_discovery_transformation_filter_input.htm "The base Einstein Discovery transformation filter input."). | Property Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | clusters | [Smart​Data​Discovery​Cluster​Input](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_requests_smart_data_discovery_cluster_input.htm "The input for cluster definitions.")\[\] | A list of clusters to filter the value with. | Required | 55.0 | | include​Others | Boolean | Indicates weher to include values that aren't defined in clusters (true) or not (false). | Required | 55.0 | # Smart Data Discovery Training Metrics A collection of Einstein Discovery metrics from training a model. Properties | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | mae | Double | The mean absolute error (mae) training metric. | Small, 50.0 | 50.0 | | row​Count | Integer | The number of rows this model was trained on. | Small, 50.0 | 50.0 | | value | Map | The complex value of this training metric represented as a Map. | Small, 50.0 | 50.0 | # Smart Data Discovery User An Einstein Discovery user. Properties | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | id | String | The ID of the user. | Small, 41.0 | 41.0 | | name | String | The name of the user. | Small, 41.0 | 41.0 | | profile​Photo​Url | String | The Chatter profile photo of the user. | Small, 41.0 | 41.0 | # Stories Resource Returns a collection of Einstein Discovery stories. Resource URL /smartdatadiscovery/stories Formats JSON Available Version 48.0 Available Components - LWC — [lightning/analyticSmartDataDiscoveryApi getStories()](https://developer.salesforce.com/docs/platform/lwc/guide/reference-wire-adapters-get-stories.html) HTTP Methods GET Request parameters for GET
Parameter Name Type Description Required or Optional Available Version
folder​Id Id Filters the collection by a CRM Analytics folder ID. Optional 48.0
input​Id Id Filters the collection by a story input ID. Optional 48.0
page String A generated token that indicates the view of items to be returned. Optional 48.0
page​Size Integer The number of items to be returned in a single page. Minimum is 1, maximum is 200, and default is 25. Optional 48.0
q String Search terms. Individual terms are separated by spaces. A wildcard is automatically appended to the last token in the query string. If the user’s search query contains quotation marks or wildcards, those symbols are automatically removed from the query string in the URI along with any other special characters. Optional 48.0
scope Analysis​Setup​Scope​Type​Enum The type of scope. Valid values are:
  • Created​By​Me
  • Shared​With​Me
 Optional 48.0
source​Type Analysis​Setup​Source​Type​Enum The type of the source. Valid values are:
  • Analytics​Dataset
  • Live​Dataset
  • Report
 Optional 48.0
source​Types Analysis​Setup​Source​Type​Enum[] A list of source types. Valid values are:
  • Analytics​Dataset
  • Live​Dataset
  • Report
 Optional 48.0
Response body for GET [Story Collection](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_responses_story_collection.htm "A collection of Einstein Discovery stories.") # Stories Resources Einstein Discovery stories are used to analyze your data. The insights from stories show you what happened in your data, why it happened, and what could happen. Available resources: | Resource | Description | Supported HTTP Method | Resource URL | | --- | --- | --- | --- | | [Stories Resource](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_resources_stories.htm "Returns a collection of Einstein Discovery stories.") | Returns a collection of Einstein Discovery stories. | GET | /smartdatadiscovery/stories | | [Story Resource](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_resources_stories_id.htm "Returns an Einstein Discovery story.") | Returns an Einstein Discovery story. | GET | /smartdatadiscovery/stories/ | | [Story Query Resource](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_resources_stories_id_query.htm "Queries the current version of an Einstein Discovery story.") | Runs a query on the current version of an Einstein Discovery story. | POST | /smartdatadiscovery/stories/​/query | | [Story Summary Resource](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_resources_stories_id_summary.htm "Returns a summary for the current version of an Einstein Discovery story.") | Returns a summary for the current version of an Einstein Discovery story. | GET | /smartdatadiscovery/stories/​/summary | | [Story Histories Resource](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_resources_stories_id_histories.htm "Returns a collection of Einstein Discovery story history items.") | Returns a collection of Einstein Discovery story history items. | GET | /smartdatadiscovery/stories/​/histories | | [Story History Resource](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_resources_stories_id_histories_id.htm "Returns a specific Einstein Discovery story history item.") | Returns a specific Einstein Discovery story history item. | GET | /smartdatadiscovery/stories/​/histories/ | | [Story History Query Resource](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_resources_stories_id_histories_id_query.htm "Runs a query on an Einstein Discovery story history item.") | Runs a query on an Einstein Discovery story history item. | POST | /smartdatadiscovery/stories/​/histories//query | | [Story History Summary Resource](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_resources_stories_id_histories_id_summary.htm "Returns a summary for an Einstein Discovery story history item.") | Returns a summary for an Einstein Discovery story history item. | GET | /smartdatadiscovery/stories/​/histories//summary | - **[Stories Resource](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_resources_stories.htm)** Returns a collection of Einstein Discovery stories. - **[Story Resource](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_resources_stories_id.htm)** Returns an Einstein Discovery story. - **[Story Query Resource](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_resources_stories_id_query.htm)** Queries the current version of an Einstein Discovery story. - **[Story Summary Resource](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_resources_stories_id_summary.htm)** Returns a summary for the current version of an Einstein Discovery story. - **[Story Histories Resource](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_resources_stories_id_histories.htm)** Returns a collection of Einstein Discovery story history items. - **[Story History Resource](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_resources_stories_id_histories_id.htm)** Returns a specific Einstein Discovery story history item. - **[Story History Query Resource](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_resources_stories_id_histories_id_query.htm)** Runs a query on an Einstein Discovery story history item. - **[Story History Summary Resource](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_resources_stories_id_histories_id_summary.htm)** Returns a summary for an Einstein Discovery story history item. # Story An Einstein Discovery story. Properties
Property Name Type Description Filter Group and Version Available Version
autopilot Autopilot The autopilot settings for the story. Small, 55.0 55.0
classification​Threshold Abstract​Classification​Threshold The threshold for classification predictions for the story. Valid values are: Small, 48.0 48.0
created​By Smart​Data​Discovery​User The user who created the prediction definition. Small, 48.0 48.0
created​Date Date The creation date of the prediction definition. Small, 48.0 48.0
error​Code Integer The diagnostic error code for the story. Small, 48.0 48.0
fields Abstract​Field​Configuration A list of field configurations for the story. Valid values are: Small, 54.0 54.0
folder Asset​Reference The analytics folder the story belongs to. Small, 48.0 48.0
histories​Url String The URL for the story's history items. Small, 48.0 48.0
id String The ID of the story. Small, 48.0 48.0
input Abstract​Story​Source The input data for the story. Valid values are: Small, 48.0 48.0
input​Profile Asset​Reference The statistical summary of the input data. Small, 48.0 48.0
label String The label of the story. Small, 48.0 48.0
last​Modified​By Smart​Data​Discovery​User The user who last modified the story. Small, 48.0 48.0
last​Modified​Date Date The last modified date of the story. Small, 48.0 48.0
last​Successful​Version Story​Version​Reference The mapped outcome field for Salesforce. Small, 51.0 51.0
message String The informational message related to the story generation. Small, 48.0 48.0
models​Configuration Smart​Data​Discovery​Model​Configuration The model configuration for the story. Small, 54.0 54.0
name String The developer name of the story. Small, 53.0 53.0
namespace String The qualified namespace of the story. Small, 53.0 53.0
outcome Smart​Data​Discovery​Outcome The selected outcome of the generated story. Small, 48.0 48.0
run​Id ID The run ID for fetching the story insights. Small, 48.0 48.0
setup Map<Object, Object> A map of the setup information for the story, including names, action variables, model settings, variables, and outcomes. Big, 46.0 46.0
status Analysis​Setup​Status​Enum The current status of the story. 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
 Small, 46.0 46.0
transformations Abstract​Smart​Data​Discovery​Transformation​Input[] A list of field transformation. Valid values in the list are: Small, 55.0 55.0
url String The URL for the story. Small, 48.0 48.0
validation​Configuration Abstract​Smart​Data​Discovery​Validation​Configuration The validation configuration for the story. Valid values are: Small, 57.0 57.0
# Story All Other Field Value The story data property for all other values in a field. Properties Inherits properties from [Abstract​Story​Data​Property](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_responses_abstract_story_data_property.htm "The base Einstein Discovery story data property filter."). # Story Chart A story chart. Properties | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | category​Label | String | The category label for the story chart. | Small, 54.0 | 54.0 | | metric​Label | String | The metric label for the story chart. | Small, 54.0 | 54.0 | | values | [Story​Chart​Value](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_responses_story_chart_value.htm "A value in a story chart.")\[\] | A list of the story chart values. | Small, 54.0 | 54.0 | # Story Chart Value A value in a story chart. Properties
Property Name Type Description Filter Group and Version Available Version
class​Details Story​Chart​Value​Detail[] A list of the story chart value class specific details. Small, 54.0 54.0
details Story​Chart​Value​Detail[] A list of the story chart value details. Small, 54.0 54.0
dimensions Story​Field​Label​Value​Property[] A list of the story chart value dimensions. Small, 54.0 54.0
type Story​Chart​Value​Type​Enum The story chart value type. Valid values are:
  • Average
  • Baseline
  • Impact
  • Prediction
  • Small​Terms
  • Unexplained
  • Value
 Small, 54.0 54.0
value Double The value of the story chart. Small, 54.0 54.0
# Story Chart Value Detail The detail for a value in a story chart. Properties | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | all​Others​Count | Double | The count of all others. | Small, 54.0 | 54.0 | | all​Others​Count​Ratio | Double | The ratio of the all others count. | Small, 54.0 | 54.0 | | average | Double | The average of the value. | Small, 54.0 | 54.0 | | base​Coefficient | Double | The base coefficient of the value. | Small, 54.0 | 54.0 | | bucket​Range | String | The range of the bucket during story version comparison. | Small, 54.0 | 54.0 | | change​From​Average | Double | The change from average for the value. | Small, 54.0 | 54.0 | | change​From​Average​For​Other​Buckets | Double | The change from average for other buckets for the value. | Small, 54.0 | 54.0 | | change​From​Expected | Double | The change from expected for the value. | Small, 54.0 | 54.0 | | change​From​Overall | Double | The change from overall for the value. | Small, 54.0 | 54.0 | | change​From​Usual | Double | The change from usual for the value. | Small, 54.0 | 54.0 | | coefficient | Double | The coefficient for the value. | Small, 54.0 | 54.0 | | combined​Impact | Double | The impact of combined terms for the value. | Small, 54.0 | 54.0 | | conditional​Frequency | Double | The conditional frequency for the value. | Small, 54.0 | 54.0 | | frequency | Double | The frequency for the value. | Small, 54.0 | 54.0 | | global​Count | Double | The global count for the value. | Small, 54.0 | 54.0 | | global​Mean | Double | The global mean for the value. | Small, 54.0 | 54.0 | | impact | Double | The impact for the value. | Small, 54.0 | 54.0 | | is​Reference​Group | Boolean | Indicates whether the value is a reference group (true) or not (false). | Small, 54.0 | 54.0 | | is​Significantly​Different | Boolean | Indicates whether the value is significantly different (true) or not (false). | Small, 54.0 | 54.0 | | left​Frequency | Double | The left frequency for the value. | Small, 54.0 | 54.0 | | left​Impact | Double | The left impact for the value. | Small, 54.0 | 54.0 | | order | Integer | The order for the value. | Small, 54.0 | 54.0 | | precluded​Count | Integer | The precluded count for the value. | Small, 54.0 | 54.0 | | precluded​Sum | Double | The precluded sum for the value. | Small, 54.0 | 54.0 | | ratio​Difference | Double | The ratio difference for the value. | Small, 55.0 | 55.0 | | right​Frequency | Double | The right frequency for the value. | Small, 54.0 | 54.0 | | right​Impact | Double | The right impact for the value. | Small, 54.0 | 54.0 | | row​Count | Long | The row count for the value. | Small, 54.0 | 54.0 | | row​Count​Ratio | Double | The row count ratio for the value. | Small, 54.0 | 54.0 | | standard​Deviation | Double | The standard deviation for the value. | Small, 54.0 | 54.0 | | terms​Combined | Integer | The number of combined terms for the value. | Small, 54.0 | 54.0 | | total | Double | The total for the value. | Small, 54.0 | 54.0 | # Story Collection A collection of Einstein Discovery stories. Properties | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | next​Page​Url | Integer | The URL to get the next page of items for the collection. | Small, 48.0 | 48.0 | | stories | [Story](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_responses_story.htm "An Einstein Discovery story.")\[\] | A list of stories available to the current user. | Small, 48.0 | 48.0 | | total​Size | Integer | The total size of the items in the collection. | Small, 48.0 | 48.0 | | url | Integer | The URL to get the predict job results. | Small, 48.0 | 48.0 | # Story Count Insights Case A count story insights case. Properties Inherits properties from [Abstract​Story​Insights​Case](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_responses_abstract_story_insights_case.htm "The base story insights case.").
Property Name Type Description Filter Group and Version Available Version
count Double The count for the insights case Small, 54.0 54.0
count​Change​From Double The count change from for the insights case Small, 54.0 54.0
frequency Double The summary statistics frequency value for the insights case Small, 52.0 52.0
frequency​Change Story​Count​Insights​Frequency​Change​Enum The impact due to changed summary value. Valid values are:
  • Down
  • Up
 Small, 52.0 52.0
frequency​Change​From Double The change in the summary statistics value for the insights case Small, 52.0 52.0
frequency​Rate Story​Count​Insights​Frequency​Enum The occurrence frequency rate for the insights case. Valid values are:
  • Less​Often
  • More​Often
 Small, 52.0 52.0
multiplier Double The score of the field value for the insights case Small, 52.0 52.0
sum Double The sum value for the insights case Small, 54.0 54.0
sum​Change​From Double The sum change from value for the insights case Small, 54.0 54.0
# Story Day Field Value The story data day property. Properties Inherits properties from [Abstract​Story​Data​Property](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_responses_abstract_story_data_property.htm "The base Einstein Discovery story data property filter."). | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | day | Integer | The day in numeric value. | Small, 52.0 | 52.0 | | fiscal | Boolean | Indicates whether the value is in a fiscal year (true) or not (false). | Small, 52.0 | 52.0 | | month | Integer | The month in numeric value. | Small, 52.0 | 52.0 | | raw​Value | String | The raw value of the field. | Small, 52.0 | 52.0 | | year | Integer | The year in numeric value. | Small, 52.0 | 52.0 | # Story Day Field Value Input The story data day property. Properties Inherits properties from [Abstract​Story​Data​Property​Input](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_requests_abstract_story_data_property_input.htm "The base Einstein Discovery story data property filter."). | Property Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | day | Integer | The day in numeric value. | Required | 52.0 | | fiscal | Boolean | Indicates whether the value is in a fiscal year (true) or not (false). | Required | 52.0 | | month | Integer | The month in numeric value. | Required | 52.0 | | raw​Value | String | The raw value of the field. | Required | 52.0 | | year | Integer | The year in numeric value. | Required | 52.0 | # Story Day of Week Field Value The story data day of week property. Properties Inherits properties from [Abstract​Story​Data​Property](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_responses_abstract_story_data_property.htm "The base Einstein Discovery story data property filter."). | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | day​Of​Week | Integer | The day of week in numeric value. | Small, 52.0 | 52.0 | | raw​Value | String | The raw value of the field. | Small, 52.0 | 52.0 | # Story Day of Week Field Value Input The story data day of week property. Properties Inherits properties from [Abstract​Story​Data​Property​Input](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_requests_abstract_story_data_property_input.htm "The base Einstein Discovery story data property filter."). | Property Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | day​Of​Week | Integer | The day of week in numeric value. | Required | 52.0 | | raw​Value | String | The raw value of the field. | Required | 52.0 | # Story Descriptive Insights Case A descriptive story insights case. Properties Inherits properties from [Abstract​Story​Insights​Case](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_responses_abstract_story_insights_case.htm "The base story insights case.").
Property Name Type Description Filter Group and Version Available Version
change Double The changed value for the insights case Small, 52.0 52.0
frequency​Change Story​Descriptive​Insights​Impact​Enum The impact on the result. Valid values are:
  • Improved
  • Worsened
 Small, 52.0 52.0
impact​Details Story​Field​Impact​Detail[] A list of field values that impact the result. Small, 52.0 52.0
mean Double The mean value for the insights case Small, 54.0 54.0
rating Story​Descriptive​Insights​Rating​Enum The score rating of the average outcome. Valid values are:
  • Above​Average
  • Below​Average
  • Higher
  • Lower
 Small, 52.0 52.0
# Story Details The details for a story. These details are the top positive and negative factors contributing to story outcome. Properties | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | condition | [Story​Field](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_responses_story_field.htm "The field value combination that contributed to the story outcome result.")\[\] | The field value combination that contributed to the outcome result. | Small, 51.0 | 51.0 | | count | Long | The count of the condition records. | Small, 51.0 | 51.0 | | diff​From​Average | Double | The difference between the mean and the global average for analysis with outcome. | Small, 51.0 | 51.0 | | diff​From​Expected | Double | The difference between the mean and the global average for count analysis. | Small, 51.0 | 51.0 | | diff​From​Usual | Double | The difference between the mean with constraing and without constraint for count analysis. | Small, 51.0 | 51.0 | | percentage | Double | The percentage value. | Small, 51.0 | 51.0 | | rate​Of​Occurrence | Double | The occurrence count. | Small, 51.0 | 51.0 | | score | Double | The score of the condition field. | Small, 51.0 | 51.0 | # Story Diagnostic Insights Detail The detail for story diagnostic insights. Properties
Property Name Type Description Filter Group and Version Available Version
category Insights​Result​Category​Enum The insights result category. Valid values are:
  • Negative
  • Positive
 Small, 53.0 53.0
condition​Restriction Insights​Condition​Restriction​Enum The insights condition restriction. Valid values are:
  • Included
  • Not​Included
 Small, 53.0 53.0
details Diagnostic​Insights​Case[] A list of the case details for a diagnostic insight. Small, 53.0 53.0
impact Story​Descriptive​Insights​Impact​Enum The descriptive insights impact for the story. Valid values are:
  • Improved
  • Worsened
 Small, 53.0 53.0
# Story Field The field value combination that contributed to the story outcome result. Properties
Property Name Type Description Filter Group and Version Available Version
field​Name String The name for the story field. Small, 51.0 51.0
property Abstract​Story​Data​Property The field property. Valid values are: Small, 52.0 52.0
type Story​Field​Detail​Type​Enum The field type. Valid values are:
  • Field
  • Outcome
 Small, 54.0 54.0
value String The value for the field. Small, 51.0 51.0
# Story Field Correlation The summary of each field in the dataset selected for story creation. Properties | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | correlation​To​Outcome | Double | The field correlation to outcome value. | Small, 51.0 | 51.0 | | field​Label | String | The label for the dataset field. | Small, 51.0 | 51.0 | | field​Name | String | The name for the dataset field. | Small, 51.0 | 51.0 | # Story Field Impact Detail A story field impact details. Properties | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | impact​Field | [Story​Field​Label​Value​Property](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_responses_story_field_label_value_property.htm "A story field.") | A details of the field impacting the story result. | Small, 52.0 | 52.0 | # Story Field Label Value Property A story field. Properties
Property Name Type Description Filter Group and Version Available Version
label String The label for the story field. Small, 52.0 52.0
property Abstract​Story​Data​Property The data property of the story field. Valid values are: Small, 52.0 52.0
value String The value for the story field. Small, 52.0 52.0
# Story Field Only The story data field property. Properties Inherits properties from [Abstract​Story​Data​Property](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_responses_abstract_story_data_property.htm "The base Einstein Discovery story data property filter."). # Story Field Only Input The story data field property. Properties Inherits properties from [Abstract​Story​Data​Property​Input](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_requests_abstract_story_data_property_input.htm "The base Einstein Discovery story data property filter."). # Story First Order Insights The first order insights for a story. Properties Inherits properties from [Abstract​Story​Insights](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_responses_abstract_story_insights.htm "The base story insights."). | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | correlation | Double | The correlation value with respect to the outcome variable. | Small, 52.0 | 52.0 | | story​History | [Story​Query​Disparate​Impact](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_responses_story_query_disparate_impact.htm "A disparate impact for a story query.") | The disparate impact results for a story query. | Small, 54.0 | 54.0 | | potential​Bias | [Story​Potential​Bias](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_responses_story_potential_bias.htm "The potential bias for a story.")\[\] | A list of the potential bias results for a story query. | Small, 54.0 | 54.0 | | significantly​Different | Boolean | Indicates whether the insight is significantly different (true) or not (false). | Small, 54.0 | 54.0 | # Story Histories Resource Returns a collection of Einstein Discovery story history items. Resource URL /smartdatadiscovery/stories//histories Formats JSON Available Version 48.0 HTTP Methods GET Request parameters for GET | Parameter Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | story​Id | String | The ID of the story to retrieve the history items for. | Required | 51.0 | Response body for GET [Asset History Collection](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_responses_asset_history_collection.htm "A collection of asset history items.") # Story History Query Resource Runs a query on an Einstein Discovery story history item. Resource URL /smartdatadiscovery/stories//histories//query Formats JSON Available Version 52.0 HTTP Methods POST Request parameters for POST | Parameter Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | history​Id | String | The ID of the story history to query. | Required | 52.0 | | query​Payload | [Story​Query​Input](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_requests_story_query_input.htm "The input to query an Einstein Discovery story.") | The query information. | Required | 52.0 | | story​Id | String | The ID of the story to retrieve the history record for. | Required | 52.0 | Response body for POST [Story Query](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_responses_story_query.htm "A query for story insights.") # Story History Resource Returns a specific Einstein Discovery story history item. Resource URL /smartdatadiscovery/stories//histories/ Formats JSON Available Version 51.0 HTTP Methods GET Request parameters for GET | Parameter Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | history​Id | String | The ID of the story history to retrieve. | Required | 51.0 | | story​Id | String | The ID of the story to retrieve. | Required | 51.0 | Response body for GET [Story Version](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_responses_story_version.htm "An Einstein Discovery story version.") # Story History Summary Resource Returns a summary for an Einstein Discovery story history item. Resource URL /smartdatadiscovery/stories//histories//summary Formats JSON Available Version 51.0 HTTP Methods GET Request parameters for GET | Parameter Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | history​Id | String | The ID of the story history to retrieve the summary for. | Required | 51.0 | | story​Id | String | The ID of the story to retrieve the history record for. | Required | 51.0 | Response body for GET [Story Summary Detail](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_responses_story_summary_detail.htm "The summary detail for a story.") # Story Insights Detail The insights detail for a story. Properties
Property Name Type Description Filter Group and Version Available Version
cases Abstract​Story​Insights​Case[] A list of story insights cases. Valid values are: Small, 52.0 52.0
category Insights​Result​Category​Enum The insights result category. Valid values are:
  • Negative
  • Positive
 Small, 52.0 52.0
compared​With Insights​Comparison​Enum The insights score comparison criteria. Valid values are:
  • Average
  • Other
  • Uniform​Distribution
 Small, 52.0 52.0
has​More​Cases Boolean Indicates whether there are more cases (true) or not (false). Small, 55.0 55.0
outcome​Class String The outcome class for the story insight. Small, 55.0 55.0
# Story Month Field Value The story data month property. Properties Inherits properties from [Abstract​Story​Data​Property](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_responses_abstract_story_data_property.htm "The base Einstein Discovery story data property filter."). | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | fiscal | Boolean | Indicates whether the value is in a fiscal year (true) or not (false). | Small, 52.0 | 52.0 | | month | Integer | The month in numeric value. | Small, 52.0 | 52.0 | | raw​Value | String | The raw value of the field. | Small, 52.0 | 52.0 | | year | Integer | The year in numeric value. | Small, 52.0 | 52.0 | # Story Month Field Value Input The story data month property. Properties Inherits properties from [Abstract​Story​Data​Property​Input](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_requests_abstract_story_data_property_input.htm "The base Einstein Discovery story data property filter."). | Property Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | fiscal | Boolean | Indicates whether the value is in a fiscal year (true) or not (false). | Required | 52.0 | | month | Integer | The month in numeric value. | Required | 52.0 | | raw​Value | String | The raw value of the field. | Required | 52.0 | | year | Integer | The year in numeric value. | Required | 52.0 | # Story Month of Year Field Value The story data month of year property. Properties Inherits properties from [Abstract​Story​Data​Property](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_responses_abstract_story_data_property.htm "The base Einstein Discovery story data property filter."). | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | month | Integer | The month of year in numeric value. | Small, 52.0 | 52.0 | | raw​Value | String | The raw value of the field. | Small, 52.0 | 52.0 | # Story Month of Year Field Value Input The story data month of year property. Properties Inherits properties from [Abstract​Story​Data​Property​Input](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_requests_abstract_story_data_property_input.htm "The base Einstein Discovery story data property filter."). | Property Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | month | Integer | The month of year in numeric value. | Required | 52.0 | | raw​Value | String | The raw value of the field. | Required | 52.0 | # Story Narrative A narrative for a story. Properties
Property Name Type Description Filter Group and Version Available Version
body Abstract​Story​Narrative​Element The body of the narrative. Valid values are: Small, 54.0 54.0
header Abstract​Story​Narrative​Element The body of the narrative. Valid values are: Small, 54.0 54.0
title Abstract​Story​Narrative​Element The body of the narrative. Valid values are: Small, 54.0 54.0
# Story Narrative Element Text The text element for a story narrative. Properties Inherits properties from [Abstract​Story​Narrative​Element](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_responses_abstract_story_narrative_element.htm "The base story narrative element.").
Property Name Type Description Filter Group and Version Available Version
condition​Field Abstract​Story​Data​Property The narrative text with data properties. Valid values are: Small, 54.0 54.0
value String The value for the narrative text. Small, 54.0 54.0
# Story Null Field Value The story data null property. Properties Inherits properties from [Abstract​Story​Data​Property](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_responses_abstract_story_data_property.htm "The base Einstein Discovery story data property filter."). # Story Null Field Value Input The story data null property. Properties Inherits properties from [Abstract​Story​Data​Property​Input](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_requests_abstract_story_data_property_input.htm "The base Einstein Discovery story data property filter."). # Story Potential Bias The potential bias for a story. Properties | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | bias​Field | [Story​Field​Label​Value​Property](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_responses_story_field_label_value_property.htm "A story field.") | The details for the bias field. | Small, 54.0 | 54.0 | | bias​Field​Variation | Double | The variation for the bias field. | Small, 54.0 | 54.0 | | combined​Variation | Double | The combined variation for the bias field and the filter field. | Small, 54.0 | 54.0 | | filter​Field​Variation | Double | The variation for the filter field. | Small, 54.0 | 54.0 | | similarity | Double | The similarity between the bias field and the filter field. | Small, 54.0 | 54.0 | # Story Quarter Field Value The story data quarter property. Properties Inherits properties from [Abstract​Story​Data​Property](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_responses_abstract_story_data_property.htm "The base Einstein Discovery story data property filter."). | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | fiscal | Boolean | Indicates whether the value is in a fiscal year (true) or not (false). | Small, 52.0 | 52.0 | | quarter | Integer | The quarter in numeric value. | Small, 52.0 | 52.0 | | raw​Value | String | The raw value of the field. | Small, 52.0 | 52.0 | | year | Integer | The year in numeric value. | Small, 52.0 | 52.0 | # Story Quarter Field Value Input The story data quarter property. Properties Inherits properties from [Abstract​Story​Data​Property​Input](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_requests_abstract_story_data_property_input.htm "The base Einstein Discovery story data property filter."). | Property Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | fiscal | Boolean | Indicates whether the value is in a fiscal year (true) or not (false). | Required | 52.0 | | quarter | Integer | The quarter in numeric value. | Required | 52.0 | | raw​Value | String | The raw value of the field. | Required | 52.0 | | year | Integer | The year in numeric value. | Required | 52.0 | # Story Quarter of Year Field Value The story data quarter of year property. Properties Inherits properties from [Abstract​Story​Data​Property](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_responses_abstract_story_data_property.htm "The base Einstein Discovery story data property filter."). | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | fiscal | Boolean | Indicates whether the value is in a fiscal year (true) or not (false). | Small, 52.0 | 52.0 | | quarter | Integer | The quarter in numeric value. | Small, 52.0 | 52.0 | | raw​Value | String | The raw value of the field. | Small, 52.0 | 52.0 | # Story Quarter of Year Field Value Input The story data quarter of year property. Properties Inherits properties from [Abstract​Story​Data​Property​Input](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_requests_abstract_story_data_property_input.htm "The base Einstein Discovery story data property filter."). | Property Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | fiscal | Boolean | Indicates whether the value is in a fiscal year (true) or not (false). | Required | 52.0 | | quarter | Integer | The quarter in numeric value. | Required | 52.0 | | raw​Value | String | The raw value of the field. | Required | 52.0 | # Story Query A query for story insights. Properties
Property Name Type Description Filter Group and Version Available Version
descriptive​Insights Abstract​Story​Insights[] A list of descriptive story insights. Valid values are: Small, 52.0 52.0
diagnostic​Insights Story​Query​Diagnostic​Insights[] A list of diagnostic story insights. Small, 53.0 53.0
include​Chart Boolean Indicates whether to include the story chart in the query response (true) or not (false). Small, 54.0 54.0
include​Narrative Boolean Indicates whether to include the story narrative in the query response (true) or not (false). Small, 54.0 54.0
include​Regular​Fields Boolean Indicates whether to include regular fields in the query response (true) or not (false). Small, 54.0 54.0
include​Sensitive​Fields Boolean Indicates whether to include sensitive fields in the query response (true) or not (false). Small, 54.0 54.0
limit Integer The total number of insight cards in the query response. Small, 54.0 54.0
offset Integer The insight card offset value. Small, 54.0 54.0
query Story​Query​Input​Parameter The story query input parameters. Small, 52.0 52.0
total​Size Integer The total insight count for the story. Small, 52.0 52.0
url String The URL for the story query. Small, 52.0 52.0
# Story Query Diagnostic Insights A story query diagnostic insights. Properties | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | change​In​Outcome | Double | The change in outcome because of selected condition. | Small, 53.0 | 53.0 | | chart | [Story​Chart](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_responses_story_chart.htm "A story chart.") | The chart for the diagnostic insight. | Small, 54.0 | 54.0 | | condition​Field | [Story​Field​Label​Value​Property](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_responses_story_field_label_value_property.htm "A story field.") | The condition selected for the diagnostic insight. | Small, 53.0 | 53.0 | | details | [Story​Diagnostic​Insights​Detail](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_responses_story_diagnostic_insights_detail.htm "The detail for story diagnostic insights.")\[\] | A list of diagnostic insight records. | Small, 53.0 | 53.0 | | details | [Story​Query​Disparate​Impact](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_responses_story_query_disparate_impact.htm "A disparate impact for a story query.") | The disparate impact details for the diagnostic insight. | Small, 54.0 | 54.0 | | narrative | [Story​Narrative](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_responses_story_narrative.htm "A narrative for a story.") | The disparate impact details for the diagnostic insight. | Small, 54.0 | 54.0 | | outcome​Class | String | The outcome class for the diagnostic insight. | Small, 55.0 | 55.0 | | outcome​Field | [Smart​Data​Discovery​Outcome](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_responses_smart_data_discovery_outcome.htm "The analysis outcome for an Einstein Discovery story.") | The outcome field for the diagnostic insight. | Small, 53.0 | 53.0 | | potential​Bias | [Story​Potential​Bias](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_responses_story_potential_bias.htm "The potential bias for a story.") | The potential bias details for the diagnostic insight. | Small, 54.0 | 54.0 | # Story Query Disparate Impact A disparate impact for a story query. Properties | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | details | [Story​Query​Disparate​Impact​Detail](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_responses_story_query_disparate_impact_detail.htm "The detail for a story query disparate impact.")\[\] | A list of details for the disparate impact. | Small, 54.0 | 54.0 | | reference​Value | String | The reference field value used to calculate the disparate impact. | Small, 54.0 | 54.0 | # Story Query Disparate Impact Detail The detail for a story query disparate impact. Properties | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | adverse​Ratio | Double | The adverse ratio value for a disparate impact. | Small, 54.0 | 54.0 | | value | String | The field value with adverse ratio. | Small, 54.0 | 54.0 | # Story Query Input The input to query an Einstein Discovery story. Properties
Property Name Type Description Required or Optional Available Version
filters Abstract​Story​Data​Property​Input[] A list of filters to use in the query. Valid values are: Required 54.0
include​Chart Boolean Indicates whether to include the story chart in the query response (true) or not (false). Optional 54.0
include​Narrative Boolean Indicates whether to include the story narrative in the query response (true) or not (false). Optional 54.0
include​Regular​Fields Boolean Indicates whether to include regular fields in the query response (true) or not (false). Optional 54.0
include​Sensitive​Fields Boolean Indicates whether to include sensitive fields in the query response (true) or not (false). Optional 54.0
insights​Type Insights​Type​Enum The analysis type for the query insights. Valid values are:
  • Descriptive
  • Diagnostic
 Required 52.0
limit Integer The total number of insight cards in the query response. Optional 54.0
offset Integer The insight card offset value. Optional 54.0
# Story Query Input Parameter The input parameter for a story query. Properties
Property Name Type Description Filter Group and Version Available Version
filters Abstract​Story​Data​Property​Input[] A list of filter fields used to query insights. Valid values are: Small, 52.0 52.0
insights​Type Insights​Type​Enum The insights type. Valid values are:
  • Descriptive
  • Diagnostic
 Small, 52.0 52.0
# Story Query Resource Queries the current version of an Einstein Discovery story. Resource URL /smartdatadiscovery/stories//query Formats JSON Available Version 52.0 HTTP Methods POST Request parameters for POST | Parameter Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | query​Payload | [Story​Query​Input](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_requests_story_query_input.htm "The input to query an Einstein Discovery story.") | The query information. | Required | 52.0 | | story​Id | String | The ID of the story to query. | Required | 52.0 | Response body for POST [Story Query](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_responses_story_query.htm "A query for story insights.") # Story Range Field Value The story data range property. Properties Inherits properties from [Abstract​Story​Data​Property](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_responses_abstract_story_data_property.htm "The base Einstein Discovery story data property filter."). | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | end​Value | String | The end value of the range. | Small, 52.0 | 52.0 | | start​Value | String | The start value of the range. | Small, 52.0 | 52.0 | # Story Range Field Value Input The story data range property. Properties Inherits properties from [Abstract​Story​Data​Property​Input](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_requests_abstract_story_data_property_input.htm "The base Einstein Discovery story data property filter."). | Property Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | end​Value | String | The end value of the range. | Required | 52.0 | | start​Value | String | The start value of the range. | Required | 52.0 | # Story Resource Returns an Einstein Discovery story. Resource URL /smartdatadiscovery/stories/ Formats JSON Available Version 48.0 HTTP Methods GET Request parameters for GET | Parameter Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | story​Id | Id | The ID of the story to retrieve. | Required | 48.0 | Response body for GET [Story](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_responses_story.htm "An Einstein Discovery story.") # Story Second Order Insights The second order insights for a story. Properties Inherits properties from [Abstract​Story​Insights](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_responses_abstract_story_insights.htm "The base story insights."). | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | condition​Field | [Story​Field​Label​Value​Property](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_responses_story_field_label_value_property.htm "A story field.") | The condition field used for second order analysis. | Small, 52.0 | 52.0 | # Story Summary Detail The summary detail for a story. Properties | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | average​Outcome | Double | The statistical mean for outcome variable. | Small, 51.0 | 51.0 | | correlations | [Story​Field​Correlation](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_responses_story_field_correlation.htm "The summary of each field in the dataset selected for story creation.")\[\] | A summary of each field in the dataset selected for story creation. | Small, 51.0 | 51.0 | | feature​Importances | [Model​Field​Label​Metrics](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_responses_model_field_label_metrics.htm "Model field information that includes label, value and metrics data.")\[\] | A list of importance metrics for the AI model. | Small, 56.0 | 56.0 | | negative​Factors | [Story​Details](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_responses_story_details.htm "The details for a story. These details are the top positive and negative factors contributing to story outcome.")\[\] | A list of the top negative factors contributing to the outcome. | Small, 51.0 | 51.0 | | positive​Factors | [Story​Details](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_responses_story_details.htm "The details for a story. These details are the top positive and negative factors contributing to story outcome.")\[\] | A list of the top positive factors contributing to the outcome. | Small, 51.0 | 51.0 | | row​Count | Long | The total number of rows in the dataset. | Small, 51.0 | 51.0 | | url | String | The URL for the story summary detail. | Small, 51.0 | 51.0 | # Story Summary Resource Returns a summary for the current version of an Einstein Discovery story. Resource URL /smartdatadiscovery/stories//summary Formats JSON Available Version 51.0 HTTP Methods GET Request parameters for GET | Parameter Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | story​Id | String | The ID of the story to retrieve the summary for. | Required | 51.0 | Response body for GET [Story Summary Detail](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_responses_story_summary_detail.htm "The summary detail for a story.") # Story Text Field Value The story data text property. Properties Inherits properties from [Abstract​Story​Data​Property](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_responses_abstract_story_data_property.htm "The base Einstein Discovery story data property filter."). | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | value | String | The text value of the field. | Small, 52.0 | 52.0 | # Story Text Field Value Input The story data text property. Properties Inherits properties from [Abstract​Story​Data​Property​Input](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_requests_abstract_story_data_property_input.htm "The base Einstein Discovery story data property filter."). | Property Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | value | String | The text value of the field. | Required | 52.0 | # Story Version An Einstein Discovery story version. Properties
Property Name Type Description Filter Group and Version Available Version
alerts​Url String The URL for the alerts for this story version. Small, 53.0 53.0
classification​Threshold Abstract​Classification​Threshold The threshold for classification. Valid values are: Small, 47.0 47.0
created​By Smart​Data​Discovery​User The user who created this story version. Small, 44.0 44.0
created​Date Date The creation date of the story version. Small, 44.0 44.0
description String The description of the story version. Small, 50.0 50.0
error​Code Integer The error code for the story version, if any. Small, 44.0 44.0
fields Abstract​Field​Configuration[] A list of field configurations. Valid values are: Small, 47.0 47.0
folder Asset​Reference The folder that the story version belongs to. Small, 44.0 44.0
id String The ID of the story version. Small, 51.0 51.0
input Abstract​Story​Source The source for the story version. Valid values are: Small, 45.0 45.0
input​Profile Asset​Reference The statistical summary of the input data. Small, 46.0 46.0
insights Smart​Data​Discovery​Insights[] A list of insights associated with this story version. Small, 44.0 44.0
label String The label for the story version. Small, 44.0 44.0
last​Modified​By Smart​Data​Discovery​User The user who last modified this story version. Small, 44.0 44.0
last​Modified​Date Date The last modified date of the story version. Small, 44.0 44.0
message String The error message for the story version, if any. Small, 44.0 44.0
model​Configuration Smart​Data​Discovery​Model​Configuration The model configuration for the story version. Small, 54.0 54.0
outcome Smart​Data​Discovery​Outcome The field on which analysis is performed and its attributes. Small, 44.0 44.0
parent Asset​Reference The parent of the story version, when it is created from an existing story. Small, 44.0 44.0
processed​Row​Count Integer The number of rows processed in building the analysis. Small, 57.0 57.0
sampling​Strategy Analysis​Sampling​Strategy​Enum The sampling strategy associated with the story version. Valid values are:
  • Discovery
  • None
  • Random
 Small, 57.0 57.0
setup Map<Object, Object> A map of the JSON containing information about the setup menu, names, action variables, model settings, variables, and outcomes. Big, 44.0 44.0
status Analysis​Setup​Status​Enum The current status of the analysis. 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
 Small, 44.0 44.0
transformations Abstract​Smart​Data​Discovery​Transformation​Input[] A list of field transformation. Valid values in the list are: Small, 55.0 55.0
url String The URL for the story version. Small, 51.0 51.0
validation​Configuration Abstract​Smart​Data​Discovery​Validation​Configuration The validation configuration for the story. Valid values are: Small, 57.0 57.0
validation​Input Abstract​Story​Source The analysis source for the validation dataset. Valid values are: Small, 53.0 53.0
# Story Version Reference The basic information for an Einstein Discovery story version. Properties | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | created​Date | Date | The creation date of the story version. | Small, 51.0 | 51.0 | | id | String | The ID of the story version. | Small, 51.0 | 51.0 | | url | String | The URL for the story version. | Small, 51.0 | 51.0 | # Story Year Field Value The story data year property. Properties Inherits properties from [Abstract​Story​Data​Property](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_responses_abstract_story_data_property.htm "The base Einstein Discovery story data property filter."). | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | fiscal | Boolean | Indicates whether the value is in a fiscal year (true) or not (false). | Small, 52.0 | 52.0 | | raw​Value | String | The raw value of the field. | Small, 52.0 | 52.0 | | year | Integer | The year in numeric value. | Small, 52.0 | 52.0 | # Story Year Field Value Input The story data year property. Properties Inherits properties from [Abstract​Story​Data​Property​Input](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_requests_abstract_story_data_property_input.htm "The base Einstein Discovery story data property filter."). | Property Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | fiscal | Boolean | Indicates whether the value is in a fiscal year (true) or not (false). | Required | 52.0 | | raw​Value | String | The raw value of the field. | Required | 52.0 | | year | Integer | The year in numeric value. | Required | 52.0 | # Text Field Configuration The text field configuration. Properties Inherits properties from [Abstract​Text​Field​Configuration](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_responses_abstract_text_field_configuration.htm "The base Einstein Discovery text field configuration."). # Text Field Value Configuration The text field value configuration. Properties | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | ignored | Boolean | Indicates whether the field value is ignored (true) or not (false). | Small, 55.0 | 55.0 | | label | String | The label of the field value. | Small, 54.0 | 54.0 | | name | String | The name of the field value. | Small, 54.0 | 54.0 | # Validation Dataset The output for a validation dataset configuration. Properties Inherits properties from [Abstract​Smart​Data​Discovery​Validation​Configuration](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_responses_abstract_smart_data_discovery_validation_configuration.htm "The base validation configuration output.").
Property Name Type Description Filter Group and Version Available Version
input Abstract​Story​Source The source of the validation dataset configuration. Valid values are: Small, 57.0 57.0
# Validation Ratio The output for a validation ratio configuration. Properties Inherits properties from [Abstract​Smart​Data​Discovery​Validation​Configuration](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest_sdd.meta/bi_dev_guide_rest_sdd/bi_sdd_responses_abstract_smart_data_discovery_validation_configuration.htm "The base validation configuration output."). | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | validation​Ratio | Integer | The value of the validation ratio. | Small, 57.0 | 57.0 |