CRM Analytics REST API Developer Guide
jLens State
The state for an Analytics lenses.
Properties
| Property Name | Type | Description | Filter Group and Version | Available Version |
|---|---|---|---|---|
| options | LensVisualization Option | The configuration options for different lens visualizations. Valid values
are:
|
Small, 36.0 | 36.0 |
| query | Query | The SAQL query used to create this lens. | Small, 36.0 | 36.0 |
BarLensVisualizationOptions
| 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 |
ComparisonTableLensVisualizationOptions
| 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 |
DotLensVisualizationOptions
| 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 |
HeatMapLensVisualizationOptions
| 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 |
MatrixLensVisualizationOptions
| 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 |
ParallelCoordsLensVisualizationOptions
| 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 |
PieLensVisualizationOptions
| 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 |
PivotTableLensVisualizationOptions
| 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 |
ScatterLensVisualizationOptions
| 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 |
StackedBarLensVisualizationOptions
| 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 |
TableLensVisualizationOptions
| 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 |
TimeLensVisualizationOptions
| 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 |
ValuesTableLensVisualizationOptions
| 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 |
Query
| 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 | CompactFormFilter | The query source filters. | Small, 48.0 | 48.0 |
| sources | CompactFormSource | 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 |
CompactFormFilter
| 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 |
CompactFormSource
| Property Name | Type | Description | Filter Group and Version | Available Version |
|---|---|---|---|---|
| cogroupType | ConnectWaveCompactFormCogroupTypeEnum | The compact form source
cogroup type. Valid values are:
|
Small, 48.0 | 48.0 |
| columns | CompactFormColumn | 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 |