CRM Analytics REST API Developer Guide

CRM Analytics REST API Overview
Examples
Resources
Requests
Action Input
Advanced Property Value Input
Annotation Input
Asset Reference Input
Asset Revert History Input
Auto-Install App Configuration Input
Auto-Install Configuration
Auto-Install Request Insert Input
Auto-Install Request Update Input
Base Asset Input
Base Asset Reference Input
Base Auto-Install Request Input
Base Notification Action Configuration Input
Base Subscription Input
Base Wave Folder Input
Collaboration Room Notification Recipient Input
Collection Subscription Source Input
Constant Input
Daily Schedule Input
Dashboard Subscription Source Input
Dashboard Widget Item Input
Data Connector Input
Data Connector Property
Dataflow Input
Dataflow Job Input
Dataset Input
Dataset Version Input
Event Based Schedule Input
Featured Assets Input
Geo Data Input
Hourly Schedule Input
Json Transformation Input
License Attributes Input
Live Connection Input
Macro Input
Map Bounding Box Input
Map Input
Minutely Schedule Input
Monthly Relative Schedule Input
Monthly Specific Schedule Input
Notification Action Input
Post To Slack Notification Action Configuration Input
Recipe Configuration Collection Input
Recipe Configuration Fiscal Input
Recipe Configuration Fiscal Offset Input
Recipe Configuration
Recipe Conversion Detail Input
Recipe Definition Input
Recipe Input
Recipe Notification Input
Replicated Dataset Input
Replicated Field Collection Input
Replicated Field Input
Restore Dataset Version Input
Rule Definition Input
Rule Input
SAQL Query Input
Schedule Input
Schedule Details Input
Send To Email Notification Action Configuration Input
Slack Reference Input
Source Details Input
Source Object Data Input
Subscription Daily Schedule Input
Subscription Input
Subscription Schedule Input
Subscription Source Input
Subscription Weekly Schedule Input
Subscription Widget Input
Template Input
Template Options Input
Time Input
Trended Report Input
Typed Asset Reference Input
Visual Parameters Input
Watchlist Input
Watchlist Item Input
Watchlist Item Metadata Input
Watchlist Schedule Input
Wave Collection Input
Wave Collection Item Input
Wave Collection Item List Input
Wave Collection Pin Input
Wave Folder Input
Wave Folder Share Input
Wave Folder Template Input
Weekly Schedule Input
Widget Subscription Source Input
Xmd Dataset Input
Xmd Date Field Input
Xmd Date Input
Xmd Derived Dimension Input
Xmd Derived Dimension Member Input
Xmd Derived Dimension Salesforce Action Input
Xmd Derived Measure Format Input
Xmd Derived Measure Input
Xmd Dimension Input
Xmd Dimension Member Input
Xmd Dimension Salesforce Action Input
Xmd Input
Xmd Measure Format Input
Xmd Measure Input
Xmd Organization Input
Responses
Appendices
PDF

Newer Version Available

This content describes an older version of this product. View Latest

Recipe Input

An Analytics data prep recipe.
Properties
Property Name Type Description Required or Optional Available Version
conversion​Details Recipe​Conversion​Detail​Input[] The list of conversion details when converting the recipe to R3 that are saved. Optional 51.0
dataflow​Definition String The recipe's definition. Optional 38.0
execution​Engine Connect​Recipe​Execution​Engine​Enum The recipe's execution engine. Valid values are:
  • V1
  • V2
 Optional 41.0
file​Content String The recipe's JSON file content (see /wave/recipes/<recipeId>/file for more information). This property is internal to the recipe UI and is available for debugging and reference purposes only. This property is valid only for Data Prep Classic recipes. Required for POST and PATCH 38.0
folder Asset​Reference​Input The Analytics app the recipe is published in. Required when dataflow​Definition is present 38.0
format Connect​Recipe​Format​Type​Enum Specifies the format of the recipe. Valid values are:
  • R2 (Data Prep Classic)
  • R3 (Data Prep)
 Required 48.0
history​Label String A history label to tag the version of the recipe. Optional 51.0
label String A short label for the recipe. Optional 38.0
license​Attributes Licenses​Attributes​Input The Analytics license type and other properties. Optional 51.0
publishing​Target Connect​Recipe​Publishing​Target​Enum The target format or system to publish the recipe to. Valid values are:
  • Dataset (Publish to Dataset)
 Optional 42.0
recipe​Definition Recipe​Definition​Input The recipe definition for the Data Prep recipe only. This property isn’t supported for Data Prep Classic recipes. Optional 49.0
row​Level​Security​Predicate String The security predicate of the target dataset. Optional 38.0
schedule String The recipe's schedule dataflow run. Optional 38.0
source​Dataflow Asset​Reference​Input The source dataflow asset used to upconvert to the recipe to R3. Optional 51.0