Add custom GA4 events to STRR Host application
- Dominant language
- Python
- Stars
- 2
- Forks
- 22
- Avg merge
- 2d 35m
- Merged PRs (30d)
- 11
Description
Configure custom events to track user behaviour in STRR Host Application
### Parameters to include in each event:
- draft: boolean - true if user is resuming a draft application
- page_visit_id: string - unique id per page visit to differentiate multiple page visits by the same user
- account_id: number - users account id, do we want to include this? potential PI issue?
### Events
**strr_host_form_start:**
- triggered on application page mount
- should only be triggered once per page unless user refreshes window
- Extra parameters:
- ?
**strr_host_form_step_1_start:**
- triggered on step 1 start
- may be triggered multiple times as a user navigates through the stepper
- Extra parameters:
- ?
**strr_host_form_step_1_complete:**
- triggered when step 1 has passed validation and user has navigated away from step
- may be triggered multiple times as a user navigates through the stepper
- Extra parameters:
- ?
**strr_host_form_step_2_start:**
- triggered on step 2 start
- may be triggered multiple times as a user navigates through the stepper
- Extra parameters:
- ?
**strr_host_form_step_2_complete:**
- triggered when step 2 has passed validation and user has navigated away from step
- may be triggered multiple times as a user navigates through the stepper
- Extra parameters:
- ?
**strr_host_form_step_3_start:**
- triggered on step 3 start
- may be triggered multiple times as a user navigates through the stepper
- Extra parameters:
- ?
**strr_host_form_step_3_complete:**
- triggered when step 3 has passed validation and user has navigated away from step
- may be triggered multiple times as a user navigates through the stepper
- Extra parameters:
- ?
**strr_host_form_step_4_start:**
- triggered on step 4 start
- may be triggered multiple times as a user navigates through the stepper
- Extra parameters:
- ?
**strr_host_form_step_4_complete:**
- triggered when step 4 has passed validation and user has navigated away from step **OR** user submits form
- may be triggered multiple times as a user navigates through the stepper
- Extra parameters:
- ?
**strr_host_form_submit_success:**
- triggered when user selects 'Submit and Pay' and the form has no frontend or backend errors
- should only be triggered once per page visit
- **does not include if payment was or was not successful**
- Extra parameters:
- payment type?
- ?
**strr_host_form_save_draft:**
- triggered when user selects 'Save Draft'
- may be triggered multiple times per page visit
- Extra parameters:
- ?
**strr_host_form_save_draft_resume:**
- triggered when user selects 'Save and Resume Later'
- should only be triggered once per page visit
- Extra parameters:
- ?
### Extra Events:
**strr_host_form_submit_error_ui:**
- triggered when user selects 'Submit and Pay' and the form has frontend validation errors
- Extra parameters:
- form validation errors?
- ?
**strr_host_form_submit_error_api:**
- triggered when user selects 'Submit and Pay' and api fails for some reason (validation, invoice creation, etc)
- Extra parameters:
- api error?
- ?
**strr_host_form_document_upload:**
- triggered when user uploads a document
- does not include if document was successfully uploaded or not
- Extra parameters:
- document type (would be able to see the most commonly uploaded doc types)
- file type (this may show how often users are trying to upload files other than pdf)
- ?
**strr_host_form_payment_success:**
- triggered when user selects 'Submit and Pay', the form is submitted successfully and the response
from the api comes back as 'PAID' **OR** triggered when user is redirected to the dashboard/application page after cc payment, the page path includes the 'status' query from the payment service and the payment was successful
- Extra parameters:
- payment type
- ?
**strr_host_form_step_navigation:**
- triggered when user navigates stepper
- Extra parameters:
- from_step: // The step the user was on before
- to_step: // The step the user navigated to
Contributor guide
No contributing guide indexed for this repository
Assessment
This issue has not been assessed yet.