Add GA4 tracking for search autocomplete #4371
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
csutter
force-pushed
the
autocomp-track
branch
from
199bbb1
to
ba46736
Compare
kevindew
reviewed
Nov 6, 2024
app/assets/javascripts/govuk_publishing_components/components/search-with-autocomplete.js
Outdated
Show resolved
Hide resolved
| 'my favourite album is folklore', | ||
| 'my favourite album is reputation', | ||
| 'my favourite album is 1989' | ||
| ]) |
There was a problem hiding this comment.
Had not realised you were a swiftie 😁
There was a problem hiding this comment.
Oh you'll enjoy the Finder Frontend search tests 😂 I've almost crowded out @sihugh's Harry Potter references!
csutter
force-pushed
the
autocomp-track
branch
from
ba46736
to
c5c7583
Compare
This adds a set of tracking attributes to the `search_with_autocomplete` component, which will be able to be picked up by the GA4 search tracker to measure user interaction with the autocomplete component. In particular, this adds: - `autocomplete-trigger-input`: the original, possibly partial, input from the user that triggered the offered suggestions - `autocomplete-accepted`: whether the user has accepted a suggestion (as opposed to dismissed the autocomplete with Escape or clicking outside) - `autocomplete-suggestions`: a string containing a pipe-separated list of the (up to) five top suggestions offered - `autocomplete-suggestions-count`: the total number of suggestions offered
This uses the new analytics data attributes that we set in the `search_with_autocomplete` component to enhance the `search` event we send to GA4 with autocomplete usage data.
These have been agreed on for the autocomplete tracking.
csutter
force-pushed
the
autocomp-track
branch
from
c5c7583
to
03834fe
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What
This PR:
search_with_autocompletecomponentGa4SearchTrackerto pick them up as part of thesearcheventsearchevent fieldsWhy
We will soon be going live with autocomplete for site search on GOV.UK and need to track user interactions to see if it works as intended.
See measurement approach document (internal) for details on why we're measuring what we're measuring, and the approach taken.