visitor_prioritization

Property Manager name: Visitor Prioritization Cloudlet
Behavior version: The v2024-01-09 rule format supports the visitor_prioritization behavior v3.6.
Rule format status: GA, stable
Access: Read/Write
Allowed in includes: No (temporarily)

The Visitor Prioritization Cloudlet decreases abandonment by providing a user-friendly waiting room experience. With Cloudlets available on your contract, choose Your services > Edge logic Cloudlets to control Visitor Prioritization within Control Center. Otherwise use the Cloudlets API to configure it programmatically. To serve non-HTML API content such as JSON blocks, see the api_prioritization behavior.

Option	Type	Description	Requires
`enabled`	boolean	Enables the Visitor Prioritization behavior.		{"displayType":"boolean","tag":"input","type":"checkbox"}
`cloudlet_policy`	object	Identifies the Cloudlet policy.		{"displayType":"object","tag":"input","todo":true} {"if":{"attribute":"enabled","op":"eq","value":true}}
`cloudlet_policy.id`	number	Identifies the Cloudlet.
`cloudlet_policy.name`	string	The Cloudlet's descriptive name.
`user_identification_by_cookie`	boolean	When enabled, identifies users by the value of a cookie.		{"displayType":"boolean","tag":"input","type":"checkbox"} {"if":{"attribute":"enabled","op":"eq","value":true}}
`user_identification_key_cookie`	string	Specifies the name of the cookie whose value identifies users. To match a user, the value of the cookie needs to remain constant across all requests.	`user_identification_by_cookie` is `true`	{"displayType":"string","tag":"input","type":"text"} {"if":{"op":"and","params":[{"attribute":"enabled","op":"eq","value":true},{"attribute":"userIdentificationByCookie","op":"eq","value":true}]}}
`user_identification_by_headers`	boolean	When enabled, identifies users by the values of GET or POST request headers.		{"displayType":"boolean","tag":"input","type":"checkbox"} {"if":{"attribute":"enabled","op":"eq","value":true}}
`user_identification_key_headers`	string array	Specifies names of request headers whose values identify users. To match a user, values for all the specified headers need to remain constant across all requests.	`user_identification_by_headers` is `true`	{"displayType":"string array","tag":"input","todo":true} {"if":{"op":"and","params":[{"attribute":"enabled","op":"eq","value":true},{"attribute":"userIdentificationByHeaders","op":"eq","value":true}]}}
`user_identification_by_ip`	boolean	Allows IP addresses to identify users.		{"displayType":"boolean","tag":"input","type":"checkbox"} {"if":{"attribute":"enabled","op":"eq","value":true}}
`user_identification_by_params`	boolean	When enabled, identifies users by the values of GET or POST request parameters.		{"displayType":"boolean","tag":"input","type":"checkbox"} {"if":{"attribute":"enabled","op":"eq","value":true}}
`user_identification_key_params`	string array	Specifies names of request parameters whose values identify users. To match a user, values for all the specified parameters need to remain constant across all requests. Parameters that are absent or blank may also identify users.	`user_identification_by_params` is `true`	{"displayType":"string array","tag":"input","todo":true} {"if":{"op":"and","params":[{"attribute":"enabled","op":"eq","value":true},{"attribute":"userIdentificationByParams","op":"eq","value":true}]}}
`allowed_user_cookie_enabled`	boolean	Sets a cookie for users who have been allowed through to the site.		{"displayType":"boolean","tag":"input","type":"checkbox"} {"if":{"attribute":"enabled","op":"eq","value":true}}
`allowed_user_cookie_label`	string	Specifies a label to distinguish this cookie for an allowed user from others. The value appends to the cookie's name, and helps you to maintain the same user assignment across behaviors within a property, and across properties.	`allowed_user_cookie_enabled` is `true`	{"displayType":"string","tag":"input","type":"text"} {"if":{"op":"and","params":[{"attribute":"enabled","op":"eq","value":true},{"attribute":"allowedUserCookieEnabled","op":"eq","value":true}]}}
`allowed_user_cookie_duration`	number (0-600)	Sets the number of seconds for the allowed user's session once allowed through to the site.	`allowed_user_cookie_enabled` is `true`	{"displayType":"number","max":[600],"min":[0],"tag":"input","type":"range"} {"if":{"op":"and","params":[{"attribute":"enabled","op":"eq","value":true},{"attribute":"allowedUserCookieEnabled","op":"eq","value":true}]}}
`allowed_user_cookie_refresh`	boolean	Resets the duration of an allowed cookie with each request, so that it only expires if the user doesn't make any requests for the specified duration. Do not enable this option if you want to set a fixed time for all users.	`allowed_user_cookie_enabled` is `true`	{"displayType":"boolean","tag":"input","type":"checkbox"} {"if":{"op":"and","params":[{"attribute":"enabled","op":"eq","value":true},{"attribute":"allowedUserCookieEnabled","op":"eq","value":true}]}}
`allowed_user_cookie_advanced`	boolean	Sets advanced configuration options for the allowed user's cookie.	`allowed_user_cookie_enabled` is `true`	{"displayType":"boolean","tag":"input","type":"checkbox"} {"if":{"op":"and","params":[{"attribute":"enabled","op":"eq","value":true},{"attribute":"allowedUserCookieEnabled","op":"eq","value":true}]}}
`allowed_user_cookie_automatic_salt`	boolean	Sets an automatic salt value to verify the integrity of the cookie for an allowed user. Disable this if you want to share the cookie across properties.	`allowed_user_cookie_enabled` is `true` AND `allowed_user_cookie_advanced` is `true`	{"displayType":"boolean","tag":"input","type":"checkbox"} {"if":{"op":"and","params":[{"attribute":"enabled","op":"eq","value":true},{"attribute":"allowedUserCookieEnabled","op":"eq","value":true},{"attribute":"allowedUserCookieAdvanced","op":"eq","value":true}]}}
`allowed_user_cookie_salt`	string	Specifies a fixed salt value, which is incorporated into the cookie's value to prevent users from manipulating it. You can use the same salt string across different behaviors or properties to apply a single cookie to all allowed users.	`allowed_user_cookie_enabled` is `true` AND `allowed_user_cookie_advanced` is `true` AND `allowed_user_cookie_automatic_salt` is `false`	{"displayType":"string","tag":"input","type":"text"} {"if":{"op":"and","params":[{"attribute":"enabled","op":"eq","value":true},{"attribute":"allowedUserCookieEnabled","op":"eq","value":true},{"attribute":"allowedUserCookieAdvanced","op":"eq","value":true},{"attribute":"allowedUserCookieAutomaticSalt","op":"eq","value":false}]}}
`allowed_user_cookie_domain_type`	enum	Specify with `allowed_user_cookie_advanced` enabled.	`allowed_user_cookie_enabled` is `true` AND `allowed_user_cookie_advanced` is `true`	{"displayType":"enum","options":["DYNAMIC","CUSTOMER"],"tag":"select"} {"if":{"op":"and","params":[{"attribute":"enabled","op":"eq","value":true},{"attribute":"allowedUserCookieEnabled","op":"eq","value":true},{"attribute":"allowedUserCookieAdvanced","op":"eq","value":true}]}}
	`DYNAMIC`	Use the dynamic incoming host header.
	`CUSTOMER`	Use a customer-defined cookie domain.
