When users visit your site, AudioEye's monitoring tests the view they are experiencing and returns reporting data about the issues found and fixed on the URL visited. By default, we do not record or reflect the query parameters, query parameter values, or hash (also known as anchors or fragments) values that form part of the URL. Instead, we reflect reporting results against the core URL.
For example, if a customer were to visit https://www.audioeye.com/#getstarted or https://www.audioeye.com?filter=x, the portal would reflect all reporting data collected for these visits under https://www.audioeye.com. This allows us to reflect URLs in your reporting in the way our customers think about the pages within their site.
If however there are cases where your site relies on hashes or query parameters to deliver unique pages to visitors, for example a/b testing or older single-page applications, you may need our monitoring to explicitly track those values.
The following guide describes how to configure your monitoring and reporting to track and reflect hashes or specific query parameters in the URLs visited by customers.
How to Configure Your Report Settings
- Login to the AudioEye portal.
- Click into the dashboard of the site you want to configure.
- Click on the "Site Settings" menu item in the left-hand menu bar.
-
Click on the "Report Configuration" sub-menu item.
-
To enable the collection of URL hash values (also known as anchor or fragment), click on the toggle in the right hand corner of the Site Hashing area.
-
Click "Yes, enable" to continue.
Please note: Report data is processed nightly, so it may take up to 24 hours for your reporting results to reflect the inclusion of hashes in the URLs reflected. Because our reporting results are driven by our monitoring, which relies on user visits, you will also only see hashes reflected once a user has visited a URL with a hash populated.
-
Click into the "Key" field in the Query Keys area.
-
Type in the name of the query parameter key that you want to track.
Example: Your homepage has the following URLs with two possible query parameters: https://mysite.com?product=1234&filer=bestseller. You want to track each different product visited as it fundamentally alters the content delivered to the user, and you want to understand the accessibility or each experience. You would enter product as the key value to track.
-
Click "Add key" to add the query parameter for tracking.
-
Repeat steps 7 through 9 for any additional keys you want to track.
-
If you need to update a key, click on the meatball menu next to the key you want to edit, and then click "Edit key".
-
Click into the input box, update the name of the key and then click "Save" to update it.
-
If you no longer want to track a particular query parameter in URLs moving forward, click on the meatball menu next to the item you want to remove and click "Delete key".
-
Click "Delete" to confirm and remove the key from tracking.
