Interface InputSearchRule

Rules allow search query modification based on search parameters

interface InputSearchRule {
    enabled?: boolean;
    id: string;
    match?: InputSearchRuleMatch;
    name?: string;
    schedule?: InputSearchSchedule[];
    set?: InputSearchQuery;
}

Index

Properties

enabled? id match? name? schedule? set?

Properties

`Optional`enabled

enabled?: boolean

Used to disable rules creating through dashboard

id

id: string

`Optional`match

match?: InputSearchRuleMatch

Condition that must be met for query to match

`Optional`name

name?: string

User friendly name

`Optional`schedule

schedule?: InputSearchSchedule[]

Defines when the rule will be applied based on date/time

`Optional`set

set?: InputSearchQuery

Search query parameters that will be set if rule matches. Same format as search query itself but not all params are allowed