Test & Debug your Refiner Installation

Testing your Refiner installation in a local or staging environment is a recommended step before deploying Refiner to your production environment.

Our Javascript Client has a built-in Debug Mode which will help you to track down any issues quickly.

Enable Debug Mode

To enable the debug mode, add a ‘#refiner_debug‘ hash to your URL and reload the page.

https://your-app.com#refiner_debug=true

Alternatively, you can also add ‘&refiner_debug=true‘ parameter to your URL.

https://your-app.com?refiner_debug=true

When the Debug Mode is enabled, a Quick Debug Window should appear in your browser as shown below.

The Quick Debug Window gives you some basic information on whether or not our client was installed correctly, if you are identifying your users, and if the client is able to communicate with our servers.

Refiner debug panel

If the Debug Window does not appear, please try reloading the page again.

If the Debug Window still doesn’t appear, our client was most likely not installed correctly. In this case, a next step would be to search for “refiner” in the HTML code of your website or web-app. You should see traces of our client in case it was installed correctly.

Disable Debug Mode

Once enabled, the Debug Mode stays active in your current Browser until you disabled it. Keeping the Debug Mode persistent is helpful when debugging for examples page load triggers.

To disable Debug Mode, you need to set the URL parameter refiner_debug from true to false:

https://your-app.com#refiner_debug=false

Or alternatively:

https://your-app.com?refiner_debug=false

Access Debug Logs in Developer Tools

In addition to showing the Quick Debug Window, enabling Debug Mode will also generate detailed logs. To inspect those logs, you need to open the Developer Tools Console of your browser.

In Google Chrome you can open the Developer Tools with the keyboard shortcut “Option + ⌘ + J” on macOS, or “Shift + CTRL + J” on Windows/Linux.

In Firefox, the Developer Console can be opened with the shortcut “Ctrl + Shift + I” or F12 on Windows and Linux, or “Cmd + Opt + I” on macOS.

Once opened, navigate to the “Console” tab. You should see detailed logs about all important events and data exchanges with our server.

When interacting with our support team, a screenshot of the logs as shown below will be incredible helpful.


Debug Tip #1: Test with a newly opened Incognito Window

Our Javascript client leverages the local storage of your browser to reduce the amount of data that is getting exchanged between the browser and our servers.

For example, our client will detect that a specific “identifyUser” call was already sent to our servers. This is done by storing a hash value in the local storage of your browser.

To avoid any issues related to this mechanism, we recommend to always test Refiner in a newly opened incognito browser window.

Debug Tip #2: Check if users are identified correctly

The Refiner widget can be operated in “Identified Users” and “Anonymous” mode. Our debug window indicates if a user was identified and displays the current user ID.

When you choose to operate Refiner in anonymous mode, please make sure that your survey is a “Website” survey and not a “In-App” survey. The latter only works when you identify your users.

Debug Tip #3: Reset user data in your account to start over

You’ll like run into the situation where you want to test a survey again which you’ve already completed or dismissed.

An easy way to resolve this kind of situation is to delete all data linked to your test user and start with a blank slate.

You have basically two options to do this:

  1. Locate your test user in the user list in your Refiner dashboard. You can easily find your test user by searching for their ID or email. Once located, select and delete it. Deleting the user profile will also delete all linked survey responses.
  2. You can also chose to purge all user data in your Refiner project. Navigate to SETTINGS > ATTRIBUTES and click on “Purge User Data”. This will remove all contact data, including survey responses.

In both cases, don’t forget to open a new incognito window in your browser for further testing. A new incognito window will make sure that no old user data is still stored somewhere in your browser.

Was this helpful? Let us know with a quick a vote