title
string
required

Title of the insight.

columnX
string

Name of the column that will be compared with other columns specified in the correlatedColumns parameter. Placed in the x axis.

columnY
string

Name of the column that will be compared with other columns specified in the correlatedColumns parameter Placed in the y axis.

correlatedColumns
array[string]
required

A list of columns the columnX or columnY will be compared with. The insight will contain one chart per correlated column. If columnX and columnY are provided correlatedColumns needs to contain only columnY.

hiddenColumns
array[string]

Columns hidden from the Correlations section when the insight is replayed. When replayed, the Correlation section will compare the target variable with all variables in the dataset except these.

insightThemeMode
string

Theme mode applied to the whole insight.

Values must be one of the following:

  • dark
  • light
isExpanded
boolean

Sets the correlation graph as expanded. If true, the insight will contain an expanded chart in order to show the maximum number of categories possible.

replayDisabled
[string, boolean]

Indicates if the insight can replay its original state or not.

Values must be one of the following:

  • drillDown
  • directSelectionInGraph
  • nonPersistedColumn
  • True
  • False
representation
string
required

Sets the visualization type. Whether a heatmap or a bubble like chart.

Values must be one of the following:

  • heatmap
  • bubble
isBoxplot
boolean

Sets Boxplot as visualization type. If true, a combination of quantitative & categorical columns will use Boxplot as visualization type.

elements
array[object]

Type and appearance of an insight’s elements. A list in which each item is an object configuring the appearance of a particular insight element.

Was this page helpful?