title
string
required

Title of the insight.

columns
array[string]
required

Columns from which the insight is created.

hiddenColumns
array[string]

Columns that will not be used to create the insight.

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.

sortingOrder
string

Useful to choose the ordering kind of the columns, by difference or by similarity.

Values must be one of the following:

  • differentFirst
  • similarFirst
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. In relative and absolute modes the comparing segments will be rendered as charts, but in tabular mode a table is shown.

Values must be one of the following:

  • relative
  • absolute
  • tabular
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.

comparingSegments
array[object]
required

Array of segments to use in the insight.

Was this page helpful?