Skip to main content
Specifies the filters to apply for the embedded content. In the Embed URL Builder, this is the Filter search param field.

​
Syntax

​
Properties

​
string
An object containing a filter specification for the embedded content. Filter specifications are formatted as follows:
You can retrieve values for this parameter by using Omni in a non-embedded context. Navigate to a dashboard with filters and change the filter values. The URL will change when new filter values are applied - use what’s in the URL as the value for this parameter.

​
Examples

Unlike JSON-valued parameters, filterSearchParam holds a URI-encoded query fragment in both signing formats. In the v1 signed payload format, use the encoded string as the parameter’s value inside the payload.
The following example demonstrates what the URL encoded version of f--rW8-IWVU={"values":["closed"]} would be:
Example filter