Analytics REST API Developer Guide

Working with the Analytics REST API
Analytics REST API Reference
Analytics REST API Resources Overview
Wave Resource
Annotations List Resource
Annotation Resource
Charts Geodata List Resource
Charts Geodata Resource
Charts Geodata File List Resource
Charts Maps List Resource
Charts Maps Resource
Dashboards List Resource
Dashboard Resource
Dashboard Image Resource
Data Connector Resource
Data Connectors List Resource
Data Connector Source Objects List Resource
Data Connector Source Object Resource
Data Connector Source Object Data Resource
Data Connector Source Object Data Preview Resource
Data Connector Source Object Fields Resource
Data Connector Types Resource
Datasets List Resource
Dataset Resource
Dependencies Resource
Features Configuration Resource
File Resource
Folders List Resource
Folder Resource
Lenses List Resource
Lens Resource
Lens File Resource
Lens File Metadata Resource
Query Resource
Recipes List Resource
Recipe Resource
Recipe File Resource
Replicated Datasets Resource
Replicated Datasets List Resource
Replicated Dataset Fields Resource
Templates List Resource
Templates Resource
Templates Configuration Resource
Template Release Notes Resource
Trended Reports List Resource
Trended Reports Resource
Versions List Resource
Version Resource
XMD List Resource
XMD Resource
PDF

Newer Version Available

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

Recipes List Resource

A listing of Data Prep recipes.
Resource URL
Formats
JSON
Available Version
38.0
HTTP Methods
GET POST
GET Request Parameters
Parameter Name Type Description Required or Optional Available Version
page String A generated token that indicates the view of the objects to be returned. 38.0
pageSize Int Number of items to be returned in a single page. Minimum is 1, maximum is 200, and default is 25. 38.0
q String Search terms. Individual terms are separated by spaces. Wild cards aren’t supported. 38.0
sort ConnectWaveSortOrderTypeEnum LastModified, Mru, or Name. 38.0
GET Response Body
Property Name Type Description Filter Group and Version Available Version
recipes RecipeRepresentation[] A list of recipes. Small, 38.0 38.0
POST Request Body
Property Name Type Description Required or Optional Available Version
dataflowDefinition String The recipe's dataflow definition. 38.0
fileContent String The recipe's file content, base64 encoded. Consider using multipart form data instead. 38.0
folder Asset​Reference​Input​Representation The recipe's publish folder. 38.0
label String A short label for the recipe. 38.0
name String The name of the recipe. 38.0
rowLevelSecurityPredicate String The recipe's target dataset's security predicate. 38.0
schedule String The recipe's schedule dataflow run. 38.0
POST Request Parameters
Parameter Name Type Description Required or Optional Available Version
recipeFile Binary Recipe JSON file (transforms). For Salesforce use only. 38.0
recipeObject Object (RecipeInputRepresentation) Metadata information such as recipe name, dataflow definition (if any), label, folder, and so on. 38.0
POST Response Body
Property Name Type Description Filter Group and Version Available Version
dataflowLastUpdate Date Last dataflow update. Small, 38.0 38.0
dataset Asset​Reference​Representation Target Dataset Small, 38.0 38.0
fileUrl String URL to get the recipe's file content. Small, 38.0 38.0
rowLevelSecurityPredicate String The security predicate of the target dataset Small, 38.0 38.0
schedule String The schedule cron expression current dataflow. Small, 38.0 38.0