Tableau CRM REST API Developer Guide

Working with the Tableau CRM REST API
Tableau CRM REST API Reference
Tableau CRM REST API Resources Overview
Wave Resource
Auto-Install Requests List Resource
Auto-Install Request 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
Collections List Resource
Collections Items Resource
Dashboards List Resource
Dashboard Resource
Dashboard Bundle Resource
Dashboard Histories Resource
Dashboard Publishers List Resource
Dashboard Publisher 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 Resource
Data Connector Source Objects List Resource
Data Connector Source Object Resource
Data Connector Source Object Data Preview Resource
Data Connector Source Object Fields Resource
Data Connector Status Resource
Data Connector Types Resource
Dataflow Jobs List Resource
Dataflow Job Resource
Dataflow Job Nodes List Resource
Dataflow Job Nodes Resource
Dataflows List Resource
Dataflow Resource
Datasets List Resource
Dataset Resource
Dataset Versions List Resource
Dataset Version Resource
Dataset Version File Resource
Dependencies Resource
Features Configuration Resource
Folders List Resource
Folder Resource
JsonXform Transformation
Limits Resource
Lenses List Resource
Lens Resource
Lens File Resource
Lens File Metadata Resource
Lens Bundle Resource
Query Resource
Recipes List Resource
Recipe Resource
Recipe File Resource
Recipe Notification Resource
Replicated Dataset Resource
Replicated Datasets List Resource
Replicated Dataset Fields Resource
Schedule Resource
Subscriptions List Resource
Subscription Resource
Subscription Layout Resource
Subscription Widgets Resource
Subscription Widget Resource
Security Coverage Dataset Version Resource
Security Coverage Object Resource
Templates List Resource
Template Resource
Template Configuration Resource
Template Release Notes Resource
Trended Reports List Resource
Trended Reports Resource
Watchlist Resource
Watchlist Item Resource
Watchlist Schedules Resource
Watchlist Schedule Resource
Xmd List Resource
Xmd Resource
Asset Xmd Resource
Additional Tableau CRM REST API Resources
PDF

Newer Version Available

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

Subscriptions List Resource

Returns a list of subscriptions or creates a subscription schedule.
Resource URL
1/wave/subscriptions
Formats
JSON
Available Version
47.0
HTTP Methods
GET POST
GET Response Body (SubscriptionCollectionRepresentation)
Property Name Type Description Filter Group and Version Available Version
subscriptions Subscription​Representation[] A collection of subscriptions. Small, 47.0 47.0
POST Request Body
Parameter Name Type Description Required or Optional Available Version
run​Now Boolean Indicates whether the subscription should run now (true) or later (false). Required 47.0
subscription Subscription​Input​Representation[] The subscription details. Required 47.0
POST Response Body (SubscriptionRepresentation)

SubscriptionRepresentation inherits properties from the abstract SnapshotRepresentation. These base properties appear in SubscriptionRepresentation alongside the properties defined explicitly in the following table.

Parameter Name Type Description Filter Group and Version Available Version
source Subscription​Source​Representation[] The subscription source including type, label, and record ID. Small, 47.0 47.0
SubscriptionInputRepresentation

SubscriptionInputRepresentation inherits properties from the abstract BaseSubscriptionInputRepresentation. These base properties appear in SubscriptionInputRepresentation alongside the properties defined explicitly in the following table.

Parameter Name Type Description Required or Optional Available Version
schedule Subscription​Schedule​Input​Representation[] The subscription schedule. Required 47.0
source Subscription​Source​Input​Representation[] The subscription source including type, label, and record ID. Small, 47.0 47.0