visitor_prioritization

Suggest Edits

Version: `v2025-01-13`	Includes use: No

Behavior name: Visitor Prioritization Cloudlet

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.

Default behavior

These samples reflect the behavior's default settings. You can use these as is in your configurations or make adjustments based on the behavior's available options.

data "akamai_property_rules_builder" "visitor_prioritization" {
  rules_v2025_02_18 {
    name     = "Visitor Prioritization Cloudlet"
    comments = "Decreases abandonment by providing a user-friendly waiting room experience."
    behavior {
      visitor_prioritization {
        enabled: true
        cloudletPolicy = ""
        user_identification_by_cookie  = false
        user_identification_by_headers = false
        user_identification_by_ip      = false
        user_identification_by_params  = false
        allowed_user_cookie_enabled    = true
        allowed_user_cookie_label      = ""
        allowed_user_cookie_duration   = 300
        allowed_user_cookie_refresh    = true
        allowed_user_cookie_advanced   = false
        waiting_room_cookie_enabled    = true
        waiting_room_cookie_shareLabel = true
        waiting_room_cookie_duration   = 30
        waiting_room_cookie_advanced   = false
        waiting_room_status_code       = 200
        waiting_room_use_cp_code       = false
        waiting_room_net_storage       = ""
        waiting_room_directory         = ""
        waiting_room_cache_ttl         = 5
      }
    }
  }
}

"behaviors": [
  {
    "name": "visitorPrioritization",
    "options": {
      "enabled": true,
      "cloudletPolicy": "",
      "userIdentificationByCookie": false,
      "userIdentificationByHeaders": false,
      "userIdentificationByIp": false,
      "userIdentificationByParams": false,
      "allowedUserCookieEnabled": true,
      "allowedUserCookieLabel": "",
      "allowedUserCookieDuration": 300,
      "allowedUserCookieRefresh": true,
      "allowedUserCookieAdvanced": false,
      "waitingRoomCookieEnabled": true,
      "waitingRoomCookieShareLabel": true,
      "waitingRoomCookieDuration": 30,
      "waitingRoomCookieAdvanced": false,
      "waitingRoomStatusCode": 200,
      "waitingRoomUseCpCode": false,
      "waitingRoomNetStorage": "",
      "waitingRoomDirectory": "",
      "waitingRoomCacheTtl": 5
    }
  }
]

Options

