CRM Analytics REST API Developer Guide
jNewer Version Available
Lens Resource
- Resource URL
-
1/wave/lenses/<lensIdOrApiName> - Formats
- JSON
- Available Version
- 36.0
- Available Components
-
- Apex — Wave.Lenses.getLens()
- Aura — <wave:sdk> describeLens()
- HTTP Methods
- GET DELETE PATCH
- GET Response Body (LensRepresentation)
-
LensRepresentation inherits properties from the abstract BaseTemplatedAssetRepresentation. These base properties appear in LensRepresentation alongside the properties defined explicitly in the following table.
Property Name Type Description Filter Group and Version Available Version allowPreview Boolean Indicates whether the user is allowed to preview the lens. Small, 36.0 36.0 dataset AssetReferenceRepresentation DEPRECATED A reference to the dataset used to create this lens. Small, 36.0 36.0-42.0 datasets AssetReferenceRepresentation[] A list of the datasets that the lens uses. Small, 43.0 43.0 dateVersion Integer The version of dates used by the lens. Valid values are: - 1
- 2
Small, 44.0 44.0 files LensFileRepresentation[] The list of the lens files. Medium, 36.0 36.0 filesUrl String The URL to the lens files. Small, 36.0 36.0 folder AssetReferenceRepresentation A reference to the folder in which this lens is stored. Small, 36.0 36.0 historiesUrl String The URL for the lens histories associated with this lens. Small, 44.0 44.0 refreshDate Date The date of the most recent current dataset that is used by the lens, in ISO8601 date format. Small, 36.0 36.0 state LensStateRepresentation The state of the lens. Big, 36.0 36.0 visibility ConnectWaveAssetVisibilityType 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)
Small, 51.0 51.0 visualizationType String The visualization type used for this lens. Valid values are: Valid values are: - Bullet
- CalendarHeatMap
- Combo
- ComparisonTable
- Flatgauge
- Gauge
- HeatMap
- HorizontalBar
- HorizontalDot
- Line
- Matrix
- ParallelCoordinates
- Pie
- PivotTable
- Polargauge
- Pyramid
- Rating
- Scatter
- StackWaterfall
- StackedHorizontalBar
- StackedVerticalBar
- Time
- TimeBar
- TimeCombo
- ValuesTable
- VerticalBar
- VerticalDot
- Waterfall
Small, 36.0 36.0 - PATCH Request Body (LensInputRepresentation)
-
LensInputRepresentation inherits properties from the abstract BaseAssetInputRepresentation. These base properties appear in LensInputRepresentation alongside the properties defined explicitly in the following table.
Property Name Type Description Required or Optional Available Version datasets AssetReferenceInputRepresentation[] The list of dataset used to create this lens. Required for POST, optional for PATCH 43.0 folder AssetReferenceInputRepresentation The folder in which this lens is stored. Required for POST, optional for PATCH 36.0 historylabel String The history label of the lens version being saved. Optional 46.0 state LensStateInputRepresentation The state of the lens. Required for POST, optional for PATCH 36.0 visibility ConnectWaveAssetVisibilityType 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 visualizationType ConnectWaveVisualizationTypeEnum The visualization type of the lens. Valid values are: - Bullet
- CalendarHeatMap
- Combo
- ComparisonTable
- Flatgauge
- Gauge
- HeatMap
- HorizontalBar
- HorizontalDot
- Line
- Matrix
- ParallelCoordinates
- Pie
- PivotTable
- Polargauge
- Pyramid
- Rating
- Scatter
- StackWaterfall
- StackedHorizontalBar
- StackedVerticalBar
- Time
- TimeBar
- TimeCombo
- ValuesTable
- VerticalBar
- VerticalDot
- Waterfall
Required for POST, optional for PATCH 36.0 xmd XmdInputRepresentation The asset XMD of the lens. Optional 43.0 - PATCH Response Body (LensRepresentation)
-
Property Name Type Description Filter Group and Version Available Version allowPreview Boolean Indicates whether the user is allowed to preview the lens. Small, 36.0 36.0 dataset AssetReferenceRepresentation DEPRECATED A reference to the dataset used to create this lens. Small, 36.0 36.0-42.0 datasets AssetReferenceRepresentation[] A list of the datasets that the lens uses. Small, 43.0 43.0 dateVersion Integer The version of dates used by the lens. Valid values are: - 1
- 2
Small, 44.0 44.0 files LensFileRepresentation[] The list of the lens files. Medium, 36.0 36.0 filesUrl String The URL to the lens files. Small, 36.0 36.0 folder AssetReferenceRepresentation A reference to the folder in which this lens is stored. Small, 36.0 36.0 historiesUrl String The URL for the lens histories associated with this lens. Small, 44.0 44.0 refreshDate Date The date of the most recent current dataset that is used by the lens, in ISO8601 date format. Small, 36.0 36.0 state LensStateRepresentation The state of the lens. Big, 36.0 36.0 visibility ConnectWaveAssetVisibilityType 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)
Small, 51.0 51.0 visualizationType String The visualization type used for this lens. Valid values are: Valid values are: - Bullet
- CalendarHeatMap
- Combo
- ComparisonTable
- Flatgauge
- Gauge
- HeatMap
- HorizontalBar
- HorizontalDot
- Line
- Matrix
- ParallelCoordinates
- Pie
- PivotTable
- Polargauge
- Pyramid
- Rating
- Scatter
- StackWaterfall
- StackedHorizontalBar
- StackedVerticalBar
- Time
- TimeBar
- TimeCombo
- ValuesTable
- VerticalBar
- VerticalDot
- Waterfall
Small, 36.0 36.0
- LensFileRepresentation
-
Property Name Type Description Filter Group and Version Available Version contentType String The content type of the file. Small, 36.0 36.0 fileLength Integer The length of the file in KB. Small, 36.0 36.0 fileName String The name of the file. Small, 36.0 36.0 id ID The 18-character lens file ID. Small, 36.0 36.0 lastModifiedDate Date The last modified date of the file, in ISO8601 date format. Small, 36.0 36.0 url String The URL of the file. Small, 36.0 36.0 - LensStateRepresentation
-
Property Name Type Description Filter Group and Version Available Version options LensVisualization OptionsRepresentation The configuration options for different lens visualizations. Valid values are: - BarLensVisualizationOptionsRepresentation
- ComparisonTableLensVisualizationOptionsRepresentation
- DotLensVisualizationOptionsRepresentation
- HeatMapLensVisualizationOptionsRepresentation
- MatrixLensVisualizationOptionsRepresentation
- ParallelCoordsLensVisualizationOptionsRepresentation
- PieLensVisualizationOptionsRepresentation
- PivotTableLensVisualizationOptionsRepresentation
- ScatterLensVisualizationOptionsRepresentation
- StackedBarLensVisualizationOptionsRepresentation
- TableLensVisualizationOptionsRepresentation
- TimeLensVisualizationOptionsRepresentation
- ValuesTableLensVisualizationOptionsRepresentation
Small, 36.0 36.0 query QueryRepresentation The SAQL query used to create this lens. Small, 36.0 36.0 - BarLensVisualizationOptionsRepresentation
-
Property Name Type Description Filter Group and Version Available Version legend Boolean Indicates whether to display the legend or not. Small, 36.0 36.0 legendHideHeader Boolean Indicates whether to hide the legend header or not. Small, 36.0 36.0 legendWidth Integer The width of the legend. Small, 36.0 36.0 maxColumnWidth Integer The maximum width of the header column. Small, 36.0 36.0 minColumnWidth Integer The minimum width of the header column. Small, 36.0 36.0 miniBars Integer The width of the mini-bars, if used. Small, 36.0 36.0 multiMetrics Boolean Indicates whether multiple measures are projected on the same chart, side by side, or if every measure is in its own chart. Small, 36.0 36.0 splitAxis Boolean Indicates whether each measure is projected on one axis or if all measures share an axis. Small, 36.0 36.0 sqrt Boolean Indicates whether the axis is sqrt scale or not. Small, 36.0 36.0 trellis Boolean Indicates whether the last group is treated as a trellis dimension or not. Every distinct value of the dimension is a chart. Small, 36.0 36.0 - ComparisonTableLensVisualizationOptionsRepresentation
-
Property Name Type Description Filter Group and Version Available Version maxColumnWidth Integer The maximum width of the header column. Small, 36.0 36.0 minColumnWidth Integer The minimum width of the header column. Small, 36.0 36.0 subtotals Boolean Indicates whether to display subtotals in the table or not. Small, 48.0 48.0 totals Boolean Indicates whether to display totals in the table or not. Small, 36.0 36.0 - DotLensVisualizationOptionsRepresentation
-
Property Name Type Description Filter Group and Version Available Version fit Boolean Indicates whether to scale the position and size of a data shape so that it's proportional to its percentage of its category or not. Small, 36.0 36.0 legend Boolean Indicates whether to display the legend or not. Small, 36.0 36.0 legendHideHeader Boolean Indicates whether to hide the legend header or not. Small, 36.0 36.0 legendWidth Integer The width of the legend. Small, 36.0 36.0 sqrt Boolean Indicates whether the axis is sqrt scale or not. Small, 36.0 36.0 - HeatMapLensVisualizationOptionsRepresentation
-
Property Name Type Description Filter Group and Version Available Version legendHideHeader Boolean Indicates whether to hide the legend header or not. Small, 36.0 36.0 legendWidth Integer The width of the legend. Small, 36.0 36.0 sqrt Boolean Indicates whether the axis is sqrt scale or not. Small, 36.0 36.0 - MatrixLensVisualizationOptionsRepresentation
-
Property Name Type Description Filter Group and Version Available Version legendHideHeader Boolean Indicates whether to hide the legend header or not. Small, 36.0 36.0 legendWidth Integer The width of the legend. Small, 36.0 36.0 sqrt Boolean Indicates whether the axis is sqrt scale or not. Small, 36.0 36.0 - ParallelCoordsLensVisualizationOptionsRepresentation
-
Property Name Type Description Filter Group and Version Available Version fit Boolean Indicates whether to scale the position and size of a data shape so that it's proportional to its percentage of its category or not. Small, 36.0 36.0 legend Boolean Indicates whether to display the legend or not. Small, 36.0 36.0 legendHideHeader Boolean Indicates whether to hide the legend header or not. Small, 36.0 36.0 legendWidth Integer The width of the legend. Small, 36.0 36.0 sqrt Boolean Indicates whether the axis is sqrt scale or not. Small, 36.0 36.0 - PieLensVisualizationOptionsRepresentation
-
Property Name Type Description Filter Group and Version Available Version legendHideHeader Boolean Indicates whether to hide the legend header or not. Small, 36.0 36.0 legendWidth Integer The width of the legend. Small, 36.0 36.0 sqrt Boolean Indicates whether the axis is sqrt scale or not. Small, 36.0 36.0 - PivotTableLensVisualizationOptionsRepresentation
-
Property Name Type Description Filter Group and Version Available Version columnTotals Boolean Indicates whether to display column totals in the table (true) or not (false). Small, 55.0 55.0 maxColumnWidth Integer The maximum width of the header column. Small, 36.0 36.0 minColumnWidth Integer The minimum width of the header column. Small, 36.0 36.0 rowTotals Boolean Indicates whether to display row totals in the table (true) or not (false). Small, 55.0 55.0 totals Boolean Indicates whether to display totals in the table or not. Small, 36.0 36.0 - ScatterLensVisualizationOptionsRepresentation
-
Property Name Type Description Filter Group and Version Available Version fit Boolean Indicates whether to scale the position and size of a data shape so that it's proportional to its percentage of its category or not. Small, 36.0 36.0 legend Boolean Indicates whether to display the legend or not. Small, 36.0 36.0 legendHideHeader Boolean Indicates whether to hide the legend header or not. Small, 36.0 36.0 legendWidth Integer The width of the legend. Small, 36.0 36.0 sqrt Boolean Indicates whether the axis is sqrt scale or not. Small, 36.0 36.0 - StackedBarLensVisualizationOptionsRepresentation
-
Property Name Type Description Filter Group and Version Available Version legend Boolean Indicates whether to display the legend or not. Small, 36.0 36.0 legendHideHeader Boolean Indicates whether to hide the legend header or not. Small, 36.0 36.0 legendWidth Integer The width of the legend. Small, 36.0 36.0 maxColumnWidth Integer The maximum width of the header column. Small, 36.0 36.0 minColumnWidth Integer The minimum width of the header column. Small, 36.0 36.0 miniBars Integer The width of the mini-bars, if used. Small, 36.0 36.0 normalize Boolean Indicates whether to scale the position and size of data shape so that it’s proportional to its percentage of its category or not. Small, 36.0 36.0 sqrt Boolean Indicates whether the axis is sqrt scale or not. Small, 36.0 36.0 - TableLensVisualizationOptionsRepresentation
-
Property Name Type Description Filter Group and Version Available Version columnTotals Boolean Indicates whether to display column totals in the table (true) or not (false). Small, 55.0 55.0 subtotals Boolean Indicates whether to display subtotals in the table or not. Small, 48.0 48.0 rowTotals Boolean Indicates whether to display row totals in the table (true) or not (false). Small, 55.0 55.0 totals Boolean Indicates whether to display totals in the table or not. Small, 36.0 36.0 - TimeLensVisualizationOptionsRepresentation
-
Property Name Type Description Filter Group and Version Available Version legend Boolean Indicates whether to display the legend or not. Small, 36.0 36.0 legendHideHeader Boolean Indicates whether to hide the legend header or not. Small, 36.0 36.0 legendWidth Integer The width of the legend. Small, 36.0 36.0 multiMetrics Boolean Indicates whether multiple measures are projected on the same chart, side by side, or if every measure is in its own chart. Small, 36.0 36.0 sqrt Boolean Indicates whether the axis is sqrt scale or not. Small, 36.0 36.0 - ValuesTableLensVisualizationOptionsRepresentation
-
Property Name Type Description Filter Group and Version Available Version hideHeaderColumn Boolean Indicates whether to display header column or not. Small, 36.0 36.0 maxColumnWidth Integer The maximum width of the header column. Small, 36.0 36.0 minColumnWidth Integer The minimum width of the header column. Small, 36.0 36.0 totals Boolean Indicates whether to display totals in the table or not. Small, 36.0 36.0 - QueryRepresentation
-
Property Name Type Description Filter Group and Version Available Version aggregateFilters Object The query aggregate filters. Small, 48.0 48.0 limit Object The query limit. Small, 48.0 48.0 orders Object The query orders. Small, 48.0 48.0 pivotTotals String The query pivot totals. Small, 55.0 55.0 query String The SAQL query text. Small, 36.0 36.0 sourceFilters CompactFormFilterRepresentation The query source filters. Small, 48.0 48.0 sources CompactFormSourceRepresentation The query sources. Small, 48.9 48.0 totals String The query totals. Small, 55.0 55.0 version Double The version of this query. Small, 36.0 36.0 - CompactFormFilterRepresentation
-
Property Name Type Description Filter Group and Version Available Version booleanFilterLogic String The boolean filter logic. Small, 49.0 49.0 filters Object The list of filters. Small, 48.0 48.0 - CompactFormSourceRepresentation
-
Property Name Type Description Filter Group and Version Available Version cogroupType ConnectWaveCompactFormCogroupTypeEnum The compact form source cogroup type. Valid values are: - Full
- Inner
- Left
- Right
Small, 48.0 48.0 columns CompactFormColumnRepresentation The compact form source columns. Small, 48.0 48.0 groups Object The compact form source groups. Small, 48.0 48.0 filters Object The compact form source column filters. Small, 52.0 52.0 name String The compact form source name. Small, 48.0 48.0 - CompactFormColumnRepresentation
-
Property Name Type Description Filter Group and Version Available Version field Object The compact form column field. Small, 48.0 48.0 formula String The compact form column formula. Small, 48.0 48.0 name String The name of the compact form column. Small, 48.0 48.0