`allowed_user_cookie_domain`	string	Specifies a domain for an allowed user cookie.	`allowed_user_cookie_enabled` is `true` AND `allowed_user_cookie_advanced` is `true` AND `allowed_user_cookie_domain_type` is `CUSTOMER`	{"displayType":"string","tag":"input","type":"text"} {"if":{"op":"and","params":[{"attribute":"enabled","op":"eq","value":true},{"attribute":"allowedUserCookieEnabled","op":"eq","value":true},{"attribute":"allowedUserCookieAdvanced","op":"eq","value":true},{"attribute":"allowedUserCookieDomainType","op":"eq","value":"CUSTOMER"}]}}
`allowed_user_cookie_http_only`	boolean	Applies the `HttpOnly` flag to the allowed user's cookie to ensure it's accessed over HTTP and not manipulated by the client.	`allowed_user_cookie_enabled` is `true` AND `allowed_user_cookie_advanced` is `true`	{"displayType":"boolean","tag":"input","type":"checkbox"} {"if":{"op":"and","params":[{"attribute":"enabled","op":"eq","value":true},{"attribute":"allowedUserCookieEnabled","op":"eq","value":true},{"attribute":"allowedUserCookieAdvanced","op":"eq","value":true}]}}
`waiting_room_cookie_enabled`	boolean	Enables a cookie to track a waiting room assignment.		{"displayType":"boolean","tag":"input","type":"checkbox"} {"if":{"attribute":"enabled","op":"eq","value":true}}
`waiting_room_cookie_share_label`	boolean	Enabling this option shares the same `allowed_user_cookie_label` string. If disabled, specify a different `waiting_room_cookie_label`.	`waiting_room_cookie_enabled` is `true` AND `allowed_user_cookie_enabled` is `true`	{"displayType":"boolean","tag":"input","type":"checkbox"} {"if":{"op":"and","params":[{"attribute":"enabled","op":"eq","value":true},{"attribute":"waitingRoomCookieEnabled","op":"eq","value":true},{"attribute":"allowedUserCookieEnabled","op":"eq","value":true}]}}
`waiting_room_cookie_label`	string	Specifies a label to distinguish this waiting room cookie from others. The value appends to the cookie's name, and helps you to maintain the same waiting room assignment across behaviors within a property, and across properties.	`waiting_room_cookie_enabled` is `true`	{"displayType":"string","tag":"input","type":"text"} {"if":{"op":"and","params":[{"attribute":"enabled","op":"eq","value":true},{"attribute":"waitingRoomCookieEnabled","op":"eq","value":true},{"op":"or","params":[{"attribute":"allowedUserCookieEnabled","op":"eq","value":false},{"attribute":"waitingRoomCookieShareLabel","op":"eq","value":false}]}]}}
`waiting_room_cookie_duration`	number (0-120)	Sets the number of seconds for which users remain in the waiting room. During this time, users who refresh the waiting room page remain there.	`waiting_room_cookie_enabled` is `true`	{"displayType":"number","max":[120],"min":[0],"tag":"input","type":"range"} {"if":{"op":"and","params":[{"attribute":"enabled","op":"eq","value":true},{"attribute":"waitingRoomCookieEnabled","op":"eq","value":true}]}}
`waiting_room_cookie_advanced`	boolean	When enabled along with `waiting_room_cookie_enabled`, sets advanced configuration options for the waiting room cookie.	`waiting_room_cookie_enabled` is `true`	{"displayType":"boolean","tag":"input","type":"checkbox"} {"if":{"op":"and","params":[{"attribute":"enabled","op":"eq","value":true},{"attribute":"waitingRoomCookieEnabled","op":"eq","value":true}]}}
`waiting_room_cookie_automatic_salt`	boolean	Sets an automatic salt value to verify the integrity of the waiting room cookie. Disable this if you want to share the cookie across properties.	`waiting_room_cookie_enabled` is `true` AND `waiting_room_cookie_advanced` is `true`	{"displayType":"boolean","tag":"input","type":"checkbox"} {"if":{"op":"and","params":[{"attribute":"enabled","op":"eq","value":true},{"attribute":"waitingRoomCookieEnabled","op":"eq","value":true},{"attribute":"waitingRoomCookieAdvanced","op":"eq","value":true}]}}
`waiting_room_cookie_salt`	string	Specifies a fixed salt value, which is incorporated into the cookie's value to prevent users from manipulating it. You can use the same salt string across different behaviors or properties to apply a single cookie for the waiting room session.	`waiting_room_cookie_enabled` is `true` AND `waiting_room_cookie_advanced` is `true` AND `waiting_room_cookie_automatic_salt` is `false`	{"displayType":"string","tag":"input","type":"text"} {"if":{"op":"and","params":[{"attribute":"enabled","op":"eq","value":true},{"attribute":"waitingRoomCookieEnabled","op":"eq","value":true},{"attribute":"waitingRoomCookieAdvanced","op":"eq","value":true},{"attribute":"waitingRoomCookieAutomaticSalt","op":"eq","value":false}]}}
`waiting_room_cookie_domain_type`	enum	Specify with `waiting_room_cookie_advanced` enabled, selects whether to use the `DYNAMIC` incoming host header, or a `CUSTOMER`-defined cookie domain.	`waiting_room_cookie_enabled` is `true` AND `waiting_room_cookie_advanced` is `true`	{"displayType":"enum","options":["DYNAMIC","CUSTOMER"],"tag":"select"} {"if":{"op":"and","params":[{"attribute":"enabled","op":"eq","value":true},{"attribute":"waitingRoomCookieEnabled","op":"eq","value":true},{"attribute":"waitingRoomCookieAdvanced","op":"eq","value":true}]}}
	`DYNAMIC`	Use the dynamic incoming host header.
	`CUSTOMER`	Use a customer-defined cookie domain.
