Tableau CRM REST API Developer Guide

Tableau CRM REST API Overview
Examples
Resources
Tableau CRM REST API Resources Overview
Wave Resource
Auto-Install Request Resources
Annotation Resources
Collection Resources
Dashboard Resources
Data Connector Resources
Dataflow Job Resources
Dataflow Resources
Dataset Resources
Dependencies Resource
Eclair Chart Resources
Features Configuration Resource
Folder Resources
JsonXform Transformation
Limits Resource
Lens Resources
Query Resource
Recipe Resources
Replicated Dataset Resources
Schedule Resource
Subscription Resources
Security Coverage Dataset Version Resource
Security Coverage Object Resource
Template Resources
Trended Report Resources
Watchlist Resources
Watchlist Resource
Watchlist Item Resource
Watchlist Schedules Resource
Watchlist Schedule Resource
Xmd Resources
Requests
Responses
Appendices
PDF

Newer Version Available

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

Watchlist Resource

Return, create, and update a watchlist.
Resource URL
1/wave/watchlist
Formats
JSON
Available Version
48.0
HTTP Methods
GET PATCH POST
GET Response Body (WatchlistRepresentation)
Property Name Type Description Filter Group and Version Available Version
watchlist​Snapshots Watchlist​Snapshot​Representation The collection of watchlist snapshots available to the current user. Small, 48.0 48.0
PATCH Request Body
Property Name Type Description Required or Optional Available Version
watchlist​Item Watchlist​Input​Representation The watchlist item to update. Required 49.0
PATCH Response Body (WatchlistRepresentation)
Property Name Type Description Filter Group and Version Available Version
watchlist​Snapshots Watchlist​Snapshot​Representation The collection of watchlist snapshots available to the current user. Small, 48.0 48.0
POST Request Body
Property Name Type Description Required or Optional Available Version
watchlist​Item Watchlist​Item​Input​Representation The watchlist item to create. Required 49.0
POST Response Body (WatchlistRepresentation)
Property Name Type Description Filter Group and Version Available Version
watchlist​Snapshots Watchlist​Snapshot​Representation The collection of watchlist snapshots available to the current user. Small, 48.0 48.0
Watchlist​Input​Representation
Property Name Type Description Required or Optional Available Version
watchlist​Items Watchlist​Item​Input​Representation[] The collection of watchlist snapshot items available to the current user. Required 48.0
Watchlist​Item​Input​Representation
Property Name Type Description Required or Optional Available Version
schedule​Id String The schedule id of the watchlist item. Required 48.0
watchlist​Widget​Item Watchlist​Item​Metadata​Input​Representation The metadata of the watchlist item. Required 48.0
Watchlist​Item​Metadata​Input​Representation
Property Name Type Description Required or Optional Available Version
drift​State Connect​Dashboard​Snapshot​Drift​State The drift state of the watchlist item. Valid values are:
  • Clean (Indicates the snapshot is clean)
  • Dirty (Indicates the snapshot has drifted and is dirty)
  • IgnoreQueryDrift (Indicates the snapshot is dirty, but user has ignored it)
 Required 49.0
id String The id of the watchlist item. Required 49.0
parameters Visual​Parameters​Input​Representation The visualization parameters of the watchlist item. Required 49.0
sort​Order Integer The sort order of the watchlist item. Required 49.0
source​Dashboard​Id String The source dashboard id of the watchlist item. Required 49.0
Visual​Parameters​Input​Representation
Property Name Type Description Required or Optional Available Version
should​Increase Boolean Indicates whether the metric being watched should increase in value (true) or not (false). Required 49.0