Sending Widget Usage Data to Your Analytics Dashboard

We have received many requests from our customers that would like to be able to pass widget usage statistics to their own analytics dashboards like Google Analytics, Tableau, etc. We heard you and are now very happy to announce that this is now possible.

UserWay makes the following widget statistics available:

Widget Open + {Page URL} - Once per session when the widget is opened (until the user reload the page/navigate to a different page and open the widget again)
Accessibility Profile - Every Single Time a Profile is Selected
Accessibility Feature - Every Single Time a Feature/Features are Enabled

You just need to set a PostMessage listener to be able to receive the events.

Details:

UserWay's widget sends PostMessage events with the following event payloads:

Widget opened:

{ 
   "event": "customEvent", 
   "eventCategory": "userway", 
   "eventAction": "widget open", 
   "eventLabel": `${PAGE_URL}` 
}

Accessibility Profile Selected:

{ 
   "event": "customEvent", 
   "eventCategory": "userway", 
   "eventAction": "profile selection",
   "eventLabel": "Motor Impaired" 
}

{ 
   "event": "customEvent", 
   "eventCategory": "userway", 
   "eventAction": "profile selection",
   "eventLabel": "Blind" 
}

{ 
   "event": "customEvent", 
   "eventCategory": "userway", 
   "eventAction": "profile selection",
   "eventLabel": "Color Blind" 
}

{ 
   "event": "customEvent", 
   "eventCategory": "userway", 
   "eventAction": "profile selection",
   "eventLabel": "Dyslexia" 
}

{ 
   "event": "customEvent", 
   "eventCategory": "userway", 
   "eventAction": "profile selection",
   "eventLabel": "Visually-impaired" 
}

{ 
   "event": "customEvent", 
   "eventCategory": "userway", 
   "eventAction": "profile selection",
   "eventLabel": "Cognitive & Learning" 
}

{ 
   "event": "customEvent", 
   "eventCategory": "userway", 
   "eventAction": "profile selection",
   "eventLabel": "Seizure & Epileptic" 
}

{ 
   "event": "customEvent", 
   "eventCategory": "userway", 
   "eventAction": "profile selection",
   "eventLabel": "ADHD" 
}

Accessibility Feature Enabled:

{ 
    "event": "customEvent", 
    "eventCategory": "userway", 
    "eventAction": "ability enablement",
    "eventLabel": "Bigger Text" 
}

{ 
    "event": "customEvent", 
    "eventCategory": "userway", 
    "eventAction": "ability enablement",
    "eventLabel": "Highlight links" 
}

{ 
    "event": "customEvent", 
    "eventCategory": "userway", 
    "eventAction": "ability enablement",
    "eventLabel": "Cursor / Reading Guide" 
}

{ 
    "event": "customEvent", 
    "eventCategory": "userway", 
    "eventAction": "ability enablement",
    "eventLabel": "Tooltips" 
}

{ 
    "event": "customEvent", 
    "eventCategory": "userway", 
    "eventAction": "ability enablement",
    "eventLabel": "Legible fonts" 
}

{ 
    "event": "customEvent", 
    "eventCategory": "userway", 
    "eventAction": "ability enablement",
    "eventLabel": "Page structure" 
}

{ 
    "event": "customEvent", 
    "eventCategory": "userway", 
    "eventAction": "ability enablement",
    "eventLabel": "Line Height" 
}

{ 
    "event": "customEvent", 
    "eventCategory": "userway", 
    "eventAction": "ability enablement",
    "eventLabel": "Text Align" 
}

{ 
    "event": "customEvent", 
    "eventCategory": "userway", 
    "eventAction": "ability enablement",
    "eventLabel": "Dictionary" 
}

{ 
    "event": "customEvent", 
    "eventCategory": "userway", 
    "eventAction": "ability enablement",
    "eventLabel": "Pause Animations" 
}

{ 
    "event": "customEvent", 
    "eventCategory": "userway", 
    "eventAction": "ability enablement",
    "eventLabel": "Hide Images" 
}

{ 
    "event": "customEvent", 
    "eventCategory": "userway", 
    "eventAction": "ability enablement",
    "eventLabel": "Screen Reader" 
}

{ 
    "event": "customEvent", 
    "eventCategory": "userway", 
    "eventAction": "ability enablement",
    "eventLabel": "Contrast" 
}

{ 
    "event": "customEvent", 
    "eventCategory": "userway", 
    "eventAction": "ability enablement",
    "eventLabel": "Smart Contrast" 
}

{ 
    "event": "customEvent", 
    "eventCategory": "userway", 
    "eventAction": "ability enablement",
    "eventLabel": "Saturation" 
}

{ 
    "event": "customEvent", 
    "eventCategory": "userway", 
    "eventAction": "ability enablement",
    "eventLabel": "Text Spacing" 
}

The target pages must set the PostMessage listener to be able to receive these events:

window.addEventListener('message', function (event) { 
    if (event.data.eventCategory === 'userway') { 
        // Custom logic 
     } 
})

Event Listener for enabled features:

Base: userway:feature_enabled_

Name of listener: Base + Feature Code.
For Example: Cursor enabled = userway:feature_enabled_s2

document.addEventListener("userway:feature_enabled_s2", () => { 
        // Custom logic 
});

Event Listener for disabled features:

Base: userway:feature_disabled_

Name of listener: Base + Feature Code.
For Example: Cursor disabled = userway:feature_disabled_s2

document.addEventListener("userway:feature_disabled_s2", () => { 
        // Custom logic 
});

List of feature codes:

     s2 - Cursor
     s3 - Contrast
     s10 - Reading Guide
     s4 - Bigger Text
     s6 - Highlight links
     s7 - Legible fonts
     s9 - Reader
     s11 - Page structure
     s12 - Tooltips
     s13 - Stop Animations
     s14 - Text Spacing
     s15 - Dyslexia Font
     s16 - Reading Mask
     s17 - Line height
     s18 - Smart Contrast
     s19 - Text Align
     s21 - Dictionary
     s23 - Saturation
     s24 - Voice Navigation
     s25 - Hide images
     s101 - Motor Impaired (Profile)
     s102 - Blind Reader (Profile)
     s103 - Color Blind (Profile)
     s104 - Dyslexia (Profile)
     s105 - Visually-impaired (Profile)
     s106 - Cognitive & Learning (Profile)
     s107 - Seizure & Epileptic (Profile)
     s108 - ADHD (Profile)

If you have any questions, you can reach our support team at support@userway.org