CRM Analytics REST API Developer Guide

CRM Analytics REST API Overview
Quick Start
Examples
Resources
Requests
Action Input
Advanced Property Value Input
Analytics App Setting Collection Input
Analytics App Setting Input
Analytics Asset Collection Query Input
Analytics Asset Filter Input
Annotation Input
Asset Reference Input
Asset Revert History Input
Auto-Install App Configuration Input
Auto-Install Configuration Input
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
Component Saved View Input
Component Saved View State Input
Conditional Formatting Property Input
Constant Input
Daily Schedule Input
Daily Scheduled Item Input
Dashboard Input
Dashboard Saved View Data Source State Input
Dashboard Saved View Filter Input
Dashboard Saved View Input
Dashboard Saved View State Input
Dashboard Saved View Step Metadata Input
Dashboard Saved View Step State Input
Dashboard Subscription Source Input
Dashboard Widget Item Input
Data Connector Input
Data Connector Property Input
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
Lens Input
Lens State Input
License Attributes Input
Live Connection Input
Macro Input
Map Bounding Box Input
Map Input
Mapped SDM Input
Minutely Schedule Input
Monthly Relative Schedule Input
Monthly Specific Schedule Input
Notification Action Input
Post To Slack Notification Action Configuration Input
Replicated Dataset Input
Replicated Field Collection Input
Replicated Field Input
Restore Dataset Version Input
Rule Definition Input
Rule Input
SAQL Query Input
Schedule Details Input
Schedule Input
Scheduled Item Input
Scheduled Time Input
Scheduled Timezone 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
Template Validate 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 Bulk Add Input
Wave Collection Item Input
Wave Collection Item List Input
Wave Collection Pin Input
Wave Folder Input
Wave Folder Schedule Input
Wave Folder Share Input
Wave Folder Template Input
Weekly Schedule Input
Weekly Scheduled Item Input
Widget Subscription Source Input
Base Xmd Dimension Custom Action Input
Base Xmd Dimension Input
Base Xmd Measure Input
Xmd Currency Settings Input
Xmd Dataset Input
Xmd Date Field Input
Xmd Date Input
Xmd Derived Dimension Custom Action 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 Custom Action 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

Note: This release is in preview. Features described here don’t become generally available until the latest general availability date that Salesforce announces for this release. Before then, and where features are noted as beta, pilot, or developer preview, we can’t guarantee general availability within any particular time frame or at all. Make your purchase decisions only on the basis of generally available products and features.

Dashboard Input

An Analytics dashboard.

Properties

DashboardInput inherits properties from the abstract Base Asset Input. These base properties appear in DashboardInput alongside the properties defined explicitly in the following table.

Parameter Name Type Description Required or Optional Available Version
cloned​Template​Origin String If the asset was cloned from an asset that was created from a template, this is the template origin of the original asset. Optional 56.0
current​History​Id String The current saved history id to display for the dashboard. Optional 44.0
date​Version Integer The version of dates used by the dashboard. Valid values are:
  • 1
  • 2
 Optional 44.0
folder Asset​Reference​Input​Representation The folder in which this dashboard is stored. Required for POST, optional for PATCH 44.0
history​Label String A history label to tag the dashboard version being saved. Optional 44.0
layout​Auto​Sync String Indicates whether the dashboard has auto sync enabled for layouts(true) or not (false). Optional 60.0
mobile​Disabled Boolean Indicates whether the dashboard is disabled for mobile (true) or not (false). Optional 41.0
semantic​Models Mapped​SDM​Input[] A list of sementic models for this dashboard. Optional 67.0
state Dashboard​State​Input The state of the dashboard. Required for POST, optional for PATCH 36.0
type Connect​Wave​Asset​Type​Enum The asset type. The default type is Dashboard. Valid types are:
  • Collection
  • Component
  • Contextual​Dashboard
  • Dashboard
  • Dashboard​Saved​View
  • Dashboard​Snapshot
  • Data​Cloud​Report
  • Data​Connector
  • Dataflow
  • Dataflow​Job
  • Dataflow​Job​Node
  • Dataset
  • Dataset​Shard
  • Dataset​Version
  • External​Data
  • Folder
  • Lens
  • Lightning​Component
  • Lightning​Dashboard
  • Lightning​Dashboard​Folder
  • Recipe
  • Recipe​Configuration
  • Recipe​Model
  • Replicated​Dataset
  • Report
  • Report​Folder
  • Story
  • Tableau​Dashboard
  • Tableau​Workbook
  • Template
  • Widget
  • Workflow
 Optional 44.0
xmd Xmd​Input The asset XMD of the dashboard. Optional 44.0
visibility Connect​Wave​Asset​Visibility​Type Indicates whether the asset is hidden from users with view access or not. Valid values are:
  • All (Show all assets)
  • Limited (Hide assets from viewers with view access)
 Optional 51.0