Type Alias BreakdownFilter

Filter configuration for a breakdown dimension

{
 *   type: "values",
 *   values: [
 *     "Europe",
 *     "Asia",
 *     "North America"
 *   ]
 * }
type BreakdownFilter = {
    condition?: BreakdownConditionFilter;
    exclude?: boolean;
    search?: BreakdownSearchFilter;
    topBottom?: BreakdownTopBottomFilter;
    type: BreakdownFilterType;
    values?: string[];
}
Index
condition? exclude? search? topBottom? type values?
condition?: BreakdownConditionFilter

Condition-based filtering configuration. Supports single comparisons (>, >=, <, <=) and range comparisons (> <, >= <=).

Single Comparisons:

  • Compare type: Uses value (Fixed) or aggregation+field (Calculated)
  • General type: Uses aggregation+field and either value (Fixed) or aggregation2+field2 (Calculated)

Range Comparisons (> < or >= <=):

  • Compare type: Uses fromValue+toValue (Fixed) or fromAggregation+fromField+toAggregation+toField (Calculated)
  • General type: Uses aggregation+field plus either fromValue+toValue (Fixed) or fromAggregation+fromField+toAggregation+toField (Calculated)
exclude?: boolean

When set to true, the filter values are excluded from analysis instead of included.

  • If exclude is false or omitted, only the matched values are analyzed (max 50).
  • If exclude is true, all dimension values EXCEPT the matched values are analyzed (max 50).
search?: BreakdownSearchFilter

Search-based filtering configuration. If searchString is empty or not provided, all dimension values will be analyzed (no filtering applied).

topBottom?: BreakdownTopBottomFilter

Top/bottom filtering configuration

type: BreakdownFilterType

Type of breakdown filter

values?: string[]

List of values to filter by (used when type is Values)

Settings
Member Visibility

On This Page
Properties