GuideReference
TrainingSupportCommunity

visitor_​prioritization


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.

OptionTypeDescriptionRequires
enabledboolean

Enables the Visitor Prioritization behavior.

{"displayType":"boolean","tag":"input","type":"checkbox"}
cloudlet_​policyobject

Identifies the Cloudlet policy.

{"displayType":"object","tag":"input","todo":true}
{"if":{"attribute":"enabled","op":"eq","value":true}}
cloudlet_​policy.idnumber

Identifies the Cloudlet.

cloudlet_​policy.namestring

The Cloudlet's descriptive name.

user_​identification_​by_​headersboolean

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_​headersstring 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_​ipboolean

Allows IP addresses to identify users.

{"displayType":"boolean","tag":"input","type":"checkbox"}
{"if":{"attribute":"enabled","op":"eq","value":true}}
user_​identification_​by_​paramsboolean

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_​paramsstring 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}]}}
DYNAMIC

Use the dynamic incoming host header.

CUSTOMER

Use a customer-defined cookie domain.

DYNAMIC

Use the dynamic incoming host header.

CUSTOMER

Use a customer-defined cookie domain.

waiting_​room_​status_​codenumber

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_​codeboolean

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_​codeobject

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.cp​Code​Limitsarray

Read-only. Describes the current usage limit for the CP code.

waiting_​room_​cp_​code.created​Dateinteger

Read-only. UNIX epoch timestamp reflecting when the CP code was originally created.

waiting_​room_​cp_​code.descriptionstring

Read-only. Additional description for the CP code.

waiting_​room_​cp_​code.idinteger

Unique identifier for each CP code. Initially, you get this value when creating a new CP code in PAPI. You can also assign a cpcode​Id value from the List CP codes operation.

waiting_​room_​cp_​code.namestring

Read-only. The name of the CP code you specify as the cpcode​Name 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.productsarray

Read-only. The set of products the CP code is assigned to. This reflects product​Id values you specify when creating a new CP code in PAPI.

waiting_​room_​net_​storageobject

Specifies the Net​Storage domain for the waiting room page.

{"displayType":"object","tag":"input","todo":true}
{"if":{"attribute":"enabled","op":"eq","value":true}}
waiting_​room_​net_​storage.cp​Codeinteger

Identifies a CP code assigned to this storage group.

waiting_​room_​net_​storage.download​Domain​Namestring

Domain name from which content can be downloaded.

waiting_​room_​net_​storage.g2o​Tokenstring

Signature Header Authentication key.

waiting_​room_​net_​storage.idinteger

Unique identifier for the storage group.

waiting_​room_​net_​storage.namestring

Name of the storage group.

waiting_​room_​directorystring (allows variables)

Specifies the Net​Storage 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_​ttlnumber (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}}