Option	Description
`enabled`	Boolean Enables the Visitor Prioritization behavior.
`cloudlet_policy`	Object Identifies the Cloudlet policy. Contains: `id`. Identifies the Cloudlet. `name`. The Cloudlet's descriptive name.
`user_identification_by_cookie`	Boolean When enabled, identifies users by the value of a cookie.
`user_identification_key_cookie`	String \| Requires: `user_identification_by_cookie` is `true` 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_headers`	Boolean When enabled, identifies users by the values of GET or POST request headers.
`user_identification_key_headers`	String array \| Requires: `user_identification_by_headers` is `true` 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_ip`	Boolean Allows IP addresses to identify users.
`user_identification_by_params`	Boolean When enabled, identifies users by the values of `GET` or `POST` request parameters.
`user_identification_key_params`	String array \| Requires: `user_identification_by_params` is `true` 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.
`allowed_user_cookie_enabled`	Boolean Sets a cookie for users who have been allowed through to the site.
`allowed_user_cookie_label`	String \| Requires: `allowed_user_cookie_enabled` is `true` 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_duration`	Number \| Requires: `allowed_user_cookie_enabled` is `true` Sets the number of seconds for the allowed user's session once allowed through to the site. Value range is `0`-`600`.
`allowed_user_cookie_refresh`	Boolean \| Requires: `allowed_user_cookie_enabled` is `true` 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_advanced`	Boolean \| Requires: `allowed_user_cookie_enabled` is `true` Sets advanced configuration options for the allowed user's cookie.
`allowed_user_cookie_automatic_salt`	Boolean \| Requires Requires both are `true`: `allowed_user_cookie_enable` `allowed_user_cookie_advanced` 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_salt`	String \| Requires Requires all: `allowed_user_cookie_enabled` is `true` `allowed_user_cookie_advanced` is `true` `allowed_user_cookie_automatic_advanced` is `false` 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_domain_type`	Enum \| Requires Requires all are `true`: `allowed_user_cookie_enabled` `allowed_user_cookie_advanced` Specify with `allowed_user_cookie_advanced` enabled. Value is one of: `DYNAMIC`. Use the dynamic incoming host header. `CUSTOMER`. Use a customer-defined cookie domain.
`allowed_user_cookie_domain`	String \| Requires Requires all: `allowed_user_cookie_enabled`, `allowed_user_cookie_advanced` and `allowed_user_cookie_automatic_advanced` are `true` `allowed_user_cookie_domain_type` is `CUSTOMER` Specifies a domain for an allowed user cookie.
`allowed_user_cookie_http_only`	Boolean \| Requires Requires both are `true`: `allowed_user_cookie_enabled` `allowed_user_cookie_advanced` Applies the `HttpOnly` flag to the allowed user's cookie to ensure it's accessed over HTTP and not manipulated by the client.
`waiting_room_cookie_enabled`	Boolean Enables a cookie to track a waiting room assignment.
`waiting_room_cookie_share_label`	Boolean \| Requires Requires both are `true`: `waiting_room_cookie_enabled` `allowed_user_cookie_advanced` Enabling this option shares the same `allowed_user_cookie_label` string. If disabled, specify a different `waiting_room_cookie_label`.
`waiting_room_cookie_label`	String \| Requires: `waiting_room_cookie_enabled` is `true` 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_duration`	Number \| Requires: `waiting_room_cookie_enabled` is `true` 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. Value range is `0`-`120`.
`waiting_room_cookie_advanced`	Boolean \| Requires: `waiting_room_cookie_enabled` is `true` When enabled along with `waiting_room_cookie_enabled` sets advanced configuration options for the waiting room cookie.
`waiting_room_cookie_automatic_salt`	Boolean \| Requires Requires both are `true`: `waiting_room_cookie_enabled` `waiting_room_cookie_advanced` 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_salt`	String \| Requires Requires both: `waiting_room_cookie_enabled` and `waiting_room_cookie_advanced` are `true` `waiting_room_cookie_automatic_salt` is `false` 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_domain_type`	Enum \| Requires Requires both are `true`: `waiting_room_cookie_enabled` `waiting_room_cookie_advanced` Sets the domain type. Value is one of: `DYNAMIC`. Use a dynamic incoming host header. `CUSTOMER`. Use a customer-defined cookie domain.
`waiting_room_cookie_domain`	String \| Requires Requires both: `waiting_room_cookie_enabled` and `waiting_room_cookie_advanced` are `true` `waiting_room_cookie_domain_type` is `CUSTOMER` Specifies a domain for the waiting room cookie.
`waiting_room_cookie_http_only`	Boolean \| Requires Requires both are `true`: `waiting_room_cookie_enabled` `waiting_room_cookie_advanced` Applies the `HttpOnly` flag to the waiting room cookie to ensure it's accessed over HTTP and not manipulated by the client.
`waiting_room_status_code`	Number Specifies the response code for requests sent to the waiting room.
`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.
`waiting_room_cp_code`	Object \| Requires: `waiting_room_use_cp_code` is `true` Specifies a CP code for requests sent to the waiting room. Contains only an `id` property with your CP code as the value.
`waiting_room_net_storage`	Object Specifies the NetStorage domain for the waiting room page. Contains: `cp_code`. Identifies a CP code assigned to this storage group. `download_domain_name`. Domain name from which content can be downloaded. `g2o_token`. Signature Header Authentication key.
`waiting_room_directory`	String Specifies the NetStorage directory that contains the static waiting room page, with no trailing slash character.
`waiting_room_cache_ttl`	String Specifies the waiting room page's time to live in the cache in minutes. Value range is `5`-`30`. The default is `5`.

Updated about 1 hour ago