Einstein Analytics REST API

Create, update, and retrieve user notifications for recipe jobs with Salesforce using the Einstein Analytics REST API. Search data connectors with more filters. Retrieve the application log lines for the application's create and upgrade lifecycle.

New and Changed Einstein Analytics REST API Resources

These resources are new or have changes.
Search data connectors with new query parameters
Make a GET request to /wave/dataConnectors with the category, folderId, and scope parameters. Valid category values are: AdvancedPropertiesSupport, BatchRead, Direct, FileBased, FilterSupport, MuleSoft, and Output.
Get the application log for Analytics applications
Make a GET request to /wave/folders/folderId. Set the filterGroup parameter to supplemental to return the appLog in the response.
Search all recipes by recipe format
Make a GET request to /wave/recipes/recipeId with the format parameter.
Get recipe response by recipe format
Make a GET request to /wave/recipes with the format parameter.
Get a recipe notification
Make a GET request to /wave/recipes/recipeId/notification.
Update a recipe notification
Make a PUT request to /wave/recipes/recipeId/notification with the new Recipe Notification Input request body.

New and Changed Einstein Analytics REST API Request Bodies

These request bodies are new or have changes.
Compact Form Filter Input (CompactFormFilterInputRepresentation)
The request body has this new property.
  • booleanFilterLogic - Boolean filter logic text for the compact form.
Dynamic Data Input (DynamicDataInputRepresentation)
The new request body has the following properties.
  • displayTemplate - Contains the dynamic expression to resolve.
  • values - Map of dynamic values.
Dynamic Value Input (DynamicValueInputRepresentation)
The new request body has the following properties.
  • field - Column used to resolve the value.
  • sourceType - Interaction type. Valid values are: Result and Selection.
  • step - Step id for value.
Recipe Notification Input (RecipeNotificationInputRepresentation)
The new request body has the following properties.
  • longRunningAlertInMins - Number of minutes that a recipe can run before sending an alert.
  • notificationLevel - Notification level for email alerts.
Recipe Input (RecipeInputRepresentation)
The request body has this new property.
  • format - Recipe format type. Valid values are 2.0 and 3.0.
SAQL Query Input (SaqlQueryInputRepresentation)
The request body has this new property.
  • queryLanguage - Language in which the query is written. Valid values are: SAQL and SQL.
Text Widget Parameters Input (TextWidgetParametersInputRepresentation)
The request body has these changes.
  • content - Dynamic value of the text.
  • text - DEPRECATED Value of the text.

New and Changed Einstein Analytics REST API Response Bodies

These response bodies are new or have changes.
App Log Output (AppLogRepresentation)
The new response body has the following properties.
  • message - A log line from the application creation and upgrade process.
Compact Form Filter Output (CompactFormFilterRepresentation)
The response body has this new property.
  • booleanFilterLogic - Boolean filter logic for the compact form.
Data Connector Output (DataConnectorRepresentation)
The response body has this new property.
  • folder - Analytics application for the connector.
Data Connector Type Output (DataConnectorTypeRepresentation)
The response body has this new property.
  • associatedCategories - Categories the data connector type belongs to. Valid values are: AdvancedPropertiesSupport, BatchRead, Direct, FileBased, FilterSupport, MuleSoft, and Output.
Dynamic Data Output (DynamicDataRepresentation)
The new response body has the following properties.
  • displayTemplate - Contains the dynamic expression to resolve.
  • values - Map of dynamic values.
Dynamic Value Output (DynamicValueRepresentation)
The new response body has the following properties.
  • field - Column used to resolve the value.
  • sourceType - Interaction type. Valid values are: Result and Selection.
  • step - Step id for value.
Recipe Notification Output (RecipeNotificationRepresentation)
The new response body has the following properties.
  • longRunningAlertInMins - Number of minutes that a recipe can run before sending an alert.
  • notificationLevel - Notification level for email alerts.
Recipe Output (RecipeRepresentation)
The response body has this new property.
  • scheduleType - Schedule type of the recipe. Valid values are: EventDriven and TimeDriven.
Text Widget Parameters Output (TextWidgetParametersRepresentation)
The response body has these changes.
  • content - Dynamic value of the text.
  • text - DEPRECATED Value of the text.
Einstein Analytics Features Output (WaveFeaturesRepresentation)
The response body has these new properties.
  • orgHasFavorites - Indicates whether the org is enabled for favorites (true) or not (false).
  • orgHasWatchlistEnabled - Indicates whether the org is enabled for watchlists (true) or not (false).
Einstein Analytics Folder Output (WaveFolderRepresentation)
The response body has this new property.
  • appLog - List of message strings that are the log lines for the application’s creation and upgrade process.