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
Dashboard Saved Views List Resource
Dashboard Saved Views Resource
Dashboard Saved Views Initial Resource
Data Connector Resource
Data Connectors List Resource
Data Connector Ingest 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
Dataflow Jobs List Resource
Dataflow Jobs Resource
Dataflows List Resource
Dataflows 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
Schedule Resource
Security Coverage Dataset Version Resource
Security Coverage Object Resource
Templates List Resource
Templates Resource
Templates Configuration Resource
Template Release Notes Resource
Trended Reports List Resource
Trended Reports Resource
Dataset Versions List Resource
Dataset Version Resource
XMD List Resource
XMD Resource
PDF

Newer Version Available

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

Dataflows Resource

Get dataflow information.
Resource URL
1/wave/dataflows/<dataflowId>
Formats
JSON
Available Version
37.0
HTTP Methods
GET PATCH
GET Response Body
DataflowRepresentation
Property Name Type Description Filter Group and Version Available Version
email​Notification​Level Connect​Email​Notification​Level​Enum Email notification level of the dataflow. The options are: Always, Failures, Never, and Warnings. Small, 42.0 42.0
historiesUrl String The URL that retrieves the dataflow histories. Small, 46.0 46.0
nextScheduledDate Date The time of the next scheduled run, in ISO8601 date format. Small, 42.0 42.0
scheduleAttributes String Schedule details for the dataflow, which includes the frequency and start time. Small, 42.0 42.0

BaseWaveAssetRepresentation

DataflowRepresentation and other representations inherit properties from this base representation. These base properties appear alongside properties defined explicitly for DataflowRepresentation.

Property Name Type Description Filter Group and Version Available Version
asset​Sharing​Url String The URL for opening this asset in the user interface. This is a form of deep linking. The server examines the link parameters, which might include urlType, assetId, orgId, and loginHost, as well as other optional parameters, and translates as necessary to produce the correct result on the target client. For example, it will open the asset on a desktop client, or mobile if you are on a mobile OS. Small, 36.0 36.0
createdBy Wave​User​Representation The creator of the asset. Small, 36.0 36.0
createdDate Date The time at which the asset was created, in ISO8601 date format. Small, 36.0 36.0
description String Short description of the asset. Small, 36.0 36.0
id ID The 18-character ID of the asset. Small, 36.0 36.0
label String The label of the asset. Small, 36.0 36.0
last​Accessed​Date Date The last time the asset was accessed, in ISO8601 date format. Small, 36.0 36.0
last​ModifiedBy Wave​User​Representation The user who last updated the asset. Small, 36.0 36.0
last​Modified​Date Date The last time the asset was modified, in ISO8601 date format. Small, 36.0 36.0
name String The name of the asset. Small, 36.0 36.0
namespace String The namespace of the asset. Small, 36.0 36.0
permissions Permissions​Representation The permissions for the current user. Small, 36.0 36.0
type Connect​Wave​Asset​Type​Enum The asset type. Valid types include:
  • Component
  • Dashboard
  • DashboardSnapshot
  • DataConnector
  • DataPoolEntity
  • DataPoolEntityVersion
  • Dataflow
  • DataflowJob
  • Dataset
  • DatasetShard
  • DatasetVersion
  • ExternalData
  • Folder
  • Lens
  • Recipe
  • ReplicatedDataset
  • Story
  • Workflow
 Small, 36.0 36.0
url String The URL to the definition of the asset. Small, 36.0 36.0

WaveUserRepresentation

Property Name Type Description Filter Group and Version Available Version
id ID The 18-character user ID. Small, 36.0 36.0
name String The name of the user. Small, 36.0 36.0
profile​Photo​Url String The Chatter profile photo of the user. Small, 36.0 36.0

Permissions​Representation

Property Name Type Description Filter Group and Version Available Version
manage Boolean Indicates whether a user can manage access control on an asset. Small, 36.0 36.0
modify Boolean Indicates whether a user can modify an asset. Small, 36.0 36.0
view Boolean Indicates whether a user can view an asset. Small, 36.0 36.0
PATCH Request Body
DataflowInputRepresentation
Property Name Type Description Required or Optional Available Version
definition Dataflow​Definition​Input​Representation A dataflow definition. 37.0
PATCH Request Parameters
Parameter Name Type Description Required or Optional Available Version
dataflow Object A dataflow. 37.0
PATCH Response Body
DataflowRepresentation
DataflowVersionRepresentation
Property Name Type Description Filter Group and Version Available Version
createdBy Wave​User​Representation Represents the asset creator. Small, 37.0 37.0
createdDate Date Time the asset was created. Small, 37.0 37.0
id String The 18 character asset ID. Small, 37.0 37.0