Skip to content

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

Add tracking to bookmarks (#63752)

Nemanja Glumacc33489af3595
diff --git a/e2e/test/scenarios/documents/documents.cy.spec.ts b/e2e/test/scenarios/documents/documents.cy.spec.ts
index b60b9d53f41..89cdd6440ea 100644
--- a/e2e/test/scenarios/documents/documents.cy.spec.ts
+++ b/e2e/test/scenarios/documents/documents.cy.spec.ts
@@ -54,6 +54,18 @@ H.describeWithSnowplowEE("documents", () => {
H.expectUnstructuredSnowplowEvent({ event: "document_created" });
cy.wrap(getDocumentStub).should("not.have.been.called");
+ cy.findByLabelText("More options").click();
+ H.popover().findByText("Bookmark").click();
+
+ H.expectUnstructuredSnowplowEvent({
+ event: "bookmark_added",
+ event_detail: "document",
+ triggered_from: "document_header",
+ });
+
+ // Delete the bookmark because we need to bookmark the doc again in the test
+ cy.request("DELETE", "/api/bookmark/document/1");
+
H.appBar()
.findByRole("link", { name: /First collection/ })
.click();
@@ -80,6 +92,11 @@ H.describeWithSnowplowEE("documents", () => {
H.openCollectionItemMenu("Test Document");
H.popover().findByText("Bookmark").click();
+ H.expectUnstructuredSnowplowEvent({
+ event: "bookmark_added",
+ event_detail: "document",
+ triggered_from: "collection_list",
+ });
H.navigationSidebar()
.findByRole("tab", { name: "Bookmarks" })
diff --git a/e2e/test/scenarios/metrics/metrics-question.cy.spec.js b/e2e/test/scenarios/metrics/metrics-question.cy.spec.js
index ee88012acc8..b573d394a36 100644
--- a/e2e/test/scenarios/metrics/metrics-question.cy.spec.js
+++ b/e2e/test/scenarios/metrics/metrics-question.cy.spec.js
@@ -213,3 +213,55 @@ describe("scenarios > metrics > question", () => {
H.modal().findByText("Replace or save as new?").should("not.exist");
});
});
+
+H.describeWithSnowplow("metrics", () => {
+ beforeEach(() => {
+ H.resetSnowplow();
+ H.restore();
+ cy.signInAsAdmin();
+ H.enableTracking();
+ });
+
+ afterEach(() => {
+ H.expectNoBadSnowplowEvents();
+ });
+
+ it("should bookmark a metric", () => {
+ H.createQuestion({ ...ORDERS_SCALAR_METRIC, name: "Metric Foo" });
+ H.createQuestion({ ...ORDERS_SCALAR_METRIC, name: "Metric Bar" });
+ H.createQuestion(
+ { ...ORDERS_SCALAR_METRIC, name: "Metric Baz" },
+ { visitQuestion: true },
+ );
+ cy.findByTestId("qb-header").findByLabelText("Bookmark").click();
+ H.expectUnstructuredSnowplowEvent({
+ event: "bookmark_added",
+ event_detail: "metric",
+ triggered_from: "qb_action_panel",
+ });
+
+ H.navigationSidebar().findByText("Our analytics").click();
+ cy.findAllByTestId("collection-entry")
+ .filter(":contains(Metric Bar)")
+ .icon("ellipsis")
+ .click();
+ H.popover().findByText("Bookmark").click();
+ H.expectUnstructuredSnowplowEvent({
+ event: "bookmark_added",
+ event_detail: "metric",
+ triggered_from: "collection_list",
+ });
+
+ H.navigationSidebar().findByText("Metrics").click();
+ cy.findAllByRole("row")
+ .filter(":contains(Metric Foo)")
+ .icon("ellipsis")
+ .click();
+ H.popover().findByText("Bookmark").click();
+ H.expectUnstructuredSnowplowEvent({
+ event: "bookmark_added",
+ event_detail: "metric",
+ triggered_from: "browse_metrics",
+ });
+ });
+});
diff --git a/e2e/test/scenarios/organization/bookmarks-collection.cy.spec.js b/e2e/test/scenarios/organization/bookmarks-collection.cy.spec.js
index 60458316df7..3d195837fa1 100644
--- a/e2e/test/scenarios/organization/bookmarks-collection.cy.spec.js
+++ b/e2e/test/scenarios/organization/bookmarks-collection.cy.spec.js
@@ -10,170 +10,237 @@ const adminPersonalCollectionName = adminFullName + "'s Personal Collection";
const { STATIC_ORDERS_ID } = SAMPLE_DB_TABLES;
-describe("scenarios > organization > bookmarks > collection", () => {
- beforeEach(() => {
- H.restore();
- cy.signInAsAdmin();
- });
-
- it("cannot add bookmark to root collection", () => {
- cy.intercept("GET", "/api/collection/root/items?**").as(
- "fetchRootCollectionItems",
- );
-
- cy.visit("/collection/root");
-
- cy.wait("@fetchRootCollectionItems");
-
- H.getSidebarSectionTitle("Collections");
- cy.icon("bookmark").should("not.exist");
- });
-
- it("can add, update bookmark name when collection name is updated, and remove bookmarks from collection from its page", () => {
- H.visitCollection(FIRST_COLLECTION_ID);
-
- // Add bookmark
- cy.icon("bookmark").click();
+H.describeWithSnowplow(
+ "scenarios > organization > bookmarks > collection",
+ () => {
+ beforeEach(() => {
+ H.resetSnowplow();
+ H.restore();
+ cy.signInAsAdmin();
+ H.enableTracking();
+ });
- H.navigationSidebar().within(() => {
- H.getSidebarSectionTitle(/Bookmarks/);
- cy.findAllByText("First collection").should("have.length", 2);
+ it("cannot add bookmark to root collection", () => {
+ H.visitCollection("root");
- // Once there is a list of bookmarks,
- // we add a heading to the list of collections below the list of bookmarks
H.getSidebarSectionTitle("Collections");
+ cy.icon("bookmark").should("not.exist");
});
- // Rename bookmarked collection
- cy.findByTestId("collection-name-heading").click().type(" 2").blur();
+ it("can add, update bookmark name when collection name is updated, and remove bookmarks from collection from its page", () => {
+ H.visitCollection(FIRST_COLLECTION_ID);
- H.navigationSidebar()
- .findAllByText("First collection 2")
- .should("have.length", 2);
+ // Add bookmark
+ cy.icon("bookmark").click();
- // Remove bookmark
- cy.findByTestId("collection-menu").icon("bookmark_filled").click();
+ H.expectUnstructuredSnowplowEvent({
+ event: "bookmark_added",
+ event_detail: "collection",
+ triggered_from: "collection_header",
+ });
- H.navigationSidebar()
- .findAllByText("First collection 2")
- .should("have.length", 1);
+ H.navigationSidebar().within(() => {
+ H.getSidebarSectionTitle(/Bookmarks/);
+ cy.findAllByText("First collection").should("have.length", 2);
- cy.findByTestId("collection-menu")
- .icon("bookmark_filled")
- .should("not.exist");
- cy.findByTestId("collection-menu").icon("bookmark").should("exist");
- });
+ // Once there is a list of bookmarks,
+ // we add a heading to the list of collections below the list of bookmarks
+ H.getSidebarSectionTitle("Collections");
+ });
- it("can add/remove bookmark from unpinned Question in collection", () => {
- addThenRemoveBookmarkTo("Orders");
- });
+ // Rename bookmarked collection
+ cy.findByTestId("collection-name-heading").click().type(" 2").blur();
- it("can add/remove bookmark from pinned Question in collection", () => {
- const name = "Orders";
- cy.visit("/collection/root");
+ H.navigationSidebar()
+ .findAllByText("First collection 2")
+ .should("have.length", 2);
- pin(name);
- H.tableHeaderColumn("ID");
- bookmarkPinnedItem(name);
- });
+ // Remove bookmark
+ cy.findByTestId("collection-menu").icon("bookmark_filled").click();
- it("can add/remove bookmark from unpinned Dashboard in collection", () => {
- addThenRemoveBookmarkTo("Orders in a dashboard");
- });
+ H.navigationSidebar()
+ .findAllByText("First collection 2")
+ .should("have.length", 1);
- it("can add/remove bookmark from pinned Question in collection", () => {
- const name = "Orders in a dashboard";
- cy.visit("/collection/root");
-
- pin(name);
- // eslint-disable-next-line no-unscoped-text-selectors -- deprecated usage
- cy.findByText("A dashboard");
- bookmarkPinnedItem(name);
- });
-
- it("adds and removes bookmarks from Model in collection", () => {
- H.createQuestion({
- name: "Orders Model",
- query: { "source-table": STATIC_ORDERS_ID, aggregation: [["count"]] },
- type: "model",
+ cy.findByTestId("collection-menu")
+ .icon("bookmark_filled")
+ .should("not.exist");
+ cy.findByTestId("collection-menu").icon("bookmark").should("exist");
});
- addThenRemoveBookmarkTo("Orders Model");
- });
+ it("removes items from bookmarks list when they are archived", () => {
+ // A question
+ bookmarkThenArchive("Orders");
- it("removes items from bookmarks list when they are archived", () => {
- // A question
- bookmarkThenArchive("Orders");
+ // A dashboard
+ bookmarkThenArchive("Orders in a dashboard");
+ });
- // A dashboard
- bookmarkThenArchive("Orders in a dashboard");
- });
+ it("can remove bookmark from item in sidebar", () => {
+ H.visitCollection(ADMIN_PERSONAL_COLLECTION_ID);
- it("can remove bookmark from item in sidebar", () => {
- cy.visit(`/collection/${ADMIN_PERSONAL_COLLECTION_ID}`);
+ // Add bookmark
+ cy.findByTestId("collection-menu").icon("bookmark").click();
- // Add bookmark
- cy.findByTestId("collection-menu").icon("bookmark").click();
+ H.navigationSidebar().within(() => {
+ cy.icon("bookmark_filled").click({ force: true });
+ });
- H.navigationSidebar().within(() => {
- cy.icon("bookmark_filled").click({ force: true });
+ H.getSidebarSectionTitle(/Bookmarks/).should("not.exist");
});
- H.getSidebarSectionTitle(/Bookmarks/).should("not.exist");
- });
-
- it("can toggle bookmark list visibility", () => {
- cy.visit(`/collection/${ADMIN_PERSONAL_COLLECTION_ID}`);
+ it("can toggle bookmark list visibility", () => {
+ H.visitCollection(ADMIN_PERSONAL_COLLECTION_ID);
- // Add bookmark
- cy.icon("bookmark").click();
+ // Add bookmark
+ cy.icon("bookmark").click();
- H.navigationSidebar().within(() => {
- H.getSidebarSectionTitle(/Bookmarks/).click();
+ H.navigationSidebar().within(() => {
+ H.getSidebarSectionTitle(/Bookmarks/).click();
- cy.findByText(adminPersonalCollectionName).should("not.exist");
+ cy.findByText(adminPersonalCollectionName).should("not.exist");
- H.getSidebarSectionTitle(/Bookmarks/).click();
+ H.getSidebarSectionTitle(/Bookmarks/).click();
- cy.findByText(adminPersonalCollectionName);
+ cy.findByText(adminPersonalCollectionName);
+ });
});
- });
-});
-function addThenRemoveBookmarkTo(name) {
- addBookmarkTo(name);
- removeBookmarkFrom(name);
-}
+ describe("collection items", () => {
+ it("can add/remove bookmark from unpinned Question in collection", () => {
+ addBookmarkTo("Orders");
+ H.expectUnstructuredSnowplowEvent({
+ event: "bookmark_added",
+ event_detail: "question",
+ triggered_from: "collection_list",
+ });
+ removeBookmarkFrom("Orders");
+ H.expectUnstructuredSnowplowEvent(
+ {
+ event: "bookmark_added",
+ event_detail: "question",
+ triggered_from: "collection_list",
+ },
+ 1,
+ );
+ });
+
+ it("can add/remove bookmark from pinned Question in collection", () => {
+ const name = "Orders";
+ H.visitCollection("root");
+
+ pin(name);
+ H.tableHeaderColumn("ID");
+ bookmarkPinnedItem(name);
+
+ H.expectUnstructuredSnowplowEvent({
+ event: "bookmark_added",
+ event_detail: "question",
+ triggered_from: "collection_list",
+ });
+ });
+
+ it("can add/remove bookmark from unpinned Dashboard in collection", () => {
+ addBookmarkTo("Orders in a dashboard");
+ H.expectUnstructuredSnowplowEvent({
+ event: "bookmark_added",
+ event_detail: "dashboard",
+ triggered_from: "collection_list",
+ });
+ removeBookmarkFrom("Orders in a dashboard");
+ H.expectUnstructuredSnowplowEvent(
+ {
+ event: "bookmark_added",
+ event_detail: "dashboard",
+ triggered_from: "collection_list",
+ },
+ 1,
+ );
+ });
+
+ it("can add/remove bookmark from pinned Dashboard in collection", () => {
+ const name = "Orders in a dashboard";
+ H.visitCollection("root");
+
+ pin(name);
+ // eslint-disable-next-line no-unscoped-text-selectors -- deprecated usage
+ cy.findByText("A dashboard");
+ bookmarkPinnedItem(name);
+ H.expectUnstructuredSnowplowEvent({
+ event: "bookmark_added",
+ event_detail: "dashboard",
+ triggered_from: "collection_list",
+ });
+ });
+
+ it("adds and removes bookmarks from Model in collection", () => {
+ H.createQuestion({
+ name: "Orders Model",
+ query: { "source-table": STATIC_ORDERS_ID, aggregation: [["count"]] },
+ type: "model",
+ });
+
+ addBookmarkTo("Orders Model");
+ H.expectUnstructuredSnowplowEvent({
+ event: "bookmark_added",
+ event_detail: "model",
+ triggered_from: "collection_list",
+ });
+
+ removeBookmarkFrom("Orders Model");
+ H.expectUnstructuredSnowplowEvent(
+ {
+ event: "bookmark_added",
+ event_detail: "model",
+ triggered_from: "collection_list",
+ },
+ 1,
+ );
+ });
+
+ it("can bookmark a collection", () => {
+ const collectionName = "First collection";
+
+ addBookmarkTo(collectionName);
+ H.expectUnstructuredSnowplowEvent({
+ event: "bookmark_added",
+ event_detail: "collection",
+ triggered_from: "collection_list",
+ });
+
+ removeBookmarkFrom(collectionName);
+ H.expectUnstructuredSnowplowEvent(
+ {
+ event: "bookmark_added",
+ event_detail: "collection",
+ triggered_from: "collection_list",
+ },
+ 1,
+ );
+ });
+ });
+ },
+);
function addBookmarkTo(name) {
- cy.visit("/collection/root");
+ H.visitCollection("root");
- openEllipsisMenuFor(name);
- cy.findByText("Bookmark").click();
+ H.openCollectionItemMenu(name);
+ H.popover().findByTextEnsureVisible("Bookmark").click();
- H.navigationSidebar().within(() => {
- H.getSidebarSectionTitle(/Bookmarks/);
- cy.findByText(name);
- });
+ H.navigationSidebar()
+ .findByRole("tab", { name: /^Bookmark/ })
+ .should("contain", name);
}
function removeBookmarkFrom(name) {
- openEllipsisMenuFor(name);
+ H.openCollectionItemMenu(name);
- cy.findByText("Remove from bookmarks").click();
+ H.popover().findByTextEnsureVisible("Remove from bookmarks").click();
- H.navigationSidebar().within(() => {
- H.getSidebarSectionTitle(/Bookmarks/).should("not.exist");
- cy.findByText(name).should("not.exist");
- });
-}
-
-function openEllipsisMenuFor(name) {
- cy.get("td")
- .contains(name)
- .closest("tr")
- .find(".Icon-ellipsis")
- .click({ force: true });
+ H.navigationSidebar()
+ .findByRole("tab", { name: /^Bookmark/ })
+ .should("not.exist");
}
function bookmarkThenArchive(name) {
@@ -182,17 +249,13 @@ function bookmarkThenArchive(name) {
}
function pin(name) {
- openEllipsisMenuFor(name);
- H.popover().within(() => {
- cy.findByText("Pin this").click();
- });
+ H.openCollectionItemMenu(name);
+ H.popover().findByTextEnsureVisible("Pin this").click();
}
function archive(name) {
- openEllipsisMenuFor(name);
- H.popover().within(() => {
- cy.findByText("Move to trash").click();
- });
+ H.openCollectionItemMenu(name);
+ H.popover().findByTextEnsureVisible("Move to trash").click();
}
function bookmarkPinnedItem(name) {
diff --git a/e2e/test/scenarios/organization/bookmarks-dashboard.cy.spec.js b/e2e/test/scenarios/organization/bookmarks-dashboard.cy.spec.js
index 5d20db0253d..aff809cede5 100644
--- a/e2e/test/scenarios/organization/bookmarks-dashboard.cy.spec.js
+++ b/e2e/test/scenarios/organization/bookmarks-dashboard.cy.spec.js
@@ -1,10 +1,12 @@
const { H } = cy;
import { ORDERS_DASHBOARD_ID } from "e2e/support/cypress_sample_instance_data";
-describe("scenarios > dashboard > bookmarks", () => {
+H.describeWithSnowplow("scenarios > dashboard > bookmarks", () => {
beforeEach(() => {
+ H.resetSnowplow();
H.restore();
cy.signInAsAdmin();
+ H.enableTracking();
});
it("should add, update bookmark name when dashboard name is updated, and then remove bookmark", () => {
@@ -13,6 +15,11 @@ describe("scenarios > dashboard > bookmarks", () => {
// Add bookmark
cy.get("main header").icon("bookmark").click();
+ H.expectUnstructuredSnowplowEvent({
+ event: "bookmark_added",
+ event_detail: "dashboard",
+ triggered_from: "dashboard_header",
+ });
H.navigationSidebar().within(() => {
cy.findByText("Orders in a dashboard");
@@ -27,7 +34,15 @@ describe("scenarios > dashboard > bookmarks", () => {
// Remove bookmark
cy.get("main header").icon("bookmark_filled").click();
-
+ // Removing a bookmark should not be tracked
+ H.expectUnstructuredSnowplowEvent(
+ {
+ event: "bookmark_added",
+ event_detail: "dashboard",
+ triggered_from: "dashboard_header",
+ },
+ 1,
+ );
H.navigationSidebar().within(() => {
cy.findByText("Orders in a dashboard 2").should("not.exist");
});
diff --git a/e2e/test/scenarios/organization/bookmarks-question.cy.spec.js b/e2e/test/scenarios/organization/bookmarks-question.cy.spec.js
index 045ecf9de27..89f4805abc1 100644
--- a/e2e/test/scenarios/organization/bookmarks-question.cy.spec.js
+++ b/e2e/test/scenarios/organization/bookmarks-question.cy.spec.js
@@ -1,19 +1,34 @@
const { H } = cy;
-import { ORDERS_QUESTION_ID } from "e2e/support/cypress_sample_instance_data";
+import {
+ ORDERS_MODEL_ID,
+ ORDERS_QUESTION_ID,
+} from "e2e/support/cypress_sample_instance_data";
import { toggleQuestionBookmarkStatus } from "./helpers/bookmark-helpers";
-describe("scenarios > question > bookmarks", () => {
+H.describeWithSnowplow("scenarios > question > bookmarks", () => {
beforeEach(() => {
+ H.resetSnowplow();
H.restore();
cy.intercept("/api/bookmark/card/*").as("toggleBookmark");
cy.signInAsAdmin();
+ H.enableTracking();
+ });
+
+ afterEach(() => {
+ H.expectNoBadSnowplowEvents();
});
it("should add, update bookmark name when question name is updated, then remove bookmark from question page", () => {
H.visitQuestion(ORDERS_QUESTION_ID);
toggleQuestionBookmarkStatus();
+ H.expectUnstructuredSnowplowEvent({
+ event: "bookmark_added",
+ event_detail: "question",
+ triggered_from: "qb_action_panel",
+ });
+
H.openNavigationSidebar();
H.navigationSidebar().within(() => {
H.getSidebarSectionTitle(/Bookmarks/);
@@ -59,10 +74,42 @@ describe("scenarios > question > bookmarks", () => {
// Remove bookmark
toggleQuestionBookmarkStatus({ wasSelected: true });
+ H.expectUnstructuredSnowplowEvent(
+ {
+ event: "bookmark_added",
+ event_detail: "question",
+ triggered_from: "qb_action_panel",
+ },
+ 1,
+ );
H.navigationSidebar().within(() => {
H.getSidebarSectionTitle(/Bookmarks/).should("not.exist");
cy.findByText("Orders 2").should("not.exist");
});
});
+
+ it("should bookmark a model", () => {
+ H.visitModel(ORDERS_MODEL_ID);
+
+ toggleQuestionBookmarkStatus();
+ H.expectUnstructuredSnowplowEvent({
+ event: "bookmark_added",
+ event_detail: "model",
+ triggered_from: "qb_action_panel",
+ });
+
+ cy.log(
+ "Remove a bookmark and expect the number of events to stay the same",
+ );
+ toggleQuestionBookmarkStatus({ wasSelected: true });
+ H.expectUnstructuredSnowplowEvent(
+ {
+ event: "bookmark_added",
+ event_detail: "model",
+ triggered_from: "qb_action_panel",
+ },
+ 1,
+ );
+ });
});
diff --git a/e2e/test/scenarios/organization/helpers/bookmark-helpers.ts b/e2e/test/scenarios/organization/helpers/bookmark-helpers.ts
index 51604182289..a50222d001b 100644
--- a/e2e/test/scenarios/organization/helpers/bookmark-helpers.ts
+++ b/e2e/test/scenarios/organization/helpers/bookmark-helpers.ts
@@ -7,10 +7,8 @@ import {
} from "e2e/support/helpers";
export const toggleQuestionBookmarkStatus = ({ wasSelected = false } = {}) => {
- const iconName = wasSelected ? "bookmark_filled" : "bookmark";
- cy.findByTestId("qb-header-action-panel").within(() => {
- cy.icon(iconName).click();
- });
+ const labelText = wasSelected ? "Remove from bookmarks" : "Bookmark";
+ cy.findByTestId("qb-header-action-panel").findByLabelText(labelText).click();
cy.wait("@toggleBookmark");
};
diff --git a/enterprise/frontend/src/metabase-enterprise/documents/analytics.ts b/enterprise/frontend/src/metabase-enterprise/documents/analytics.ts
index 1a48ce02a6e..7e908cfdd72 100644
--- a/enterprise/frontend/src/metabase-enterprise/documents/analytics.ts
+++ b/enterprise/frontend/src/metabase-enterprise/documents/analytics.ts
@@ -49,3 +49,11 @@ export const trackDocumentPrint = (document?: Document | null) => {
target_id: document?.id || null,
});
};
+
+export const trackDocumentBookmark = () => {
+ trackSimpleEvent({
+ event: "bookmark_added",
+ event_detail: "document",
+ triggered_from: "document_header",
+ });
+};
diff --git a/enterprise/frontend/src/metabase-enterprise/documents/components/DocumentPage.tsx b/enterprise/frontend/src/metabase-enterprise/documents/components/DocumentPage.tsx
index 5f95ca67d1a..d5e4f7c861c 100644
--- a/enterprise/frontend/src/metabase-enterprise/documents/components/DocumentPage.tsx
+++ b/enterprise/frontend/src/metabase-enterprise/documents/components/DocumentPage.tsx
@@ -42,7 +42,11 @@ import type {
RegularCollectionId,
} from "metabase-types/api";
-import { trackDocumentCreated, trackDocumentUpdated } from "../analytics";
+import {
+ trackDocumentBookmark,
+ trackDocumentCreated,
+ trackDocumentUpdated,
+} from "../analytics";
import {
clearDraftCards,
openVizSettingsSidebar,
@@ -248,6 +252,11 @@ export const DocumentPage = ({
if (!documentId) {
return;
}
+
+ if (!isBookmarked) {
+ trackDocumentBookmark();
+ }
+
isBookmarked
? deleteBookmark({ type: "document", id: documentId })
: createBookmark({ type: "document", id: documentId });
diff --git a/frontend/src/metabase-types/analytics/event.ts b/frontend/src/metabase-types/analytics/event.ts
index 2a84a7cbcae..b70b4254e43 100644
--- a/frontend/src/metabase-types/analytics/event.ts
+++ b/frontend/src/metabase-types/analytics/event.ts
@@ -427,6 +427,50 @@ export type MetadataEditEvent = ValidateEvent<{
triggered_from: "admin";
}>;
+export type BookmarkQuestionEvent = ValidateEvent<{
+ event: "bookmark_added";
+ event_detail: "question";
+ triggered_from: "qb_action_panel" | "collection_list";
+}>;
+
+export type BookmarkModelEvent = ValidateEvent<{
+ event: "bookmark_added";
+ event_detail: "model";
+ triggered_from: "qb_action_panel" | "collection_list";
+}>;
+
+export type BookmarkMetricEvent = ValidateEvent<{
+ event: "bookmark_added";
+ event_detail: "metric";
+ triggered_from: "qb_action_panel" | "collection_list" | "browse_metrics";
+}>;
+
+export type BookmarkDashboardEvent = ValidateEvent<{
+ event: "bookmark_added";
+ event_detail: "dashboard";
+ triggered_from: "dashboard_header" | "collection_list";
+}>;
+
+export type BookmarkCollectionEvent = ValidateEvent<{
+ event: "bookmark_added";
+ event_detail: "collection";
+ triggered_from: "collection_header" | "collection_list";
+}>;
+
+export type BookmarkDocumentEvent = ValidateEvent<{
+ event: "bookmark_added";
+ event_detail: "document";
+ triggered_from: "collection_list" | "document_header";
+}>;
+
+export type BookmarkEvent =
+ | BookmarkQuestionEvent
+ | BookmarkModelEvent
+ | BookmarkMetricEvent
+ | BookmarkDashboardEvent
+ | BookmarkCollectionEvent
+ | BookmarkDocumentEvent;
+
export type SimpleEvent =
| CustomSMTPSetupClickedEvent
| CustomSMTPSetupSuccessEvent
@@ -476,4 +520,5 @@ export type SimpleEvent =
| MetabotEvent
| RevertVersionEvent
| LearnAboutDataClickedEvent
- | MetadataEditEvent;
+ | MetadataEditEvent
+ | BookmarkEvent;
diff --git a/frontend/src/metabase/browse/metrics/MetricsTable.tsx b/frontend/src/metabase/browse/metrics/MetricsTable.tsx
index d824bba9674..061d7574b99 100644
--- a/frontend/src/metabase/browse/metrics/MetricsTable.tsx
+++ b/frontend/src/metabase/browse/metrics/MetricsTable.tsx
@@ -45,6 +45,7 @@ import {
TableRow,
} from "../components/BrowseTable.styled";
+import { trackMetricBookmarked } from "./analytics";
import type { MetricResult, SortColumn } from "./types";
import { getMetricDescription, sortMetrics } from "./utils";
@@ -360,6 +361,8 @@ function MenuCell({ metric }: { metric?: MetricResult }) {
id: metric.id,
type: "card",
});
+
+ trackMetricBookmarked();
dispatch(Bookmarks.actions.invalidateLists());
},
});
diff --git a/frontend/src/metabase/browse/metrics/analytics.ts b/frontend/src/metabase/browse/metrics/analytics.ts
index 34b42475f19..e6278a71f4e 100644
--- a/frontend/src/metabase/browse/metrics/analytics.ts
+++ b/frontend/src/metabase/browse/metrics/analytics.ts
@@ -5,3 +5,11 @@ export const trackNewMetricInitiated = () =>
event: "plus_button_clicked",
triggered_from: "metric",
});
+
+export const trackMetricBookmarked = () => {
+ trackSimpleEvent({
+ event: "bookmark_added",
+ event_detail: "metric",
+ triggered_from: "browse_metrics",
+ });
+};
diff --git a/frontend/src/metabase/collections/analytics.ts b/frontend/src/metabase/collections/analytics.ts
index cb56837695c..7fc04461c46 100644
--- a/frontend/src/metabase/collections/analytics.ts
+++ b/frontend/src/metabase/collections/analytics.ts
@@ -1,7 +1,49 @@
import { trackSimpleEvent } from "metabase/lib/analytics";
+import type { CollectionItem } from "metabase-types/api/collection";
export const trackDataReferenceClicked = () => {
trackSimpleEvent({
event: "learn_about_our_data_clicked",
});
};
+
+export const trackCollectionBookmarked = () => {
+ trackSimpleEvent({
+ event: "bookmark_added",
+ event_detail: "collection",
+ triggered_from: "collection_header",
+ });
+};
+
+export const trackCollectionItemBookmarked = (item: CollectionItem) => {
+ if (item.model === "indexed-entity" || item.model === "snippet") {
+ return;
+ }
+
+ const analyticsModel = item.model;
+
+ const getEntityForAnalytics = (
+ analyticsModel:
+ | "metric"
+ | "dashboard"
+ | "collection"
+ | "dataset"
+ | "document"
+ | "card",
+ ) => {
+ switch (analyticsModel) {
+ case "card":
+ return "question";
+ case "dataset":
+ return "model";
+ default:
+ return analyticsModel;
+ }
+ };
+
+ trackSimpleEvent({
+ event: "bookmark_added",
+ event_detail: getEntityForAnalytics(analyticsModel),
+ triggered_from: "collection_list",
+ });
+};
diff --git a/frontend/src/metabase/collections/components/ActionMenu/ActionMenu.tsx b/frontend/src/metabase/collections/components/ActionMenu/ActionMenu.tsx
index 9188a54866b..6b854e348c8 100644
--- a/frontend/src/metabase/collections/components/ActionMenu/ActionMenu.tsx
+++ b/frontend/src/metabase/collections/components/ActionMenu/ActionMenu.tsx
@@ -4,6 +4,7 @@ import { push } from "react-router-redux";
import { t } from "ttag";
import { HACK_getParentCollectionFromEntityUpdateAction } from "metabase/archive/utils";
+import { trackCollectionItemBookmarked } from "metabase/collections/analytics";
import type {
CreateBookmark,
DeleteBookmark,
@@ -113,8 +114,13 @@ function ActionMenu({
if (!createBookmark && !deleteBookmark) {
return undefined;
}
+
const handler = () => {
const toggleBookmark = isBookmarked ? deleteBookmark : createBookmark;
+
+ if (!isBookmarked) {
+ trackCollectionItemBookmarked(item);
+ }
toggleBookmark?.(item.id.toString(), normalizeItemModel(item));
};
return handler;
diff --git a/frontend/src/metabase/collections/components/CollectionContent/CollectionContentView.tsx b/frontend/src/metabase/collections/components/CollectionContent/CollectionContentView.tsx
index 3a5c1644fe3..19148d2bd9a 100644
--- a/frontend/src/metabase/collections/components/CollectionContent/CollectionContentView.tsx
+++ b/frontend/src/metabase/collections/components/CollectionContent/CollectionContentView.tsx
@@ -6,6 +6,7 @@ import { t } from "ttag";
import ErrorBoundary from "metabase/ErrorBoundary";
import { deletePermanently } from "metabase/archive/actions";
import { ArchivedEntityBanner } from "metabase/archive/components/ArchivedEntityBanner";
+import { trackCollectionBookmarked } from "metabase/collections/analytics";
import { CollectionBulkActions } from "metabase/collections/components/CollectionBulkActions";
import {
type CollectionContentTableColumn,
@@ -171,6 +172,7 @@ const CollectionContentViewInner = ({
const handleCreateBookmark = () => {
createBookmark(collectionId.toString(), "collection");
+ trackCollectionBookmarked();
};
const handleDeleteBookmark = () => {
diff --git a/frontend/src/metabase/dashboard/analytics.ts b/frontend/src/metabase/dashboard/analytics.ts
index 799e2a75318..074d333b451 100644
--- a/frontend/src/metabase/dashboard/analytics.ts
+++ b/frontend/src/metabase/dashboard/analytics.ts
@@ -180,3 +180,11 @@ export const trackFilterMoved = (
event_detail: destination,
});
};
+
+export const trackDashboardBookmarked = () => {
+ trackSimpleEvent({
+ event: "bookmark_added",
+ event_detail: "dashboard",
+ triggered_from: "dashboard_header",
+ });
+};
diff --git a/frontend/src/metabase/dashboard/components/DashboardBookmark.tsx b/frontend/src/metabase/dashboard/components/DashboardBookmark.tsx
index fdd005fad5b..a846c53cef0 100644
--- a/frontend/src/metabase/dashboard/components/DashboardBookmark.tsx
+++ b/frontend/src/metabase/dashboard/components/DashboardBookmark.tsx
@@ -6,6 +6,8 @@ import { useDispatch } from "metabase/lib/redux";
import { useRegisterShortcut } from "metabase/palette/hooks/useRegisterShortcut";
import type { DashboardId, Bookmark as IBookmark } from "metabase-types/api";
+import { trackDashboardBookmarked } from "../analytics";
+
export interface DashboardBookmarkProps {
isBookmarked: boolean;
}
@@ -26,6 +28,7 @@ export const DashboardBookmark = (): JSX.Element | null => {
if (dashboard) {
const id = dashboard.id;
dispatch(Bookmark.actions.create({ id, type: "dashboard" }));
+ trackDashboardBookmarked();
}
};
diff --git a/frontend/src/metabase/query_builder/analytics.js b/frontend/src/metabase/query_builder/analytics.js
index a3664f54a34..e0742310bd6 100644
--- a/frontend/src/metabase/query_builder/analytics.js
+++ b/frontend/src/metabase/query_builder/analytics.js
@@ -93,3 +93,11 @@ export const trackFirstNonTableChartGenerated = (card) => {
event_detail: card.display,
});
};
+
+export const trackCardBookmarkAdded = (card) => {
+ trackSimpleEvent({
+ event: "bookmark_added",
+ event_detail: card.type,
+ triggered_from: "qb_action_panel",
+ });
+};
diff --git a/frontend/src/metabase/query_builder/containers/QueryBuilder.tsx b/frontend/src/metabase/query_builder/containers/QueryBuilder.tsx
index e9326f4f000..a2967b14f84 100644
--- a/frontend/src/metabase/query_builder/containers/QueryBuilder.tsx
+++ b/frontend/src/metabase/query_builder/containers/QueryBuilder.tsx
@@ -38,6 +38,7 @@ import type {
import type { QueryBuilderUIControls, State } from "metabase-types/store";
import * as actions from "../actions";
+import { trackCardBookmarkAdded } from "../analytics";
import { View } from "../components/view/View";
import { VISUALIZATION_SLOW_TIMEOUT } from "../constants";
import {
@@ -301,13 +302,15 @@ function QueryBuilderInner(props: QueryBuilderInnerProps) {
);
const onClickBookmark = () => {
- const {
- card: { id },
- } = props;
+ const { card } = props;
const toggleBookmark = isBookmarked ? deleteBookmark : createBookmark;
- toggleBookmark(id);
+ if (!isBookmarked) {
+ trackCardBookmarkAdded(card);
+ }
+
+ toggleBookmark(card.id);
};
/**