Analytics event: BACK_TO_TOP

[fcoveram]

Description

The UI component assumes that users need to go back to the top part of Openverse interface, and this change would help us to understand whether that is true or if any other action derivates from this search flow.

Steps:

1. Add BACK_TO_TOP to the Events type:

   openverse/frontend/src/types/analytics.ts

   Line 12 in 839418f

   export type Events = {

   • Add query and page payload for the query term and requested page depth respectively. Additionally, scrolledPixels derived from document.getElementById('main-page').scrollTop (or, preferably a Vue ref on that element instead) and similarly maxScroll derived from .scrollTopMax off the same #main-page element.
2. Fire the event using the useAnalytics composable when the back to top button is clicked. It should be added to https://github.com//WordPress/openverse/blob/HEAD/frontend/src/components/VScrollButton.vue#L47-L50

Additional context

Screenshot of the UI component mentioned

Additional information

• RFC
• Example usage in VHomeGallery.vue

[dhruvkb]

Added the "🧹 status: ticket work required" label to convert the issue into the same format as the other Analytics event PRs.

[nevvada]

hi @fcoveram, i'd be interested in working on this!

curious, what should we track in this event? i was thinking:

• search type
• query/search term
• result page

[fcoveram]

Great, more than welcome. I will refer to @sarayourfriend as I think added the technical info in the main comment.

[sarayourfriend]

Search type does not need to be stored in the payload, it can be inferred from the path (/search is all, /search/image is images, etc).

query and page would make sense, though 👍 I'll update the issue description.

[sarayourfriend]

The description is updated with the payload parameters to add and I've assigned the issue to you @nevvada. Let us know if you need any help 👍