omni.OmniFilterDefinition

Defines an Omni dashboard filter. Used to populate an OmniFilterSet and generate the filter search params for an embedded dashboard URL.

Parameters:

Name	Type	Description	Default
field	str	Name of the Omni field a filter exists for. Generally a dot-path representing a dimension in a view.	required
type	Type	Type of the value to be filtered on.	required
operator	Operator	Type of filter operation to perform.	equals

Attributes:

Name	Type	Description
field	str	Name of the Omni field a filter exists for. Generally a dot-path representing a dimension in a view.
type	Type	Type of the value to be filtered on.
operator	Operator	Type of filter operation to perform.

Source code in src/omni/embed.py

@dataclass
class OmniFilterDefinition:
    """Defines an Omni dashboard filter. Used to populate an OmniFilterSet and generate the filter search params
    for an embedded dashboard URL.

    Args:
        field: Name of the Omni field a filter exists for. Generally a dot-path representing a dimension in a view.
        type: Type of the value to be filtered on.
        operator: Type of filter operation to perform.

    Attributes:
        field: Name of the Omni field a filter exists for. Generally a dot-path representing a dimension in a view.
        type: Type of the value to be filtered on.
        operator: Type of filter operation to perform.

    """

    class Type(Enum):
        """Omni Filter Type Options

        Attributes:
            number: number
            string: string
        """

        number = "number"
        string = "string"

    class Operator(Enum):
        """Omni Filter Operator Options

        Attributes:
            equals: EQUALS
            less_than: LESS_THAN
            greater_than: GREATER_THAN
            less_than_or_equal = LESS_THAN_OR_EQUAL
            greater_than_or_equal = GREATER_THAN_OR_EQUAL
            contains = CONTAINS
            between = BETWEEN
            starts_with = STARTS_WITH
            ends_with = ENDS_WITH
        """

        equals = "EQUALS"
        less_than = "LESS_THAN"
        greater_than = "GREATER_THAN"
        less_than_or_equal = "LESS_THAN_OR_EQUAL"
        greater_than_or_equal = "GREATER_THAN_OR_EQUAL"
        contains = "CONTAINS"
        between = "BETWEEN"
        starts_with = "STARTS_WITH"
        ends_with = "ENDS_WITH"

    field: str
    type: Type
    operator: Operator = Operator.equals
    is_negative: bool = False

    def get_filter_search_param_info(
        self, values: str | int | float | list[str | int | float]
    ) -> tuple[str, list[str]]:
        """Returns the key and value to be used in a query string for an Omni Dashboard.

        Args:
            values: Value or list of values to filter on.

        Returns:
            : Key and value to use in the filter search params when building an embedded dashboard URL.
        """
        if not isinstance(values, list):
            values = [values]
        filter_key = f"f--{self.field}"

        is_inclusive = False

        operator_kind = self.operator.value

        if self.operator == self.Operator.greater_than_or_equal:
            is_inclusive = True
            operator_kind = self.Operator.greater_than.value
        elif self.operator == self.Operator.less_than_or_equal:
            is_inclusive = True
            operator_kind = self.Operator.less_than.value

        filter_value_param = {
            "is_negative": self.is_negative,
            "kind": operator_kind,
            "type": self.type.value,
            "values": values,
        }

        if self.type == self.Type.number:
            filter_value_param["is_inclusive"] = is_inclusive

        filter_value = [json.dumps(filter_value_param)]
        return filter_key, filter_value

Operator

Bases: Enum

Omni Filter Operator Options

Attributes:

Name	Type	Description
equals		EQUALS
less_than		LESS_THAN
greater_than		GREATER_THAN

Source code in src/omni/embed.py

class Operator(Enum):
    """Omni Filter Operator Options

    Attributes:
        equals: EQUALS
        less_than: LESS_THAN
        greater_than: GREATER_THAN
        less_than_or_equal = LESS_THAN_OR_EQUAL
        greater_than_or_equal = GREATER_THAN_OR_EQUAL
        contains = CONTAINS
        between = BETWEEN
        starts_with = STARTS_WITH
        ends_with = ENDS_WITH
    """

    equals = "EQUALS"
    less_than = "LESS_THAN"
    greater_than = "GREATER_THAN"
    less_than_or_equal = "LESS_THAN_OR_EQUAL"
    greater_than_or_equal = "GREATER_THAN_OR_EQUAL"
    contains = "CONTAINS"
    between = "BETWEEN"
    starts_with = "STARTS_WITH"
    ends_with = "ENDS_WITH"

Type

Bases: Enum

Omni Filter Type Options

Attributes:

Name	Type	Description
number		number
string		string

Source code in src/omni/embed.py

class Type(Enum):
    """Omni Filter Type Options

    Attributes:
        number: number
        string: string
    """

    number = "number"
    string = "string"

get_filter_search_param_info(values)

Returns the key and value to be used in a query string for an Omni Dashboard.

Parameters:

Name	Type	Description	Default
values	str | int | float | list[str | int | float]	Value or list of values to filter on.	required

Returns:

Type	Description
tuple[str, list[str]]	Key and value to use in the filter search params when building an embedded dashboard URL.

Source code in src/omni/embed.py

def get_filter_search_param_info(
    self, values: str | int | float | list[str | int | float]
) -> tuple[str, list[str]]:
    """Returns the key and value to be used in a query string for an Omni Dashboard.

    Args:
        values: Value or list of values to filter on.

    Returns:
        : Key and value to use in the filter search params when building an embedded dashboard URL.
    """
    if not isinstance(values, list):
        values = [values]
    filter_key = f"f--{self.field}"

    is_inclusive = False

    operator_kind = self.operator.value

    if self.operator == self.Operator.greater_than_or_equal:
        is_inclusive = True
        operator_kind = self.Operator.greater_than.value
    elif self.operator == self.Operator.less_than_or_equal:
        is_inclusive = True
        operator_kind = self.Operator.less_than.value

    filter_value_param = {
        "is_negative": self.is_negative,
        "kind": operator_kind,
        "type": self.type.value,
        "values": values,
    }

    if self.type == self.Type.number:
        filter_value_param["is_inclusive"] = is_inclusive

    filter_value = [json.dumps(filter_value_param)]
    return filter_key, filter_value