Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.omni.co/llms.txt

Use this file to discover all available pages before exploring further.

In the Embed URL Builder, this is the Filter search param field.

​
Syntax

filterSearchParam=<encoded_filter_specification>

​
Properties

​
filterSearchParam
string
An object containing a filter specification for the embedded content. Filter specifications are formatted as follows:
f--<filter_id>={"values":["value1","value2", ...]}
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

The following example demonstrates what the URL encoded version of f--rW8-IWVU={"values":["closed"]} would be:
Example filter
filterSearchParam=f--rW8-IWVU=%7B%22values%22%3A%5B%22closed%22%5D%7D