Tracking the use of Eye-Able Services on your website
How can I set up tracking for the use of Eye-Able Software on my website?
Eye-Able Software does not track user interactions directly, but it does offer the option of using existing tracking software such as Google Analytics. As soon as certain functions are activated in Eye-Able, a custom JavaScript event ("eyeable:event") is triggered, which can be forwarded to the tracking software. This article explains how to set up tracking for the use of Eye-Able Software on your website.
Important notes on data security
Please respect the data security regulations of your users. Information about which Eye-Able functions are used is particularly sensitive when combined with user identification. Make sure to comply with the applicable data security laws. Eye-Able assumes no liability for any data security breaches.
Versions and updates
- Eye-Able Assist: Make sure your Eye-Able Assist version is higher than 1.13.0 to use all new functions, such as "Disable Events" and "Toolbar_Opened_CustomIcon" when using a custom button.
- Eye-Able Translate: The version should be at least 3.1 to support all new events
Tracking with Google Analytics
To send Eye-Able events to Google Analytics, insert the following code into the header section of your website and adjust the Google Analytics tracking ID:
// Load Google Analytics
(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){(i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date(); a = s.createElement(o),m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)})(window,document,'script','https://www.google-analytics.com/analytics.js','ga');
// Insert your own Google Analytics tracking ID
const gaID = "UA-XXXXX-X";
// Set up the connection
ga('create', gaID, 'auto');
// Register Eye-Able events
document.addEventListener("eyeable:event", function (e) {
if(e.detail){
ga('send', {
hitType: 'event',
eventCategory: 'Eye Able Event',
eventAction: 'Funktion',
eventLabel: e.detail // The function used is displayed here
});
}
});
This code sends Eye-Able events to your Google Analytics account. These events can be processed and analysed in the Google Analytics Dashboard. The eventLabel contains information about which function was called.
Tracking with other tracking tools
The Google Analytics code shown above can also be adapted for other tracking software. If you use a different framework, you can replace the function call ga('send', ...) with the corresponding function of your tracking software. For Matomo, you can find detailed instructions in the article "Using event tracking with Matomo"
Available events for tracking
The following events can be used in Eye-Able for tracking:
Eye-Able Assist - Available events
| Event name | Description |
|---|---|
| Toolbar_Opened | The Toolbar was opened . |
| Active_Settings_At_PageLoad | Triggered when an Assist setting is active at page load. Can be used to count active visitors. |
| One_Click_Mode | The instant view button was pressed. |
| Adaptive_Zoom_Change | A change or initialisation of the adaptive zoom took place. |
| Adaptive_Zoom_Disabled | The zoom was disabled. |
| Darkmode_Enabled | Dark mode was enabled. |
| Darkmode_Disabled | Dark mode was disabled. |
| Contrast_Enabled | Contrast mode was enabled or changed. |
| Contrast_Disabled | Contrast mode was disabled. |
| Bluefilter_Enabled | The blue light filter was enabled. |
| Bluefilter_Disabled | The blue light filter was disabled. |
| Bluefilter_Adjusted | The blue light filter was adjusted. |
| Screenreader_Enabled | The screen reader was enabled. |
| Screenreader_Disabled | The screen reader was disabled. |
| Key_Navigation_Enabled | Only keyboard navigation without the screen reader was enabled. |
| Key_Navigation_Disabled | Only keyboard navigation without the screen reader was disabled. |
| CVD_Filter_Enabled | The colour correction filter was enabled. |
| CVD_Filter_Disabled | The colour correction filter was disabled. |
| CVD_Filter_Adjusted | The colour correction filter was adjusted. |
| Hide_Images_Enabled | Hiding images was enabled. |
| Hide_Images_Disabled | Hiding images was disabled. |
| Big_Cursor_Enabled | The large cursor was enabled. |
| Big_Cursor_Disabled | The large cursor was disabled. |
| Font_Enabled | The accessible font was enabled. |
| Font_Disabled | The accessible font was disabled. |
| Animations_Disabled | Animations were disabled. |
| Animations_Enabled | Animations were enabled. |
| Mute_Audio_Enabled | Sound was disabled. |
| Mute_Audio_Disabled | Sound was enabled. |
Eye-Able Translate - Available events
| Event name | Description |
|---|---|
| eyeable:translation_failure | An error occurred during translation |
| eyeable:translate | A text was successfully translated. |
| eyeable:plainLanguage | Plain Language mode was enabled. |
Parameters for Eye-Able Translate events
| Parameter name | Description |
|---|---|
| tarLang | The target language into which the text was translated. |
| originalLang | The source language of the website from which the translation was performed. |
| timestamp | The current timestamp of the event. |
| website | The URL of the current page. |
| message | In case of an error: the error message. |
| status | The error status (only in case of a translation error). |
| lang | The current language of the website (only for "eyeable:plainLanguage"). |
Frequently asked questions (FAQ)
- Question: How do I send Eye-Able events to another tracking tool?
Answer: The Google Analytics code can be adapted for any event-based tracking tool. Replace the functionga('send', ...)with the corresponding function of your tracking software. - Question: What should I do if I have problems with tracking?
Answer: Please contact Support. You can find contact options in this article: Contact details for customers and interested parties