`waiting_room_cookie_domain`	string	Specifies a domain for the waiting room cookie.	`waiting_room_cookie_enabled` is `true` AND `waiting_room_cookie_advanced` is `true` AND `waiting_room_cookie_domain_type` is `CUSTOMER`	{"displayType":"string","tag":"input","type":"text"} {"if":{"op":"and","params":[{"attribute":"enabled","op":"eq","value":true},{"attribute":"waitingRoomCookieEnabled","op":"eq","value":true},{"attribute":"waitingRoomCookieAdvanced","op":"eq","value":true},{"attribute":"waitingRoomCookieDomainType","op":"eq","value":"CUSTOMER"}]}}
`waiting_room_cookie_http_only`	boolean	Applies the `HttpOnly` flag to the waiting room cookie to ensure it's accessed over HTTP and not manipulated by the client.	`waiting_room_cookie_enabled` is `true` AND `waiting_room_cookie_advanced` is `true`	{"displayType":"boolean","tag":"input","type":"checkbox"} {"if":{"op":"and","params":[{"attribute":"enabled","op":"eq","value":true},{"attribute":"waitingRoomCookieEnabled","op":"eq","value":true},{"attribute":"waitingRoomCookieAdvanced","op":"eq","value":true}]}}
`waiting_room_status_code`	number	Specifies the response code for requests sent to the waiting room.		{"displayType":"number","tag":"input","type":"number"} {"if":{"attribute":"enabled","op":"eq","value":true}}
`waiting_room_use_cp_code`	boolean	Allows you to assign a different CP code that tracks any requests that are sent to the waiting room.		{"displayType":"boolean","tag":"input","type":"checkbox"} {"if":{"attribute":"enabled","op":"eq","value":true}}
`waiting_room_cp_code`	object	Specifies a CP code for requests sent to the waiting room. You only need to provide the initial `id`, stripping any `cpc_` prefix to pass the integer to the rule tree. Additional CP code details may reflect back in subsequent read-only data.	`waiting_room_use_cp_code` is `true`	{"displayType":"object","tag":"input","todo":true} {"if":{"attribute":"waitingRoomUseCpCode","op":"eq","value":true}}
`waiting_room_cp_code.cpCodeLimits`	array	Read-only. Describes the current usage limit for the CP code.
`waiting_room_cp_code.createdDate`	integer	Read-only. UNIX epoch timestamp reflecting when the CP code was originally created.
`waiting_room_cp_code.description`	string	Read-only. Additional description for the CP code.
`waiting_room_cp_code.id`	integer	Unique identifier for each CP code. Initially, you get this value when creating a new CP code in PAPI. You can also assign a `cpcodeId` value from the List CP codes operation.
`waiting_room_cp_code.name`	string	Read-only. The name of the CP code you specify as the `cpcodeName` when creating a new CP code in PAPI. You can modify this value with the PUT operation in the CP codes and Reporting Groups API.
`waiting_room_cp_code.products`	array	Read-only. The set of products the CP code is assigned to. This reflects `productId` values you specify when creating a new CP code in PAPI.
`waiting_room_net_storage`	object	Specifies the NetStorage domain for the waiting room page.		{"displayType":"object","tag":"input","todo":true} {"if":{"attribute":"enabled","op":"eq","value":true}}
`waiting_room_net_storage.cpCode`	integer	Identifies a CP code assigned to this storage group.
`waiting_room_net_storage.downloadDomainName`	string	Domain name from which content can be downloaded.
`waiting_room_net_storage.g2oToken`	string	Signature Header Authentication key.
`waiting_room_net_storage.id`	integer	Unique identifier for the storage group.
`waiting_room_net_storage.name`	string	Name of the storage group.
`waiting_room_directory`	string (allows variables)	Specifies the NetStorage directory that contains the static waiting room page, with no trailing slash character.		{"displayType":"string","tag":"input","type":"text"} {"if":{"attribute":"enabled","op":"eq","value":true}}
`waiting_room_cache_ttl`	number (5-30)	Specifies the waiting room page's time to live in the cache, `5` minutes by default.		{"displayType":"number","max":[30],"min":[5],"tag":"input","type":"range"} {"if":{"attribute":"enabled","op":"eq","value":true}}