Getting started

Priority Protect is DataDome's virtual waiting room. When more visitors arrive than your site can serve, it holds the extra visitors on a waiting room page and lets them in at a pace your servers can handle. It runs in your existing Bot Protect integration: bots are blocked before they reach the waiting room, so the places go to real customers.

How it works

  1. A visitor requests a page that matches one of your waiting rooms.
  2. Bot Protect checks the request first. Malicious bots are blocked and never take a place.
  3. If your site has capacity and nobody is waiting, the visitor reaches your site directly.
  4. Otherwise, the visitor sees the waiting room page, with their position. The page checks their status automatically: they don't need to refresh.
  5. When capacity frees up, waiting visitors are admitted in the order they joined, at the admission rate you set.
  6. Once admitted, the visitor browses your site normally until their session expires.

Two settings drive this behavior:

  • Maximum concurrent visitors is the capacity of your protected pages: how many visitors can browse them at the same time.
  • Admission rate is the flow out of the waiting room: how many waiting visitors are let in per minute when capacity frees up.

To choose their values, see Best practices.

Prerequisites

📘

Priority Protect is an add-on to Bot Protect

It is not enabled on your account by default. Contact your account manager to enable it.

Your DataDome integration must meet these minimum versions. If it is older, upgrade it before you create a waiting room; your Customer Success team can help.

Server-side integrations

PlatformMinimum version
Akamai2.1.0
Apache2.56.0
Bunny1.3.0
Cloudflare2.3.0
CloudFront (Node.js)1.26.0
CloudFront (Python)1.5.0
Envoy2.6.0
F51.10.0
Fastly2.28.0
Go2.4.0
Google Cloud Load Balancer1.6.0
HAProxy (Lua)1.4.0
IIS3.4.0
Java2.4.0
Magento1.2.244
Nginx2.51.0
Node.js2.5.0
Traefik1.2.0

Mobile SDKs

Needed only if your app calls pages or APIs that a waiting room protects.

PlatformMinimum version
iOS3.8.5
Android3.0.7
React Native + Fetch2.0.4
React Native + SuperAgent1.2.1
React Native + Navigation1.1.1
Flutter + Dio3.4.1

Create your first waiting room

  1. In the DataDome Dashboard, go to Priority Protect > Priorities and click Create a waiting room.

  2. Type: choose Time-Based for an event with a start time, or Always on to protect pages all year round. Click Next.

  3. Settings: give it a name and a rank, set Maximum Concurrent Visitors and Admission Rate, and write the Matching Condition that selects the pages to protect. For a Time-Based waiting room, set the start and end dates.

  4. Click Create a waiting room. It usually applies on your site within a minute.

👍

See the waiting room page right away

Create the waiting room on a test URL with Maximum concurrent visitors set to 0. Every visitor of that URL then sees the waiting room page.

Every setting is described in Waiting room.

Key terms

TermMeaning
Waiting roomA set of rules that holds visitors of some pages when those pages are full. In the Dashboard and the API, a waiting room is also called a priority
Matching conditionThe pages or requests the waiting room applies to, for example domain:shop.example.com AND url:/sale*
Maximum concurrent visitorsHow many visitors can browse the protected pages at the same time
Admission rateHow many waiting visitors are let in per minute
Session inactivity timeoutHow long an admitted visitor keeps their place without making a request
RankWhich waiting room applies when several match the same request. The lowest number wins
Pre-admissionA period before the start of a time-based waiting room when visitors can already join it
Direct accessTraffic that skips the waiting room: verified bots, and traffic allowed by your custom rules
Testing tokenA secret link parameter that lets your team skip a waiting room for tests

Next steps

  • Waiting room: every setting, and what happens when you change, deactivate or delete a waiting room.
  • Custom templates: show your own branded waiting room page.
  • Metrics: follow your waiting room live and after the event.
  • Best practices: values to start with, testing, and what to do during an event.

FAQ

Visitors don't see the waiting room. Why?

Check, in this order:

  1. Is your site below capacity? This is the most common reason, and it is normal. Visitors only wait when Maximum concurrent visitors is reached. Check Active visitors in Metrics.
  2. Is the waiting room activated, and for a time-based waiting room, are you between its start and end dates (or in its pre-admission)?
  3. Does the matching condition match the URL? Check the domain, the path and its variants (language prefix, trailing slash). Add * at the end of a path to match everything that starts with it.
  4. Does another waiting room with a lower rank match the same URL? Only one waiting room applies per request.
  5. Was it created or changed less than a minute ago? Wait a minute and try again.
  6. Does your integration meet the minimum version? See Prerequisites.

What happens to bots?

Bot Protect checks every request before Priority Protect. Malicious bots are blocked or challenged and never enter the waiting room. Verified bots, such as search engine crawlers, can skip the waiting room if you turn on Direct access > Verified bots.

Which languages does the waiting room page support?

The default page is available in more than 100 languages. It uses the language of the visitor's browser automatically. A custom template is shown as you write it: write it in one language, or add your own script to translate it.


Did this page help you?