Basic settings
Introduction
This page covers the basic settings you can configure through the Embedded Analytics Sandbox — things like export permissions, timezone, header visibility, and filter defaults.
General settings
The General Settings section control some general aspects of the embedded dashboard, including:
- Allowing users to export the dashboard or not
- 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 these options on or off, the generated embedding script updates accordingly.
Timezone settings
Similar to normal dashboards, you can set the default timezone for an embedded dashboard and allow viewers to change the timezone:
For more details, see Timezone Settings.
Control settings
Overriding filter default values is only a convenience feature. Your users can still change filter values freely on the embedded dashboard — no data restriction is enforced.
To enforce what data your users can access, use Permission Settings instead. See the Security documentation for more details on the difference.
The Control Settings section lets you control what data is initially displayed by overriding the default settings of your dashboard filters. This is useful when you want to:
- Show contextual data on load: For example, if a user clicks "Europe" in your application, you can set the region filter to default to "Europe" — so they see relevant data right away.
- Improve performance: By narrowing default filter values, you reduce the amount of data loaded initially, resulting in faster dashboard load times.
When you change the default values and operators in the graphical filter list, your choices are reflected in the embedding code.
The code representation of each control setting has the following form:
filters = {
"filter_uname": {
"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 configuration for this filter, including:
- operator: the operator used in the filter (e.g.,
matches,is,is not). See Supported Field Types and Operators for the full list. - values: the values you want to apply to this filter in the embedded dashboard.
- modifier (optional): only available for some operators in the Date filter (e.g.,
next/lastX days/months/years). The modifier value specifies the time unit, such asday,month, oryear.
- operator: the operator used in the filter (e.g.,
Examples:
Set the default value of date filter f1 to "last 6 months" (including the current period):
"f1": {
"default_condition": {
"operator": "last",
"values": ["6"],
"modifier": "month",
"options": {
"include_current_period": true
}
}
}
Set the default value of field filter f3 to "is Asia":
"f3": {
"default_condition": {
"operator": "is",
"values": ["Asia"],
"modifier": null
}
}