Work with Smart Discovery in Analytic Applications

In analytics designer, smart discovery can only be accessed via script APIs, which runs a machine learning algorithm to help you explore your data in a specific context and uncover new or unknown relationships between columns within a dataset.

APIs to Create and Pre-define Smart Discovery Settings

The APIs to create and pre-define smart discovery settings include:

  • data source (mandatory)

  • selecting the dimensions or measures you want to explore (mandatory)

  • classification groups (mandatory)

  • version (optional)

  • singular and plural (deprecated since version 2020.23)

  • included columns (optional)

  • page filters (optional)

For more detailed information about the APIs, refer to the component SmartDiscoveryDimensionSettings and SmartDiscoveryStructureSettings in Analytics Designer API Reference.

APIs to Trigger Smart Discovery

There are two ways of using APIs to trigger smart discovery:

  • Launching via user interaction events such as clicking a button. A dialog will pop up displaying the URL as a hyperlink, which application users can click to launch smart discovery in a new browser page.

    Note

    This operation isn't supported on mobile devices.

  • Launching via selecting a widget with hyperlink property. You can create a smart discovery URL and use it as a hyperlink in images, shapes and texts, so that application users can click the widget to launch smart discovery in a new browser page.

For more detailed information about the APIs, refer to the component SmartDiscovery in Analytics Designer API Reference.

After launching smart discovery, you'll see the Smart Discovery configuration panel with predefined settings. Confirm your settings and select Run. Smart discovery will be automatically executed and display the results in a new story.

Note

For the smart discovery defined before version 2021.1, If you call SmartDiscovery API and set setSettingsPanelVisible to true, in the Smart Discovery configuration panel you need to first input value in the new field Entity before you can successfully run it.