Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

✨ log explorer views to google analytics #4098

Merged
merged 1 commit into from
Nov 1, 2024
Merged

✨ log explorer views to google analytics #4098

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 27 additions & 0 deletions explorer/Explorer.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,7 @@ import {
SlideShowController,
SlideShowManager,
DEFAULT_GRAPHER_ENTITY_TYPE,
GrapherAnalytics,
} from "@ourworldindata/grapher"
import {
Bounds,
Expand Down Expand Up @@ -189,6 +190,8 @@ export class Explorer
EntityPickerManager,
GrapherManager
{
analytics = new GrapherAnalytics()

// caution: do a ctrl+f to find untyped usages
static renderSingleExplorerOnExplorerPage(
program: ExplorerProps,
Expand Down Expand Up @@ -272,6 +275,24 @@ export class Explorer
return new Map(arr.map((config) => [config.id!, config]))
}

private setUpIntersectionObserver(): void {
if (typeof window !== "undefined" && "IntersectionObserver" in window) {
const observer = new IntersectionObserver((entries) => {
entries.forEach((entry) => {
if (entry.isIntersecting) {
this.analytics.logExplorerView(
this.explorerProgram.slug,
this.explorerProgram.decisionMatrix.currentParams
)
observer.disconnect()
}
})
})
observer.observe(this.grapherContainerRef.current!)
this.disposers.push(() => observer.disconnect())
}
}

disposers: (() => void)[] = []
componentDidMount() {
this.setGrapher(this.grapherRef!.current!)
Expand All @@ -291,6 +312,7 @@ export class Explorer
this.grapher?.populateFromQueryParams(url.queryParams)

exposeInstanceOnWindow(this, "explorer")
this.setUpIntersectionObserver()
this.attachEventListeners()
this.updateEntityPickerTable() // call for the first time to initialize EntityPicker
}
Expand Down Expand Up @@ -415,6 +437,11 @@ export class Explorer
: tabsWithoutTable[0] ?? GrapherTabOption.table

this.grapher.populateFromQueryParams(newGrapherParams)

this.analytics.logExplorerView(
this.explorerProgram.slug,
this.explorerProgram.decisionMatrix.currentParams
)
}

@action.bound private setGrapherTable(table: OwidTable) {
Expand Down
11 changes: 11 additions & 0 deletions packages/@ourworldindata/grapher/src/core/GrapherAnalytics.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@ export enum EventCategory {
GrapherView = "owid.grapher_view",
GrapherClick = "owid.grapher_click",
GrapherError = "owid.grapher_error",
ExplorerView = "owid.explorer_view",
ExplorerCountrySelector = "owid.explorer_country_selector",
Hover = "owid.hover",
KeyboardShortcut = "owid.keyboard_shortcut",
Expand Down Expand Up @@ -50,6 +51,8 @@ interface GAEvent {
eventTarget?: string
grapherPath?: string
grapherView?: string // specifies a view in a multi-dim data page
explorerPath?: string
explorerView?: string
}

// taken from https://github.com/DefinitelyTyped/DefinitelyTyped/blob/de66435d18fbdb2684947d16b5cd3a77f876324c/types/gtag.js/index.d.ts#L151-L156
Expand Down Expand Up @@ -97,6 +100,14 @@ export class GrapherAnalytics {
})
}

logExplorerView(slug: string, view: Record<string, string>): void {
this.logToGA({
event: EventCategory.ExplorerView,
explorerPath: `/explorers/${slug}`,
explorerView: JSON.stringify(view),
})
}

logGlobalEntitySelector(action: entityControlEvent, note?: string): void {
this.logToGA({
event: EventCategory.GlobalEntitySelectorUsage,
Expand Down