Lenses List Resource

Returns a list of Analytics Cloud lenses or creates a lens.

Resource URL

1/wave/lenses

Formats

JSON

Available Version

36.0

HTTP Methods

GET POST

GET Request Parameters

Parameter Name	Type	Description	Required or Optional	Available Version
`folderId`	ID	Filters the results to include only the contents of a specific folder. The id can be the requesting user’s ID for items in the user’s private folder.	Optional	36.0
`page`	String	A generated token that indicates the view of the lenses to be returned.	Optional	36.0
`pageSize`	Integer	The number of items to be returned in a single page. Minimum is 1, maximum is 200, and default is 25.	Optional	36.0
`q`	String	Search terms. Individual terms are separated by spaces. A wildcard is automatically appended to the last token in the query string. If the user’s search query contains quotation marks or wildcards, those symbols are automatically removed from the query string in the URI along with any other special characters.	Optional	36.0
`scope`	ConnectWaveScopeTypeEnum	The type of scope to be applied to the returned collection. Valid values are: `CreatedByMe` `Mru` (Most Recently Used) `SharedWithMe`	Optional	38.0
`sort`	ConnectWaveSortOrderTypeEnum	The type of sort order to be applied to the returned collection. Valid values are: `LastModified` `LastModifiedBy` `Mru` (Most Recently Used) `Name`	Optional	38.0

GET Response Body

Property Name	Type	Description	Filter Group and Version	Available Version
`lenses`	LensRepresentation[]	The list of lenses available to the current user.	Small, 36.0	36.0
`nextPageUrl`	String	The URL to retrieve the next page of contents in the collection.	Small, 36.0	36.0
`totalSize`	Integer	The total count of the elements in the collection, including all pages.	Medium, 36.0	36.0
`url`	String	The URL to retrieve the collection.	Small, 36.0	36.0

POST 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`	String	The visualization type to be used for this lens. Valid values are: `calheatmap`: Calendar heat map `comparisontable`: Compare table `heatmap`: Heat map `hbar`: Bar `hbarhdot`: Horizontal dot plot `matrix`: Matrix `parallelcoords`: Parallel coordinates `pie`: Donut `pivottable`: Pivot table `scatter`: Scatter plot `stackhbar`: Stacked bar `stackvbar`: Stacked column `time`: Timeline `valuestable`: Values table `vbar`: Column `vdot`: Vertical dot plot	Required for POST, optional for PATCH	36.0
`xmd`	XmdInputRepresentation	The asset XMD of the lens.	Optional	43.0

POST 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: `calheatmap`: Calendar heat map `comparisontable`: Compare table `heatmap`: Heat map `hbar`: Bar `hbarhdot`: Horizontal dot plot `matrix`: Matrix `parallelcoords`: Parallel coordinates `pie`: Donut `pivottable`: Pivot table `scatter`: Scatter plot `stackhbar`: Stacked bar `stackvbar`: Stacked column `time`: Timeline `valuestable`: Values table `vbar`: Column `vdot`: Vertical dot plot	Small, 36.0	36.0

LensStateInputRepresentation

Property Name	Type	Description	Required or Optional	Available Version
`options`	LensVisualizationOptionsInputRepresentation	The configuration options for different lens visualizations.	Optional	36.0
`query`	QueryInputRepresentation	The SAQL query to be used to create this lens.	If using any visualization type other than comparison table, you are required to specify this property.	36.0

QueryInputRepresentation

Property Name	Type	Description	Required or Optional	Available Version
`aggregateFilters`	Object	The compact form aggregate filters for the query.	Optional	48.0
`limit`	Object	The query limit.	Optional	48.0
`orders`	Object	The query orders.	Optional	48.0
`query`	String	The SAQL query.	Optional for PATCH, required for POST	36.0
`sourceFilters`	Map<String,CompactFormFilterInputRepresentation>	The map of compact form source filters for the query.	Optional	48.0
`sources`	CompactFormSourceInputRepresentation[]	The list of compact form sources for the query.	Optional	48.0
`timezone`	String	The timezone for the query request.	Optional	43.0
`version`	Double	Version to which this query language construct belongs.	Optional for PATCH, required for POST	36.0

CompactFormFilterInputRepresentation

Property Name	Type	Description	Required or Optional	Available Version
`booleanFilterLogic`	String	The boolean filter logic.	Optional	49.0
`filters`	Object	The compact form filters.	Required	48.0

CompactFormSourceInputRepresentation

Property Name	Type	Description	Required or Optional	Available Version
`cogroupType`	ConnectWaveCompactFormCogroupTypeEnum	The compact form source cogroup type. Valid values are: Full Inner Left Right	Required	48.0
`columns`	CompactFormColumnRepresentation[]	The list of compact form source columns.	Required	48.0
`groups`	Object	The compact form source groups.	Required	48.0
`name`	String	The compact form source name.	Required	48.0

LensVisualizationOptionsInputRepresentation

Property Name	Type	Description	Required or Optional	Available Version
`fit`	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.	Optional	36.0
`hideHeaderColumn`	Boolean	Indicates whether to display header column or not.	Optional	36.0
`legend`	Boolean	Indicates whether to show legend or not.	Optional	36.0
`legendHideHeader`	Boolean	Indicates whether to hide the legend or not.	Optional	36.0
`legendWidth`	Integer	The width of the legend.	Optional	36.0
`maxColumnWidth`	Integer	The maximum width of the header column.	Optional	36.0
`minColumnWidth`	Integer	The minimum width of the header column.	Optional	36.0
`miniBars`	Integer	The width of the miniBars, if present.	Optional	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.	Optional	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.	Optional	36.0
`splitAxis`	Boolean	Indicates whether each measure is projected on one axis or if all measures share an axis.	Optional	36.0
`sqrt`	Boolean	Indicates whether the axis is sqrt scale or not.	Optional	36.0
`subtotals`	Boolean	Indicates whether to display subtotals in the table or not.	Optional	48.0
`totals`	Boolean	Indicates whether to display totals in the table or not.	Optional	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.	Optional	36.0

Tableau CRM REST API Developer Guide

Lenses List Resource