GuideReference
TrainingSupportCommunity

query_​string_​parameter

  • Property Manager name: Query String Parameter
  • Criteria version: The v2023-05-30 rule format supports the query_​string_​parameter criteria v1.1.
  • Rule format status: GA, stable
  • Access: Read-write
  • Allowed in includes: Yes

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 * and ? wildcard matches in the parameter_​name field.

{"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 * and ? wildcard matches in 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"]}}
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"]}}