API

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