[HCA DX] Track clicks on export request buttons

[MillenniumFalconMechanic]

Need

We need to track clicks on export buttons such as "Request Link" for export to Terra, and "Prepare Manifest" for file manifest.

Approach

Investigate reuse of curl download event. See comments below for approach.

Definition of Done

curl Command

• [ ] data.humancellatlas.org - GA4
• [ ] data.humancellatlas.dev.clevercanary.com - GA4

File Manifest

• [ ] data.humancellatlas.org - GA4
• [ ] data.humancellatlas.dev.clevercanary.com - GA4

Export to Terra

• [ ] data.humancellatlas.org - GA4
• [ ] data.humancellatlas.dev.clevercanary.com - GA4

[jpaten]

Hi @MillenniumFalconMechanic! I took a look through the existing bulk_download_requested event, and I think it could be reused, but I found several issues that would need to be considered:

• A new parameter for export_type would need to be added, containing info about the tool being used (e.g. curl_command, terra, etc.)
• The current_query parameter contains the full JSON query, but frequently gets cut off due to GA4's character limits. This could be addressed by instead passing a parameter containing only the options selected on the export form (e.g. file format, species) and extracting the selected filter from the fullPageUrl dimension, which is collected by default and has a much higher character limit, since the filter is included in the URL.
• The existing event would not be useful for backpage exports, since the event does not contain any info about the ID of the selected project/workspace but does include info about the entity the export is being made from in the index field. It would probably make sense to create a new event to track backpage exports
• The existing parameter for index could be renamed to entity_name, to match other events
• The tool_name parameter, which has a value of either bash or cmd.exe, only makes sense for Curl downloads. It could be deprecated or passed a null value for other tools
• The catalog parameter may not be useful since events are already tracked separately for different sites, and it may be worth deprecating.

Let me know if you what you think about this, and I can make a findable ticket to add these changes and call the event on other existing events

[MillenniumFalconMechanic]

• Model exports separately (e.g. build_download_requested, file_manifest_requested.
• Use page URL rather than current_query.
• Back pages will have a separate event.
• No custom params/dimensions for Species, File Type, Download Format etc.
• Remove catalog param.
• Make tool_name optional?
• Update index to entity_name.