Set up CrazyEgg recordings to track user visits on v2 Benefit Finder

nickpistone commented 7 months ago

Description

In order to record pages using the USAGov CrazyEgg account, a script needs to be added to the head of the pages. (window.CE_API || (window.CE_API=[])).push(function(){ CE2.startRecording(); });

This script will trigger the visitor recording. Things to consider/questions:

We recorded pages on the beta without using any script (will it work if we try it without the script or was that because we were under a different CrazyEgg domain with different settings?)
Can we use GTM to inject the script so we don't have to wait out the code freeze?
Is there a way we can block ourselves from being recorded? We only have 500 recordings per month for all of USA.gov and Search.gov combined, so we have been granted about 100 recordings for December.

Nick P has been talking to Nicole Brennan and that's where the info and approval has come from.

User Story

No response

Architectural Decision Records (ADRs)

No response

nickpistone commented 7 months ago

Setting the effort at a 4 because there are still some questions to answer (noted in description) and it may require some dev work. I think it's worth a medium-high priority because it gives us a deeper level of insight into real-world users than we can get in any other way.

nickpistone commented 7 months ago

I set it as blocked until I can figure out how we can get the script on the page and if we even need it

nickpistone commented 5 months ago

Nicole Brennan set up snapshots but no data is coming in yet. Need to check back tomorrow and troubleshoot if there is still no data.

erniedeeb commented 5 months ago

This is working on the landing pages but the snippet still needs to be added to the head of the application pages in both EN/ES. The content team cannot make this change because these pages don't have a head field in the CMS (related issue).

erniedeeb commented 5 months ago

Please let me know when this item has been moved into production so I can ask USA.gov to confirm it's working as expected.

fongcindy commented 4 months ago

Went to dev today 2/20, in stage Thurs 2/22, in prod by next Tues 2/27. Crazyegg should be set up and ready on 2/27

nickpistone commented 4 months ago

Tried to test this today, but the USAGov CrazyEgg account has reached its limit for the month and can't record any new visits until tomorrow (March 1). We need to coordinate with other account users to figure out how much of the 250k pageviews/month we can use for our heatmaps. Between English and Spanish and desktop and mobile snapshots, we could have 8 snapshots running at a time. And these snapshots will only show the start view, but they will capture clicks throughout the tool. So until we set up custom code to distinguish between the pages, we won't be able to really see the full heatmap. But the screen recording videos should work.

nickpistone commented 4 months ago

Tested CrazyEgg installation today and it says that it's missing the tracking script.

erniedeeb commented 4 months ago

The dev work added the head field in the CMS, not the code directly. I just added the crazyegg script to all life events except DOLO EN (https://cms.usa.gov/node/1978/edit), which is locked by Scott so I can't make any updates to it. @scottqueen-bixal Can you close this tab on your machine on Monday? I'll make the update then.

erniedeeb commented 4 months ago

Just addressed the above and the snippet should be present on life events in EN/ES.

nickpistone commented 4 months ago

We are getting a few recordings. There is a sampling rate set up to not track too many visits and balance it with other GSA sites, so the recordings are coming in slowly.

GSA / px-benefit-finder