API

queryStringParameter

Matches query string field names or values.

OptionTypeDescriptionRequires
parameter​Namestring

The name of the query field, for example, q in ?q=string.

{"displayType":"string","tag":"input","type":"text"}
match​Operatorenum 
Narrows the match criteria.
{"displayType":"enum","options":["IS_ONE_OF","IS_NOT_ONE_OF","EXISTS","DOES_NOT_EXIST","IS_LESS_THAN","IS_MORE_THAN","IS_BETWEEN"],"tag":"select"}
IS_​ONE_​OF
Tests whether the field's value string matches.
IS_​NOT_​ONE_​OF
Tests whether the field's value string does not match.
EXISTS
Whether the query field's parameter​Name is present in the requesting URL.
DOES_​NOT_​EXIST
Whether the query field's parameter​Name is absent from the requesting URL.
IS_​LESS_​THAN
Matches a range when the value is numeric.
IS_​MORE_​THAN
Matches a range when the value is numeric.
IS_​BETWEEN
Is between the numeric lower​Bound and upper​Bound values.
valuesstring array 
The value of the query field, for example, string in ?q=string.
match​Operator is either: IS_​ONE_​OF, IS_​NOT_​ONE_​OF
{"displayType":"string array","tag":"input","todo":true}
{"if":{"attribute":"matchOperator","op":"in","value":["IS_ONE_OF","IS_NOT_ONE_OF"]}}
lower​Boundnumber 
Specifies the match's minimum value.
match​Operator is either: IS_​MORE_​THAN, IS_​BETWEEN
{"displayType":"number","tag":"input","type":"number"}
{"if":{"attribute":"matchOperator","op":"in","value":["IS_MORE_THAN","IS_BETWEEN"]}}
upper​Boundnumber 
When the value is numeric, this field specifies the match's maximum value.
match​Operator is either: IS_​LESS_​THAN, IS_​BETWEEN
{"displayType":"number","tag":"input","type":"number"}
{"if":{"attribute":"matchOperator","op":"in","value":["IS_LESS_THAN","IS_BETWEEN"]}}
match​Wildcard​Nameboolean 
Allows wildcards in the parameter​Name field, where ? matches a single character and * matches zero or more characters.
{"displayType":"boolean","tag":"input","type":"checkbox"}
match​Case​Sensitive​Nameboolean 
Sets a case-sensitive match for the parameter​Name field.
{"displayType":"boolean","tag":"input","type":"checkbox"}
match​Wildcard​Valueboolean 
Allows wildcards in the value field, where ? matches a single character and * matches zero or more characters.
match​Operator is either: IS_​ONE_​OF, IS_​NOT_​ONE_​OF
{"displayType":"boolean","tag":"input","type":"checkbox"}
{"if":{"attribute":"matchOperator","op":"in","value":["IS_ONE_OF","IS_NOT_ONE_OF"]}}
match​Case​Sensitive​Valueboolean 
Sets a case-sensitive match for the value field.
match​Operator is either: IS_​ONE_​OF, IS_​NOT_​ONE_​OF
{"displayType":"boolean","tag":"input","type":"checkbox"}
{"if":{"attribute":"matchOperator","op":"in","value":["IS_ONE_OF","IS_NOT_ONE_OF"]}}
escape​Valueboolean 
Matches when the value is URL-escaped.
match​Operator is either: IS_​ONE_​OF, IS_​NOT_​ONE_​OF
{"displayType":"boolean","tag":"input","type":"checkbox"}
{"if":{"attribute":"matchOperator","op":"in","value":["IS_ONE_OF","IS_NOT_ONE_OF"]}}