growthAnalyticsEvents.tsx 3.9 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103
  1. import {PlatformKey} from 'app/data/platformCategories';
  2. type MobilePromptBannerParams = {
  3. matchedUserAgentString: string;
  4. };
  5. type ShowParams = MobilePromptBannerParams & {
  6. matchedUserAgentString: string;
  7. mobileEventBrowserName: string;
  8. mobileEventClientOsName: string;
  9. };
  10. type PlatformParam = {
  11. platform: PlatformKey;
  12. };
  13. type PlatformCategory = {
  14. category: string;
  15. source?: string;
  16. };
  17. type PlatformPickerParam = {
  18. platform_id: string;
  19. source?: string;
  20. };
  21. type PlatformSearchParam = {
  22. search: string;
  23. num_results: number;
  24. source?: string;
  25. };
  26. type SampleEventParam = {
  27. platform?: PlatformKey;
  28. };
  29. type InviteRequestParam = {
  30. member_id: number;
  31. invite_status: string;
  32. };
  33. // define the event key to payload mappings
  34. export type GrowthEventParameters = {
  35. 'growth.show_mobile_prompt_banner': ShowParams;
  36. 'growth.dismissed_mobile_prompt_banner': MobilePromptBannerParams;
  37. 'growth.opened_mobile_project_suggest_modal': MobilePromptBannerParams;
  38. 'growth.clicked_mobile_prompt_setup_project': MobilePromptBannerParams;
  39. 'growth.clicked_mobile_prompt_ask_teammate': MobilePromptBannerParams;
  40. 'growth.submitted_mobile_prompt_ask_teammate': MobilePromptBannerParams;
  41. 'growth.demo_click_get_started': {is_upgrade: boolean};
  42. 'growth.demo_click_docs': {};
  43. 'growth.demo_click_request_demo': {};
  44. 'growth.onboarding_load_choose_platform': {};
  45. 'growth.onboarding_set_up_your_project': PlatformParam;
  46. 'growth.select_platform': PlatformPickerParam;
  47. 'growth.platformpicker_category': PlatformCategory;
  48. 'growth.platformpicker_search': PlatformSearchParam;
  49. 'growth.onboarding_start_onboarding': {};
  50. 'growth.onboarding_take_to_error': {};
  51. 'growth.onboarding_view_full_docs': {};
  52. 'growth.onboarding_view_sample_event': SampleEventParam;
  53. 'invite_request.approved': InviteRequestParam;
  54. 'invite_request.denied': InviteRequestParam;
  55. 'growth.demo_modal_clicked_signup': {};
  56. 'growth.demo_modal_clicked_continue': {};
  57. 'growth.sample_transaction_docs_link_clicked': {
  58. project_id: string;
  59. };
  60. };
  61. type GrowthAnalyticsKey = keyof GrowthEventParameters;
  62. export const growthEventMap: Record<GrowthAnalyticsKey, string> = {
  63. 'growth.show_mobile_prompt_banner': 'Growth: Show Mobile Prompt Banner',
  64. 'growth.dismissed_mobile_prompt_banner': 'Growth: Dismissed Mobile Prompt Banner',
  65. 'growth.opened_mobile_project_suggest_modal':
  66. 'Growth: Open Mobile Project Suggest Modal',
  67. 'growth.clicked_mobile_prompt_setup_project':
  68. 'Growth: Clicked Mobile Prompt Setup Project',
  69. 'growth.clicked_mobile_prompt_ask_teammate':
  70. 'Growth: Clicked Mobile Prompt Ask Teammate',
  71. 'growth.submitted_mobile_prompt_ask_teammate':
  72. 'Growth: Submitted Mobile Prompt Ask Teammate',
  73. 'growth.demo_click_get_started': 'Growth: Demo Click Get Started',
  74. 'growth.demo_click_docs': 'Growth: Demo Click Docs',
  75. 'growth.demo_click_request_demo': 'Growth: Demo Click Request Demo',
  76. 'growth.onboarding_load_choose_platform':
  77. 'Growth: Onboarding Load Choose Platform Page',
  78. 'growth.onboarding_set_up_your_project': 'Growth: Onboarding Click Set Up Your Project',
  79. 'growth.select_platform': 'Growth: Onboarding Choose Platform',
  80. 'growth.platformpicker_category': 'Growth: Onboarding Platform Category',
  81. 'growth.platformpicker_search': 'Growth: Onboarding Platform Search',
  82. 'growth.onboarding_start_onboarding': 'Growth: Onboarding Start Onboarding',
  83. 'growth.onboarding_take_to_error': 'Growth: Onboarding Take to Error',
  84. 'growth.onboarding_view_full_docs': 'Growth: Onboarding View Full Docs',
  85. 'growth.onboarding_view_sample_event': 'Growth: Onboarding View Sample Event',
  86. 'invite_request.approved': 'Invite Request Approved',
  87. 'invite_request.denied': 'Invite Request Denied',
  88. 'growth.demo_modal_clicked_signup': 'Growth: Demo Modal Clicked Signup',
  89. 'growth.demo_modal_clicked_continue': 'Growth: Demo Modal Clicked Continue',
  90. 'growth.sample_transaction_docs_link_clicked':
  91. 'Growth: Sample Transacton Docs Link Clicked',
  92. };