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
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

Newer Version Available

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

Lens Input

An Analytics lens.

Properties

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

Property Name Type Description Required or Optional Available Version
datasets Asset​Reference​Input[] The list of datasets used to create this lens. Required for POST, optional for PATCH 43.0
folder Asset​Reference​Input The folder in which this lens is stored. Required for POST, optional for PATCH 36.0
history​label String The history label of the lens version being saved. Optional 46.0
state Lens​State​Input The state of the lens. Required for POST, optional for PATCH 36.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
visualization​Type Connect​Wave​Visualization​Type​Enum The visualization type of the lens. Valid values are:
  • Bullet
  • Calendar​Heat​Map
  • Combo
  • Comparison​Table
  • Flatgauge
  • Gauge
  • Heat​Map
  • Horizontal​Bar
  • Horizontal​Dot
  • Line
  • Matrix
  • Parallel​Coordinates
  • Pie
  • Pivot​Table
  • Polargauge
  • Pyramid
  • Rating
  • Scatter
  • Stack​Waterfall
  • Stacked​Horizontal​Bar
  • Stacked​Vertical​Bar
  • Time
  • Time​Bar
  • Time​Combo
  • Values​Table
  • Vertical​Bar
  • Vertical​Dot
  • Waterfall
 Required for POST, optional for PATCH 36.0
xmd Xmd​Input The asset XMD of the lens. Optional 43.0