Skip to content

The easy-to-use open source Business Intelligence and Embedded Analytics tool that lets everyone work with data :bar_chart:

Make simple events extensible (#71631)

Fraser8322959c37ae
diff --git a/enterprise/frontend/src/metabase-enterprise/data-studio/library/tables/analytics.ts b/enterprise/frontend/src/metabase-enterprise/data-studio/library/tables/analytics.ts
index efbc96eb608..2ab5d15770f 100644
--- a/enterprise/frontend/src/metabase-enterprise/data-studio/library/tables/analytics.ts
+++ b/enterprise/frontend/src/metabase-enterprise/data-studio/library/tables/analytics.ts
@@ -1,5 +1,5 @@
import { trackSimpleEvent } from "metabase/lib/analytics";
-import type { MetadataEditEventDetail } from "metabase-types/analytics";
+import type { MetadataEditEventDetail } from "metabase/metadata/pages/shared/analytics";
export function trackMetadataChange(detail: MetadataEditEventDetail) {
trackSimpleEvent({
diff --git a/enterprise/frontend/src/metabase-enterprise/google_drive/analytics.ts b/enterprise/frontend/src/metabase-enterprise/google_drive/analytics.ts
index 518d46a129d..94d2a7948d3 100644
--- a/enterprise/frontend/src/metabase-enterprise/google_drive/analytics.ts
+++ b/enterprise/frontend/src/metabase-enterprise/google_drive/analytics.ts
@@ -1,5 +1,4 @@
import { trackSimpleEvent } from "metabase/lib/analytics";
-import type { GsheetsConnectionClickedEvent } from "metabase-types/analytics";
export function trackSheetImportClick() {
trackSimpleEvent({
@@ -11,7 +10,7 @@ export function trackSheetImportClick() {
export function trackSheetConnectionClick({
from,
}: {
- from: GsheetsConnectionClickedEvent["triggered_from"];
+ from: "db-page" | "add-data-modal";
}) {
trackSimpleEvent({
event: "sheets_connection_clicked",
diff --git a/enterprise/frontend/src/metabase-enterprise/table-editing/table-edit/analytics.ts b/enterprise/frontend/src/metabase-enterprise/table-editing/table-edit/analytics.ts
index 3f5ef63df62..0130c485299 100644
--- a/enterprise/frontend/src/metabase-enterprise/table-editing/table-edit/analytics.ts
+++ b/enterprise/frontend/src/metabase-enterprise/table-editing/table-edit/analytics.ts
@@ -1,25 +1,21 @@
import { trackSimpleEvent } from "metabase/lib/analytics";
-import type { ValidateEvent } from "metabase-types/analytics";
-
-type TableEditingRecordModifiedEvent = ValidateEvent<{
- event: "edit_data_record_modified";
- event_detail: "create" | "update" | "delete";
- target_id: number;
- triggered_from: "inline" | "modal";
- result: "success" | "error";
-}>;
export const trackDataRecordModified = ({
event_detail,
target_id,
triggered_from,
result,
-}: Omit<TableEditingRecordModifiedEvent, "event">) => {
+}: {
+ event_detail: "create" | "update" | "delete";
+ target_id: number;
+ triggered_from: "inline" | "modal";
+ result: "success" | "error";
+}) => {
trackSimpleEvent({
event: "edit_data_record_modified",
- event_detail: event_detail,
- target_id: target_id,
- triggered_from: triggered_from,
+ event_detail,
+ target_id,
+ triggered_from,
result,
});
};
diff --git a/frontend/src/metabase-types/analytics/event.ts b/frontend/src/metabase-types/analytics/event.ts
index 710d31167c2..a57bec3d2d0 100644
--- a/frontend/src/metabase-types/analytics/event.ts
+++ b/frontend/src/metabase-types/analytics/event.ts
@@ -1,19 +1,4 @@
-import type { FormLocation } from "metabase/databases/types";
-import type {
- ChecklistItemCTA,
- ChecklistItemValue,
-} from "metabase/home/components/Onboarding/types";
-import type { KeyboardShortcutId } from "metabase/palette/shortcuts";
-import type { ClickActionSection } from "metabase/visualizations/types";
-import type {
- ConcreteTableId,
- Engine,
- RelatedDashboardXRays,
- TransformId,
- VisualizationDisplay,
-} from "metabase-types/api";
-
-type SimpleEventSchema = {
+export type SimpleEventSchema = {
event: string;
target_id?: number | null;
triggered_from?: string | null;
@@ -21,816 +6,3 @@ type SimpleEventSchema = {
result?: string | null;
event_detail?: string | null;
};
-
-export type ValidateEvent<
- T extends SimpleEventSchema &
- Record<Exclude<keyof T, keyof SimpleEventSchema>, never>,
-> = T;
-
-export type CustomSMTPSetupClickedEvent = ValidateEvent<{
- event: "custom_smtp_setup_clicked";
- event_detail: "self-hosted" | "cloud";
-}>;
-
-export type CustomSMTPSetupSuccessEvent = ValidateEvent<{
- event: "custom_smtp_setup_success";
- event_detail: "self-hosted" | "cloud";
-}>;
-
-type CSVUploadClickedEvent = ValidateEvent<{
- event: "csv_upload_clicked";
- triggered_from: "add-data-modal" | "collection";
-}>;
-
-type DatabaseAddClickedEvent = ValidateEvent<{
- event: "database_add_clicked";
- triggered_from: "db-list";
-}>;
-
-type DatabaseEngineSelectedEvent = ValidateEvent<{
- event: "database_setup_selected";
- event_detail: Engine["driver-name"];
- triggered_from: "add-data-modal";
-}>;
-
-type OnboardingChecklistOpenedEvent = ValidateEvent<{
- event: "onboarding_checklist_opened";
-}>;
-
-type OnboardingChecklistItemExpandedEvent = ValidateEvent<{
- event: "onboarding_checklist_item_expanded";
- triggered_from: ChecklistItemValue;
-}>;
-
-type OnboardingChecklistItemCTAClickedEvent = ValidateEvent<{
- event: "onboarding_checklist_cta_clicked";
- triggered_from: ChecklistItemValue;
- event_detail: ChecklistItemCTA;
-}>;
-
-type NewsletterToggleClickedEvent = ValidateEvent<{
- event: "newsletter-toggle-clicked";
- triggered_from: "setup";
- event_detail: "opted-in" | "opted-out";
-}>;
-
-type NewIFrameCardCreatedEvent = ValidateEvent<{
- event: "new_iframe_card_created";
- event_detail: string | null;
- target_id: number | null;
-}>;
-
-export type MoveToTrashEvent = ValidateEvent<{
- event: "moved-to-trash";
- target_id: number | null;
- triggered_from: "collection" | "detail_page" | "cleanup_modal";
- duration_ms: number | null;
- result: "success" | "failure";
- event_detail:
- | "question"
- | "model"
- | "metric"
- | "dashboard"
- | "collection"
- | "dataset"
- | "indexed-entity"
- | "snippet"
- | "document"
- | "table"
- | "transform";
-}>;
-
-export type ErrorDiagnosticModalOpenedEvent = ValidateEvent<{
- event: "error_diagnostic_modal_opened";
- triggered_from: "profile-menu" | "command-palette";
-}>;
-
-export type ErrorDiagnosticModalSubmittedEvent = ValidateEvent<{
- event: "error_diagnostic_modal_submitted";
- event_detail: "download-diagnostics" | "submit-report";
-}>;
-
-export type DependencyEntitySelected = ValidateEvent<{
- event: "dependency_entity_selected";
- triggered_from:
- | "dependency-graph"
- | "diagnostics-broken-list"
- | "diagnostics-unreferenced-list"
- | "data-structure"
- | "transform-run-list";
- event_detail?: string;
- target_id: number;
-}>;
-
-type DependencyDiagnosticsEntitySelected = ValidateEvent<{
- event: "dependency_diagnostics_entity_selected";
- triggered_from: "broken" | "unreferenced";
- target_id: number;
- event_detail?: string;
-}>;
-
-export type GsheetsConnectionClickedEvent = ValidateEvent<{
- event: "sheets_connection_clicked";
- triggered_from: "db-page" | "add-data-modal";
-}>;
-
-type GsheetsImportClickedEvent = ValidateEvent<{
- event: "sheets_import_by_url_clicked";
- triggered_from: "sheets-url-popup";
-}>;
-
-type KeyboardShortcutPerformEvent = ValidateEvent<{
- event: "keyboard_shortcut_performed";
- event_detail: KeyboardShortcutId;
-}>;
-
-type NewEntityInitiatedEvent = ValidateEvent<{
- event: "plus_button_clicked";
- triggered_from: "model" | "metric" | "collection-header" | "collection-nav";
-}>;
-
-type NewButtonClickedEvent = ValidateEvent<{
- event: "new_button_clicked";
- triggered_from: "app-bar" | "empty-collection";
-}>;
-
-type NewButtonItemClickedEvent = ValidateEvent<{
- event: "new_button_item_clicked";
- triggered_from: "question" | "native-query" | "dashboard";
-}>;
-
-type VisualizeAnotherWayClickedEvent = ValidateEvent<{
- event: "visualize_another_way_clicked";
- triggered_from: "question-list" | "dashcard-actions-panel";
-}>;
-
-type VisualizerModalEvent = ValidateEvent<
- | {
- event:
- | "visualizer_add_more_data_clicked"
- | "visualizer_show_columns_clicked"
- | "visualizer_settings_clicked"
- | "visualizer_save_clicked"
- | "visualizer_close_clicked"
- | "visualizer_view_as_table_clicked";
- triggered_from: "visualizer-modal";
- }
- | {
- event: "visualizer_data_changed";
- event_detail:
- | "visualizer_viz_type_changed"
- | "visualizer_datasource_removed"
- | "visualizer_datasource_added"
- | "visualizer_datasource_replaced"
- | "visualizer_datasource_reset"
- | "visualizer_column_removed"
- | "visualizer_column_added";
- triggered_from: "visualizer-modal";
- }
->;
-
-type EventsClickedEvent = ValidateEvent<{
- event: "events_clicked";
- triggered_from: "chart" | "collection";
-}>;
-
-type AddDataModalOpenedEvent = ValidateEvent<{
- event: "data_add_modal_opened";
- triggered_from: "getting-started" | "left-nav";
-}>;
-
-type AddDataModalTabEvent = ValidateEvent<{
- event: "csv_tab_clicked" | "sheets_tab_clicked" | "database_tab_clicked";
- triggered_from: "add-data-modal";
-}>;
-
-type DashboardFilterCreatedEvent = ValidateEvent<{
- event: "dashboard_filter_created";
- target_id: number | null;
- triggered_from: VisualizationDisplay | null;
- event_detail: string | null;
-}>;
-
-type DashboardFilterMovedEvent = ValidateEvent<{
- event: "dashboard_filter_moved";
- target_id: number | null;
- triggered_from: VisualizationDisplay | null;
- event_detail: VisualizationDisplay | null;
-}>;
-
-type EmbedWizardOpenedEvent = ValidateEvent<{
- event: "embed_wizard_opened";
-}>;
-
-type EmbedWizardExperienceCompletedEvent = ValidateEvent<{
- event: "embed_wizard_experience_completed";
- event_detail: string;
-}>;
-
-type EmbedWizardResourceSelectionCompletedEvent = ValidateEvent<{
- event: "embed_wizard_resource_selection_completed";
- event_detail: string;
-}>;
-
-type EmbedWizardOptionsCompletedEvent = ValidateEvent<{
- event: "embed_wizard_options_completed";
- event_detail: string;
-}>;
-
-type EmbedWizardCodeCopiedEvent = ValidateEvent<{
- event: "embed_wizard_code_copied";
- event_detail: string;
-}>;
-
-type TableEditingSettingsToggledEvent = ValidateEvent<{
- event: "edit_data_settings_toggled";
- event_detail: "on" | "off";
- target_id: number;
- triggered_from: "admin-settings-databases";
-}>;
-
-type TableEditButtonClickedEvent = ValidateEvent<{
- event: "edit_data_button_clicked";
- target_id: number;
- triggered_from: "table-browser";
-}>;
-
-type ConnectionStringParsedSuccessEvent = ValidateEvent<{
- event: "connection_string_parsed_success";
- triggered_from: FormLocation;
-}>;
-
-type ConnectionStringParsedFailedEvent = ValidateEvent<{
- event: "connection_string_parsed_failed";
- triggered_from: FormLocation;
-}>;
-
-type TransformTriggerManualRunEvent = ValidateEvent<{
- event: "transform_trigger_manual_run";
- target_id: TransformId;
-}>;
-
-type TransformJobTriggerManualRunEvent = ValidateEvent<{
- event: "transform_job_trigger_manual_run";
- target_id: TransformId;
-}>;
-
-type TransformCreateEvent = ValidateEvent<{
- event: "transform_create";
- event_detail: "query" | "native" | "python" | "saved-question";
-}>;
-
-type TransformCreatedEvent = ValidateEvent<{
- event: "transform_created";
- target_id: number;
- event_detail: "incremental" | undefined;
-}>;
-
-type TransformRunTagsUpdated = ValidateEvent<{
- event: "transform_tags_updated";
- result: "success" | "failure";
- triggered_from: "transform_run_page";
- event_detail: "tag_added" | "tag_removed";
- target_id: number;
-}>;
-
-type TransformJobCreatedEvent = ValidateEvent<{
- event: "transform_job_created";
- triggered_from: "transform_job_new";
- result: "success" | "failure";
- target_id: number | null;
-}>;
-
-type TransformInspectLensLoadedEvent = ValidateEvent<{
- event: "transform_inspect_lens_loaded";
- target_id: TransformId;
- event_detail: string;
- duration_ms: number;
-}>;
-
-type TransformInspectDrillLensClickedEvent = ValidateEvent<{
- event: "transform_inspect_drill_lens_clicked";
- target_id: TransformId;
- event_detail: string;
- triggered_from: "card_drills" | "join_analysis";
-}>;
-
-type TransformInspectAlertClickedEvent = ValidateEvent<{
- event: "transform_inspect_alert_clicked";
- target_id: TransformId;
- event_detail: string;
-}>;
-
-type TransformInspectDrillLensClosedEvent = ValidateEvent<{
- event: "transform_inspect_drill_lens_closed";
- target_id: TransformId;
- event_detail: string;
-}>;
-
-type TransformInspectEvent =
- | TransformInspectLensLoadedEvent
- | TransformInspectDrillLensClickedEvent
- | TransformInspectAlertClickedEvent
- | TransformInspectDrillLensClosedEvent;
-
-type DocumentCreatedEvent = ValidateEvent<{
- event: "document_created";
- target_id: number;
-}>;
-
-type DocumentUpdatedEvent = ValidateEvent<{
- event: "document_saved";
- target_id: number;
-}>;
-
-type DocumentAddCardEvent = ValidateEvent<{
- event: "document_add_card";
- target_id: number | null;
-}>;
-
-type DocumentAddSmartLinkEvent = ValidateEvent<{
- event: "document_add_smart_link";
- target_id: number | null;
-}>;
-
-type DocumentReplaceCardEvent = ValidateEvent<{
- event: "document_replace_card";
- target_id: number | null;
-}>;
-
-type DocumentDuplicatedEvent = ValidateEvent<{
- event: "document_duplicated";
- target_id: number | null;
-}>;
-
-type DocumentAskMetabotEvent = ValidateEvent<{
- event: "document_ask_metabot";
- target_id: number | null;
-}>;
-
-type DocumentPrintEvent = ValidateEvent<{
- event: "document_print";
- target_id: number | null;
-}>;
-
-type DocumentAddSupportingTextEvent = ValidateEvent<{
- event: "document_add_supporting_text";
- target_id: number | null;
-}>;
-
-type DatabaseHelpClickedEvent = ValidateEvent<{
- event: "database_help_clicked";
- triggered_from: "admin" | "setup";
-}>;
-
-type XRayTableClickedEvent = ValidateEvent<{
- event: "x-ray_clicked";
- event_detail: "table";
- triggered_from: "homepage" | "browse_database";
-}>;
-
-type XRayDataReferenceClickedEvent = ValidateEvent<{
- event: "x-ray_clicked";
- event_detail: "table" | "field" | "segment";
- triggered_from: "data_reference";
-}>;
-
-type XRaySuggestionClickedEvent = ValidateEvent<{
- event: "x-ray_clicked";
- event_detail: keyof RelatedDashboardXRays;
- triggered_from: "suggestion_sidebar";
-}>;
-
-type XRayAutoInsightsClicked = ValidateEvent<{
- event: "x-ray_automatic_insights_clicked";
- event_detail: "x-ray" | "compare_to_rest";
-}>;
-
-type XRayClickedEvent =
- | XRayTableClickedEvent
- | XRayDataReferenceClickedEvent
- | XRaySuggestionClickedEvent
- | XRayAutoInsightsClicked;
-
-type XRaySavedEvent = ValidateEvent<{
- event: "x-ray_saved";
-}>;
-
-type XRayEvent = XRayClickedEvent | XRaySavedEvent;
-
-type EmbedWizardEvent =
- | EmbedWizardOpenedEvent
- | EmbedWizardExperienceCompletedEvent
- | EmbedWizardResourceSelectionCompletedEvent
- | EmbedWizardOptionsCompletedEvent
- | EmbedWizardCodeCopiedEvent;
-
-type TableEditingEvent =
- | TableEditingSettingsToggledEvent
- | TableEditButtonClickedEvent;
-
-type MetabotChatOpenedEvent = ValidateEvent<{
- event: "metabot_chat_opened";
- triggered_from:
- | "header"
- | "command_palette"
- | "keyboard_shortcut"
- | "native_editor";
-}>;
-
-type MetabotRequestSentEvent = ValidateEvent<{
- event: "metabot_request_sent";
-}>;
-
-type MetabotFixQueryClickedEvent = ValidateEvent<{
- event: "metabot_fix_query_clicked";
-}>;
-
-type MetabotExplainChartClickedEvent = ValidateEvent<{
- event: "metabot_explain_chart_clicked";
-}>;
-
-type MetabotEvent =
- | MetabotChatOpenedEvent
- | MetabotRequestSentEvent
- | MetabotFixQueryClickedEvent
- | MetabotExplainChartClickedEvent;
-
-type RevertVersionEvent = ValidateEvent<{
- event: "revert_version_clicked";
- event_detail: "card" | "dashboard" | "document" | "transform";
-}>;
-
-type LearnAboutDataClickedEvent = ValidateEvent<{
- event: "learn_about_our_data_clicked";
-}>;
-
-export type MetadataEditEventDetail =
- | "type_casting"
- | "semantic_type_change"
- | "visibility_change"
- | "filtering_change"
- | "display_values"
- | "json_unfolding"
- | "formatting";
-
-type MetadataEditEventTriggeredFrom = "admin" | "data_studio";
-
-type MetadataEditEvent = ValidateEvent<{
- event: "metadata_edited";
- event_detail: MetadataEditEventDetail;
- triggered_from: MetadataEditEventTriggeredFrom;
-}>;
-
-type BookmarkTableEvent = ValidateEvent<{
- event: "bookmark_added";
- event_detail: "table";
- triggered_from: "collection_list";
-}>;
-
-type BookmarkQuestionEvent = ValidateEvent<{
- event: "bookmark_added";
- event_detail: "question";
- triggered_from: "qb_action_panel" | "collection_list";
-}>;
-
-type BookmarkModelEvent = ValidateEvent<{
- event: "bookmark_added";
- event_detail: "model";
- triggered_from: "qb_action_panel" | "collection_list";
-}>;
-
-type BookmarkMetricEvent = ValidateEvent<{
- event: "bookmark_added";
- event_detail: "metric";
- triggered_from: "qb_action_panel" | "collection_list" | "browse_metrics";
-}>;
-
-type BookmarkDashboardEvent = ValidateEvent<{
- event: "bookmark_added";
- event_detail: "dashboard";
- triggered_from: "dashboard_header" | "collection_list";
-}>;
-
-type BookmarkCollectionEvent = ValidateEvent<{
- event: "bookmark_added";
- event_detail: "collection";
- triggered_from: "collection_header" | "collection_list";
-}>;
-
-type BookmarkDocumentEvent = ValidateEvent<{
- event: "bookmark_added";
- event_detail: "document";
- triggered_from: "collection_list" | "document_header";
-}>;
-
-type ClickActionPerformedEvent = ValidateEvent<{
- event: "click_action";
- triggered_from: ClickActionSection;
-}>;
-
-type RemoteSyncBranchSwitchedEvent = ValidateEvent<{
- event: "remote_sync_branch_switched";
- triggered_from: "admin-settings" | "app-bar";
-}>;
-
-type RemoteSyncBranchCreatedEvent = ValidateEvent<{
- event: "remote_sync_branch_created";
- triggered_from: "branch-picker" | "conflict-modal";
-}>;
-
-type RemoteSyncPullChangesEvent = ValidateEvent<{
- event: "remote_sync_pull_changes";
- triggered_from: "admin-settings" | "app-bar";
- event_detail?: "force";
-}>;
-
-type RemoteSyncPushChangesEvent = ValidateEvent<{
- event: "remote_sync_push_changes";
- triggered_from: "conflict-modal" | "app-bar";
- event_detail?: "force";
-}>;
-
-type RemoteSyncSettingsChangedEvent = ValidateEvent<{
- event: "remote_sync_settings_changed";
- triggered_from: "admin-settings" | "data-studio";
-}>;
-
-type RemoteSyncDeactivatedEvent = ValidateEvent<{
- event: "remote_sync_deactivated";
- triggered_from: "admin-settings";
-}>;
-
-type RemoteSyncEvent =
- | RemoteSyncBranchSwitchedEvent
- | RemoteSyncBranchCreatedEvent
- | RemoteSyncPullChangesEvent
- | RemoteSyncPushChangesEvent
- | RemoteSyncSettingsChangedEvent
- | RemoteSyncDeactivatedEvent;
-
-type BookmarkEvent =
- | BookmarkTableEvent
- | BookmarkQuestionEvent
- | BookmarkModelEvent
- | BookmarkMetricEvent
- | BookmarkDashboardEvent
- | BookmarkCollectionEvent
- | BookmarkDocumentEvent;
-
-type DataStudioOpenedEvent = ValidateEvent<{
- event: "data_studio_opened";
- triggered_from: "nav_menu";
-}>;
-
-type DataStudioLibraryCreatedEvent = ValidateEvent<{
- event: "data_studio_library_created";
- target_id: number | null;
-}>;
-
-type DataStudioTablePublishedEvent = ValidateEvent<{
- event: "data_studio_table_published";
- target_id: ConcreteTableId | undefined;
-}>;
-
-type DataStudioGlossaryCreatedEvent = ValidateEvent<{
- event: "data_studio_glossary_term_created";
- target_id: number | null;
-}>;
-
-type DataStudioGlossaryEditedEvent = ValidateEvent<{
- event: "data_studio_glossary_term_updated";
- target_id: number | null;
-}>;
-
-type DataStudioGlossaryDeletedEvent = ValidateEvent<{
- event: "data_studio_glossary_term_deleted";
- target_id: number | null;
-}>;
-
-type DataStudioTablePickerFiltersAppliedEvent = ValidateEvent<{
- event: "data_studio_table_picker_filters_applied";
-}>;
-
-type DataStudioTablePickerFiltersClearedEvent = ValidateEvent<{
- event: "data_studio_table_picker_filters_cleared";
-}>;
-
-type DataStudioTablePickerSearchPerformedEvent = ValidateEvent<{
- event: "data_studio_table_picker_search_performed";
-}>;
-
-type DataStudioTableUnpublishedEvent = ValidateEvent<{
- event: "data_studio_table_unpublished";
- target_id: ConcreteTableId | undefined;
-}>;
-
-type DataStudioBulkSyncSettingsClickedEvent = ValidateEvent<{
- event: "data_studio_bulk_sync_settings_clicked";
-}>;
-
-type DataStudioBulkAttributeUpdatedEvent = ValidateEvent<{
- event: "data_studio_bulk_attribute_updated";
- event_detail: "owner" | "layer" | "entity_type" | "data_source";
- result: "success" | "failure";
-}>;
-
-type DataStudioTableSchemaSyncedEvent = ValidateEvent<{
- event: "data_studio_table_schema_sync_started";
- result: "success" | "failure";
-}>;
-
-type DataStudioTableFieldsRescannedEvent = ValidateEvent<{
- event: "data_studio_table_fields_rescan_started";
- result: "success" | "failure";
-}>;
-
-type DataStudioTableFieldValuesDiscardedEvent = ValidateEvent<{
- event: "data_studio_table_field_values_discard_started";
- result: "success" | "failure";
-}>;
-
-type MeasureCreateStartedEvent = ValidateEvent<{
- event: "measure_create_started";
- triggered_from: "data_studio_measures_list";
- target_id: number;
-}>;
-
-type MeasureCreatedEvent = ValidateEvent<{
- event: "measure_created";
- triggered_from: "data_studio_measures";
- result: "success" | "failure";
- target_id: number | null;
-}>;
-
-type SegmentCreateStartedEvent = ValidateEvent<{
- event: "segment_create_started";
- triggered_from: "data_studio_segments" | "admin_datamodel_segments";
- target_id: number | null;
-}>;
-
-type SegmentCreatedEvent = ValidateEvent<{
- event: "segment_created";
- triggered_from: "data_studio_segments" | "admin_datamodel_segments";
- result: "success" | "failure";
- target_id: number | null;
-}>;
-
-type MetricCreateStartedEvent = ValidateEvent<{
- event: "metric_create_started";
- triggered_from: "browse_metrics" | "data_studio_library" | "command_palette";
-}>;
-
-type MetricCreatedEvent = ValidateEvent<{
- event: "metric_created";
- triggered_from: "data_studio" | "main_app";
- result: "success" | "failure";
- target_id: number | null;
-}>;
-
-type DataStudioEvent =
- | DataStudioOpenedEvent
- | DataStudioLibraryCreatedEvent
- | DataStudioTablePublishedEvent
- | DataStudioGlossaryCreatedEvent
- | DataStudioGlossaryEditedEvent
- | DataStudioGlossaryDeletedEvent
- | DataStudioTablePickerFiltersAppliedEvent
- | DataStudioTablePickerFiltersClearedEvent
- | DataStudioTablePickerSearchPerformedEvent
- | DataStudioTableUnpublishedEvent
- | DataStudioBulkSyncSettingsClickedEvent
- | DataStudioBulkAttributeUpdatedEvent
- | DataStudioTableSchemaSyncedEvent
- | DataStudioTableFieldsRescannedEvent
- | DataStudioTableFieldValuesDiscardedEvent
- | MeasureCreateStartedEvent
- | MeasureCreatedEvent
- | SegmentCreateStartedEvent
- | SegmentCreatedEvent
- | MetricCreateStartedEvent
- | MetricCreatedEvent;
-
-type UnsavedChangesWarningDisplayedEvent = ValidateEvent<{
- event: "unsaved_changes_warning_displayed";
- triggered_from: "document";
- target_id: number | null;
-}>;
-
-type MetricPageShowMoreClickedEvent = ValidateEvent<{
- event: "metric_page_show_more_clicked";
- target_id: number;
-}>;
-
-type MetricsViewerMetricAddedEvent = ValidateEvent<{
- event: "metrics_viewer_metric_added";
- target_id: number | null;
- event_detail: "metric" | "measure";
-}>;
-
-type MetricsViewerMetricRemovedEvent = ValidateEvent<{
- event: "metrics_viewer_metric_removed";
- target_id: number | null;
- event_detail: "metric" | "measure";
-}>;
-
-type MetricsViewerFilterAddedEvent = ValidateEvent<{
- event: "metrics_viewer_filter_added";
- triggered_from: "metric_filter" | "dimension_filter";
-}>;
-
-type MetricsViewerFilterEditedEvent = ValidateEvent<{
- event: "metrics_viewer_filter_edited";
- triggered_from: "metric_filter" | "dimension_filter";
-}>;
-
-type MetricsViewerFilterRemovedEvent = ValidateEvent<{
- event: "metrics_viewer_filter_removed";
- triggered_from: "metric_filter" | "dimension_filter";
-}>;
-
-type MetricsViewerDimensionTabAddedEvent = ValidateEvent<{
- event: "metrics_viewer_dimension_tab_added";
-}>;
-
-type MetricsViewerDimensionTabSwitchedEvent = ValidateEvent<{
- event: "metrics_viewer_dimension_tab_switched";
-}>;
-
-type MetricsViewerDimensionTabRemovedEvent = ValidateEvent<{
- event: "metrics_viewer_dimension_tab_removed";
-}>;
-
-type MetricsViewerEvent =
- | MetricsViewerMetricAddedEvent
- | MetricsViewerMetricRemovedEvent
- | MetricsViewerFilterAddedEvent
- | MetricsViewerFilterEditedEvent
- | MetricsViewerFilterRemovedEvent
- | MetricsViewerDimensionTabAddedEvent
- | MetricsViewerDimensionTabSwitchedEvent
- | MetricsViewerDimensionTabRemovedEvent;
-
-export type SimpleEvent =
- | CustomSMTPSetupClickedEvent
- | CustomSMTPSetupSuccessEvent
- | CSVUploadClickedEvent
- | DatabaseAddClickedEvent
- | DatabaseEngineSelectedEvent
- | DependencyEntitySelected
- | DependencyDiagnosticsEntitySelected
- | NewIFrameCardCreatedEvent
- | NewsletterToggleClickedEvent
- | OnboardingChecklistOpenedEvent
- | OnboardingChecklistItemExpandedEvent
- | OnboardingChecklistItemCTAClickedEvent
- | MoveToTrashEvent
- | ErrorDiagnosticModalOpenedEvent
- | ErrorDiagnosticModalSubmittedEvent
- | GsheetsConnectionClickedEvent
- | GsheetsImportClickedEvent
- | KeyboardShortcutPerformEvent
- | NewEntityInitiatedEvent
- | NewButtonClickedEvent
- | NewButtonItemClickedEvent
- | VisualizeAnotherWayClickedEvent
- | VisualizerModalEvent
- | EventsClickedEvent
- | AddDataModalOpenedEvent
- | AddDataModalTabEvent
- | DashboardFilterCreatedEvent
- | DashboardFilterMovedEvent
- | EmbedWizardEvent
- | TableEditingEvent
- | ConnectionStringParsedSuccessEvent
- | ConnectionStringParsedFailedEvent
- | TransformTriggerManualRunEvent
- | TransformJobTriggerManualRunEvent
- | TransformCreatedEvent
- | TransformCreateEvent
- | TransformRunTagsUpdated
- | TransformJobCreatedEvent
- | TransformInspectEvent
- | DocumentAddCardEvent
- | DocumentAddSmartLinkEvent
- | DocumentAddSupportingTextEvent
- | DocumentAskMetabotEvent
- | DocumentCreatedEvent
- | DocumentReplaceCardEvent
- | DocumentDuplicatedEvent
- | DocumentUpdatedEvent
- | DocumentPrintEvent
- | DatabaseHelpClickedEvent
- | XRayEvent
- | MetabotEvent
- | RevertVersionEvent
- | LearnAboutDataClickedEvent
- | MetadataEditEvent
- | BookmarkEvent
- | RemoteSyncEvent
- | ClickActionPerformedEvent
- | DataStudioEvent
- | UnsavedChangesWarningDisplayedEvent
- | MetricPageShowMoreClickedEvent
- | MetricsViewerEvent
- | { event: string; [key: string]: unknown };
diff --git a/frontend/src/metabase-types/analytics/schema.ts b/frontend/src/metabase-types/analytics/schema.ts
index 473e33d9191..062f695079f 100644
--- a/frontend/src/metabase-types/analytics/schema.ts
+++ b/frontend/src/metabase-types/analytics/schema.ts
@@ -10,7 +10,7 @@ import type { EmbedFlowEvent } from "./embed-flow";
import type { EmbedShareEvent } from "./embed-share";
import type { EmbeddedAnalyticsJsEvent } from "./embedded-analytics-js";
import type { EmbeddingHomepageEvent } from "./embedding-homepage";
-import type { SimpleEvent } from "./event";
+import type { SimpleEventSchema } from "./event";
import type { InviteEvent } from "./invite";
import type { ModelEvent } from "./model";
import type { QuestionEvent } from "./question";
@@ -34,7 +34,7 @@ export type SchemaEventMap = {
embed_share: EmbedShareEvent;
embedded_analytics_js: EmbeddedAnalyticsJsEvent;
embedding_homepage: EmbeddingHomepageEvent;
- simple_event: SimpleEvent;
+ simple_event: SimpleEventSchema;
invite: InviteEvent;
model: ModelEvent;
question: QuestionEvent;
diff --git a/frontend/src/metabase/admin/settings/components/Email/analytics.ts b/frontend/src/metabase/admin/settings/components/Email/analytics.ts
index 813b8e6eb2d..e2358e08c47 100644
--- a/frontend/src/metabase/admin/settings/components/Email/analytics.ts
+++ b/frontend/src/metabase/admin/settings/components/Email/analytics.ts
@@ -1,13 +1,11 @@
import { trackSimpleEvent } from "metabase/lib/analytics";
-import type {
- CustomSMTPSetupClickedEvent,
- CustomSMTPSetupSuccessEvent,
-} from "metabase-types/analytics";
+
+type SMTPSetupEventDetail = "self-hosted" | "cloud";
export function trackSMTPSetupClick({
eventDetail,
}: {
- eventDetail: CustomSMTPSetupClickedEvent["event_detail"];
+ eventDetail: SMTPSetupEventDetail;
}) {
trackSimpleEvent({
event: "custom_smtp_setup_clicked",
@@ -18,7 +16,7 @@ export function trackSMTPSetupClick({
export function trackSMTPSetupSuccess({
eventDetail,
}: {
- eventDetail: CustomSMTPSetupSuccessEvent["event_detail"];
+ eventDetail: SMTPSetupEventDetail;
}) {
trackSimpleEvent({
event: "custom_smtp_setup_success",
diff --git a/frontend/src/metabase/archive/analytics.ts b/frontend/src/metabase/archive/analytics.ts
index 9b3bb0aa67e..646c7795d1a 100644
--- a/frontend/src/metabase/archive/analytics.ts
+++ b/frontend/src/metabase/archive/analytics.ts
@@ -1,5 +1,19 @@
import { trackSchemaEvent } from "metabase/lib/analytics";
-import type { MoveToTrashEvent } from "metabase-types/analytics";
+
+type MoveToTrashEventDetail =
+ | "question"
+ | "model"
+ | "metric"
+ | "dashboard"
+ | "collection"
+ | "dataset"
+ | "indexed-entity"
+ | "snippet"
+ | "document"
+ | "table"
+ | "transform";
+
+type MoveToTrashTriggeredFrom = "collection" | "detail_page" | "cleanup_modal";
export const archiveAndTrack = async ({
archive,
@@ -8,13 +22,13 @@ export const archiveAndTrack = async ({
triggeredFrom,
}: {
archive: () => Promise<void>;
- model: MoveToTrashEvent["event_detail"] | "card";
+ model: MoveToTrashEventDetail | "card";
modelId: number;
- triggeredFrom: MoveToTrashEvent["triggered_from"];
+ triggeredFrom: MoveToTrashTriggeredFrom;
}): Promise<void> => {
const start = new Date().getTime();
const logAnalytics = (successful: boolean) => {
- let eventDetail: MoveToTrashEvent["event_detail"];
+ let eventDetail: MoveToTrashEventDetail;
if (model === "card") {
eventDetail = "question";
} else {
diff --git a/frontend/src/metabase/common/components/ErrorPages/analytics.ts b/frontend/src/metabase/common/components/ErrorPages/analytics.ts
index f7291964c33..eeda5515156 100644
--- a/frontend/src/metabase/common/components/ErrorPages/analytics.ts
+++ b/frontend/src/metabase/common/components/ErrorPages/analytics.ts
@@ -1,11 +1,7 @@
import { trackSimpleEvent } from "metabase/lib/analytics";
-import type {
- ErrorDiagnosticModalOpenedEvent,
- ErrorDiagnosticModalSubmittedEvent,
-} from "metabase-types/analytics/event";
export const trackErrorDiagnosticModalOpened = (
- triggeredFrom: ErrorDiagnosticModalOpenedEvent["triggered_from"],
+ triggeredFrom: "profile-menu" | "command-palette",
) => {
trackSimpleEvent({
event: "error_diagnostic_modal_opened",
@@ -14,7 +10,7 @@ export const trackErrorDiagnosticModalOpened = (
};
export const trackErrorDiagnosticModalSubmitted = (
- eventDetail: ErrorDiagnosticModalSubmittedEvent["event_detail"],
+ eventDetail: "download-diagnostics" | "submit-report",
) => {
trackSimpleEvent({
event: "error_diagnostic_modal_submitted",
diff --git a/frontend/src/metabase/data-studio/analytics.ts b/frontend/src/metabase/data-studio/analytics.ts
index 0e32ae08541..b3af214880a 100644
--- a/frontend/src/metabase/data-studio/analytics.ts
+++ b/frontend/src/metabase/data-studio/analytics.ts
@@ -1,5 +1,4 @@
import { trackSimpleEvent } from "metabase/lib/analytics";
-import type { DependencyEntitySelected } from "metabase-types/analytics";
import type { CollectionId, ConcreteTableId } from "metabase-types/api";
export const trackDataStudioLibraryCreated = (id: CollectionId) => {
@@ -130,7 +129,12 @@ export const trackDependencyEntitySelected = ({
}: {
entityId: number;
eventDetail?: string;
- triggeredFrom: DependencyEntitySelected["triggered_from"];
+ triggeredFrom:
+ | "dependency-graph"
+ | "diagnostics-broken-list"
+ | "diagnostics-unreferenced-list"
+ | "data-structure"
+ | "transform-run-list";
}) => {
trackSimpleEvent({
event: "dependency_entity_selected",
diff --git a/frontend/src/metabase/data-studio/data-model/analytics.ts b/frontend/src/metabase/data-studio/data-model/analytics.ts
index efbc96eb608..2ab5d15770f 100644
--- a/frontend/src/metabase/data-studio/data-model/analytics.ts
+++ b/frontend/src/metabase/data-studio/data-model/analytics.ts
@@ -1,5 +1,5 @@
import { trackSimpleEvent } from "metabase/lib/analytics";
-import type { MetadataEditEventDetail } from "metabase-types/analytics";
+import type { MetadataEditEventDetail } from "metabase/metadata/pages/shared/analytics";
export function trackMetadataChange(detail: MetadataEditEventDetail) {
trackSimpleEvent({
diff --git a/frontend/src/metabase/databases/components/DatabaseConnectionUri/analytics.ts b/frontend/src/metabase/databases/components/DatabaseConnectionUri/analytics.ts
index 8ceb3a38b0a..c0774466012 100644
--- a/frontend/src/metabase/databases/components/DatabaseConnectionUri/analytics.ts
+++ b/frontend/src/metabase/databases/components/DatabaseConnectionUri/analytics.ts
@@ -1,6 +1,7 @@
import { trackSimpleEvent } from "metabase/lib/analytics";
import type { FormLocation } from "../../types";
+
export function connectionStringParsedSuccess(location: FormLocation) {
trackSimpleEvent({
event: "connection_string_parsed_success",
diff --git a/frontend/src/metabase/lib/analytics.ts b/frontend/src/metabase/lib/analytics.ts
index 32bc7c9e280..dae34d3e01e 100644
--- a/frontend/src/metabase/lib/analytics.ts
+++ b/frontend/src/metabase/lib/analytics.ts
@@ -2,11 +2,8 @@ import * as Snowplow from "@snowplow/browser-tracker";
import { shouldLogAnalytics } from "metabase/env";
import Settings from "metabase/lib/settings";
-import type {
- SchemaEvent,
- SchemaType,
- SimpleEvent,
-} from "metabase-types/analytics";
+import type { SchemaEventMap, SchemaType } from "metabase-types/analytics";
+import type { SimpleEventSchema } from "metabase-types/analytics/event";
export * from "./analytics-untyped";
@@ -37,11 +34,17 @@ const VERSIONS: Record<SchemaType, SchemaVersion> = {
upsell: "1-0-0",
};
-export function trackSimpleEvent(event: SimpleEvent) {
+export function trackSimpleEvent<
+ T extends SimpleEventSchema &
+ Record<Exclude<keyof T, keyof SimpleEventSchema>, never>,
+>(event: T) {
trackSchemaEvent("simple_event", event);
}
-export function trackSchemaEvent(schema: SchemaType, event: SchemaEvent): void {
+export function trackSchemaEvent<S extends SchemaType>(
+ schema: S,
+ event: SchemaEventMap[S],
+): void {
const shouldSendEvent =
Settings.trackingEnabled() && Settings.snowplowEnabled();
diff --git a/frontend/src/metabase/metadata/components/FieldSection/BehaviorSection/BehaviorSection.tsx b/frontend/src/metabase/metadata/components/FieldSection/BehaviorSection/BehaviorSection.tsx
index 9e186ed1a26..43cce55c1f7 100644
--- a/frontend/src/metabase/metadata/components/FieldSection/BehaviorSection/BehaviorSection.tsx
+++ b/frontend/src/metabase/metadata/components/FieldSection/BehaviorSection/BehaviorSection.tsx
@@ -3,13 +3,13 @@ import { t } from "ttag";
import { useGetDatabaseQuery, useUpdateFieldMutation } from "metabase/api";
import { useMetadataToasts } from "metabase/metadata/hooks";
+import type { MetadataEditEventDetail } from "metabase/metadata/pages/shared/analytics";
import {
canFieldUnfoldJson,
getRawTableFieldId,
isFieldJsonUnfolded,
} from "metabase/metadata/utils/field";
import { PLUGIN_FEATURE_LEVEL_PERMISSIONS } from "metabase/plugins";
-import type { MetadataEditEventDetail } from "metabase-types/analytics";
import type {
DatabaseId,
Field,
diff --git a/frontend/src/metabase/metadata/components/FieldSection/BehaviorSection/RemappingPicker/RemappingPicker.tsx b/frontend/src/metabase/metadata/components/FieldSection/BehaviorSection/RemappingPicker/RemappingPicker.tsx
index 567560e38e5..87fc6b9dded 100644
--- a/frontend/src/metabase/metadata/components/FieldSection/BehaviorSection/RemappingPicker/RemappingPicker.tsx
+++ b/frontend/src/metabase/metadata/components/FieldSection/BehaviorSection/RemappingPicker/RemappingPicker.tsx
@@ -11,6 +11,7 @@ import {
useUpdateFieldValuesMutation,
} from "metabase/api";
import { useMetadataToasts } from "metabase/metadata/hooks";
+import type { MetadataEditEventDetail } from "metabase/metadata/pages/shared/analytics";
import { getRawTableFieldId } from "metabase/metadata/utils/field";
import { PLUGIN_FEATURE_LEVEL_PERMISSIONS } from "metabase/plugins";
import { FieldDataSelector } from "metabase/query_builder/components/DataSelector";
@@ -24,7 +25,6 @@ import {
Stack,
rem,
} from "metabase/ui";
-import type { MetadataEditEventDetail } from "metabase-types/analytics";
import type { Database, Field, FieldId } from "metabase-types/api";
import {
diff --git a/frontend/src/metabase/metadata/components/FieldSection/DataSection/DataSection.tsx b/frontend/src/metabase/metadata/components/FieldSection/DataSection/DataSection.tsx
index a29fd94a99f..a523e42caab 100644
--- a/frontend/src/metabase/metadata/components/FieldSection/DataSection/DataSection.tsx
+++ b/frontend/src/metabase/metadata/components/FieldSection/DataSection/DataSection.tsx
@@ -3,13 +3,13 @@ import { t } from "ttag";
import { useUpdateFieldMutation } from "metabase/api";
import { useMetadataToasts } from "metabase/metadata/hooks";
+import type { MetadataEditEventDetail } from "metabase/metadata/pages/shared/analytics";
import {
canCoerceFieldType,
getFieldRawName,
getRawTableFieldId,
} from "metabase/metadata/utils/field";
import { Box, Flex, Group, Stack, Switch, rem } from "metabase/ui";
-import type { MetadataEditEventDetail } from "metabase-types/analytics";
import type { Field } from "metabase-types/api";
import { CoercionStrategyPicker } from "../../CoercionStrategyPicker";
diff --git a/frontend/src/metabase/metadata/components/FieldSection/FieldSection.tsx b/frontend/src/metabase/metadata/components/FieldSection/FieldSection.tsx
index e11635ec88d..477b3d04043 100644
--- a/frontend/src/metabase/metadata/components/FieldSection/FieldSection.tsx
+++ b/frontend/src/metabase/metadata/components/FieldSection/FieldSection.tsx
@@ -4,10 +4,10 @@ import { t } from "ttag";
import { useUpdateFieldMutation } from "metabase/api";
import { getColumnIcon } from "metabase/common/utils/columns";
import { useMetadataToasts } from "metabase/metadata/hooks";
+import type { MetadataEditEventDetail } from "metabase/metadata/pages/shared/analytics";
import { getRawTableFieldId } from "metabase/metadata/utils/field";
import { Group, Stack, type StackProps, Text } from "metabase/ui";
import * as Lib from "metabase-lib";
-import type { MetadataEditEventDetail } from "metabase-types/analytics";
import type { Field, FieldId, Table } from "metabase-types/api";
import { NameDescriptionInput } from "../NameDescriptionInput";
diff --git a/frontend/src/metabase/metadata/components/FieldSection/FormattingSection/FormattingSection.tsx b/frontend/src/metabase/metadata/components/FieldSection/FormattingSection/FormattingSection.tsx
index 5129f679130..f878705dbc3 100644
--- a/frontend/src/metabase/metadata/components/FieldSection/FormattingSection/FormattingSection.tsx
+++ b/frontend/src/metabase/metadata/components/FieldSection/FormattingSection/FormattingSection.tsx
@@ -3,11 +3,11 @@ import { t } from "ttag";
import { useUpdateFieldMutation } from "metabase/api";
import { useMetadataToasts } from "metabase/metadata/hooks";
+import type { MetadataEditEventDetail } from "metabase/metadata/pages/shared/analytics";
import { getRawTableFieldId } from "metabase/metadata/utils/field";
import { ColumnSettings } from "metabase/visualizations/components/ColumnSettings";
import { getGlobalSettingsForColumn } from "metabase/visualizations/lib/settings/column";
import { isCurrency } from "metabase-lib/v1/types/utils/isa";
-import type { MetadataEditEventDetail } from "metabase-types/analytics";
import type {
Field,
FieldFormattingSettings as FieldSettings,
diff --git a/frontend/src/metabase/metadata/components/FieldSection/MetadataSection/MetadataSection.tsx b/frontend/src/metabase/metadata/components/FieldSection/MetadataSection/MetadataSection.tsx
index 63606c32a25..aca6f91f53b 100644
--- a/frontend/src/metabase/metadata/components/FieldSection/MetadataSection/MetadataSection.tsx
+++ b/frontend/src/metabase/metadata/components/FieldSection/MetadataSection/MetadataSection.tsx
@@ -6,9 +6,9 @@ import {
useUpdateFieldMutation,
} from "metabase/api";
import { useMetadataToasts } from "metabase/metadata/hooks";
+import type { MetadataEditEventDetail } from "metabase/metadata/pages/shared/analytics";
import { getRawTableFieldId } from "metabase/metadata/utils/field";
import { PLUGIN_FEATURE_LEVEL_PERMISSIONS } from "metabase/plugins";
-import type { MetadataEditEventDetail } from "metabase-types/analytics";
import type { Field, FieldId, Table } from "metabase-types/api";
import { SemanticTypeAndTargetPicker } from "../../SemanticTypeAndTargetPicker";
diff --git a/frontend/src/metabase/metadata/pages/shared/analytics.ts b/frontend/src/metabase/metadata/pages/shared/analytics.ts
index 60bbbbfa735..096ed2dc9e0 100644
--- a/frontend/src/metabase/metadata/pages/shared/analytics.ts
+++ b/frontend/src/metabase/metadata/pages/shared/analytics.ts
@@ -1,5 +1,13 @@
import { trackSimpleEvent } from "metabase/lib/analytics";
-import type { MetadataEditEventDetail } from "metabase-types/analytics";
+
+export type MetadataEditEventDetail =
+ | "type_casting"
+ | "semantic_type_change"
+ | "visibility_change"
+ | "filtering_change"
+ | "display_values"
+ | "json_unfolding"
+ | "formatting";
export const trackMetadataChange = (detail: MetadataEditEventDetail) => {
trackSimpleEvent({