Embedded Analytics - Basic Settings

Introduction

This document will walk you through the basic settings you can configure interactively through the Embedded Analytics Sandbox.

General Settings

The General Settings controls some general aspects of the embedded dashboard, including:

• Allowing users to export raw data or not
• Showing or hiding the dashboard header panel
• Showing or hiding the dashboard control panel.

When you toggle on/off the options, the generated embedding script will be updated accordingly.

Timezone settings

Similar to normal dashboards, you can also set the default timezone for an embedded dashboard, and allow viewers to flexibly change the timezone as follows:

For more detailed information, please refer to our dedicated doc forTimezone Settings

Permission Settings

Please refer to our dedicated doc for this topic: Permission Settings for Embedded Analytics

Control Settings

This is not a data security feature

Hiding filters and overriding default values are only convenience features to customize the look and feel of your dashboard. No data restriction is implemented.

If you want to enforce data access restriction, please use Permission Settings instead of Controls Settings.

You can find more details about the difference between the two settings in the Security documentation.

The Controls Settings section allows you to override the default settings of your dashboard filters, in case you want to present the Embedded Dashboard differently from how it looks when viewed directly in Holistics.

Similar to other settings, when you change the default values and operators in the graphical filter list, your choice will be reflected in the embedding code.

The code representation of each Control Setting has the following form:

filters = {
  "filter_uname": {
    "hidden": false,
    "default_condition": {
      "operator": "expected_operator",
      "values": [
        "expected_value"
      ],
      "modifier": null
    }
  },
}

Explanations:

• filter_uname: defines which filter you want to override in the embedded dashboard. This value is auto-generated.
• default_condition: contains the default configurations for this filter, including:
  • operator: the operator used in the filter
  • values: the value you want to apply to this filter in the embedded dashboard
  • modifier (optional): only available for some of the operators in the Date filter (for example, next, last X days/months/years.)
• hidden: has a boolean type, by setting it to true, the filter will be hidden in the embedded dashboard (but the default value has already been applied). This option will make your dashboard nicer and cleaner.