visitorPrioritization


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}}