GA Events¶

This reference documents all custom Google Analytics (GA4) events tracked on Our World in Data's website and interactive visualizations.

Auto-generated documentation

This documentation is automatically generated from the TypeScript type definitions in analyticsTypes.ts. We are working on improving the source of truth (see #owid-grapher/5730).

Site Events¶

`owid.site_chart_preview_mouseover`¶

Parameter	Type	Required	Description
`eventAction`	`"mouseover"`	✓	Always 'mouseover' for this event
`eventTarget`	`string`	✓	Target chart URL
`eventTargetNext`	`string`		Continuation of eventTarget for URLs > 100 chars (characters 101-200)
`explorerPath`	`string`		Explorer path if in explorer
`grapherPath`	`string`		Grapher path being previewed

TypeScript Interface: SiteChartPreviewMouseoverParams

`owid.site_click`¶

Parameter	Type	Required	Description
`eventAction`	`string`	✓	Action type
`eventTarget`	`string`		Target element or label

TypeScript Interface: SiteClickParams

`owid.site_error`¶

Parameter	Type	Required	Description
`eventAction`	`string`	✓	Action type (e.g., 'not_found')
`eventContext`	`string`	✓	Error details or URL

TypeScript Interface: SiteErrorParams

`owid.site_form_submit`¶

Parameter	Type	Required	Description
`eventAction`	`"newsletter-subscribe" \\| "donate"`	✓	Action type - form submission type
`eventTarget`	`string`		Target element or label

TypeScript Interface: SiteFormSubmitParams

`owid.site_guided_chart_link_click`¶

Parameter	Type	Required	Description
`eventAction`	`"click"`	✓	Always 'click' for this event
`eventTarget`	`string`	✓	Target URL or chart path
`eventTargetNext`	`string`		Continuation of eventTarget for URLs > 100 chars (characters 101-200)
`grapherPath`	`string`		Grapher path of the linked chart (optional - may use eventTarget instead)

TypeScript Interface: SiteGuidedChartLinkClickParams

`owid.site_instantsearch_click`¶

Parameter	Type	Required	Description
`eventAction`	`"click"`	✓	Always 'click' for this event
`eventContext`	`string`	✓	JSON context with query and position
`eventTarget`	`string`	✓	Target URL

TypeScript Interface: SiteInstantSearchClickParams

`owid.site_search`¶

Parameter	Type	Required	Description
`eventAction`	`"search"`	✓	Always 'search' for this event
`searchQuery`	`string`	✓	Search query entered by user
`searchRequireAllCountries`	`boolean`	✓	Whether 'all countries' filter is enabled
`searchResultType`	`string`	✓	Type of results displayed ('all', 'data', 'articles', etc.)
`searchTopics`	`string`	✓	Tilde-separated list of selected topic names
`searchSelectedCountries`	`string`	✓	Tilde-separated list of selected country names

TypeScript Interface: SiteSearchParams

`owid.site_search_autocomplete_click`¶

Parameter	Type	Required	Description
`eventAction`	`"click"`	✓	Always 'click' for this event
`autocompleteQuery`	`string`	✓	Search query when autocomplete was clicked
`autocompletePosition`	`number`	✓	Position of selected suggestion (0-indexed)
`autocompleteFilterType`	`string`	✓	Type of selected filter ('topic'
`autocompleteFilterName`	`string`	✓	Name of the selected filter (e.g., 'France', 'Health')
`autocompleteSuggestions`	`string`	✓	Tilde-separated list of all suggestions shown
`autocompleteSuggestionsTypes`	`string`	✓	Tilde-separated list of suggestion types
`autocompleteSuggestionsCount`	`number`	✓	Total number of suggestions displayed

TypeScript Interface: SiteSearchAutocompleteClickParams

`owid.site_search_result_click`¶

Parameter	Type	Required	Description
`eventAction`	`"click"`	✓	Always 'click' for this event
`eventContext`	`string`	✓	JSON string with context about the clicked result
`eventTarget`	`string`	✓	Target URL of the clicked result

TypeScript Interface: SiteSearchResultClickParams

`owid.site_static_viz_download`¶

Parameter	Type	Required	Description
`eventAction`	`"image_download" \\| "data_download" \\| "source_link_click"`	✓	Type of download action
`eventTarget`	`string`	✓	Name of the static viz
`eventContext`	`string`		Additional context (e.g., 'desktop' or 'mobile' for images, URL for data/source)

TypeScript Interface: SiteStaticVizDownloadParams

Grapher Events¶

`owid.grapher_click`¶

Parameter	Type	Required	Description
`eventAction`	`GrapherImageDownloadEvent \\| string`	✓	Action type - image downloads or generic clicks
`grapherPath`	`string`		Grapher chart path
`grapherPathNext`	`string`		Continuation of grapherPath for URLs > 100 chars (characters 101-200)
`viewConfigId`	`string`		View configuration ID
`narrativeChartName`	`string`		Name of narrative chart
`eventTarget`	`string`		Target element label
`eventContext`	`string`		Additional context as JSON

TypeScript Interface: GrapherClickParams

`owid.grapher_entity_selector`¶

Parameter	Type	Required	Description
`eventAction`	`EntitySelectorEvent`	✓	Entity selector action
`grapherPath`	`string`		Grapher chart path
`grapherPathNext`	`string`		Continuation of grapherPath for URLs > 100 chars (characters 101-200)
`viewConfigId`	`string`		View configuration ID
`narrativeChartName`	`string`		Name of narrative chart
`eventTarget`	`string`		Target entity or note

TypeScript Interface: GrapherEntitySelectorParams

`owid.grapher_error`¶

Parameter	Type	Required	Description
`eventAction`	`"grapher_view_error" \\| "entities_not_found"`	✓	Type of error
`eventContext`	`string`	✓	Error message or details
`grapherPath`	`string`		Grapher chart path
`grapherPathNext`	`string`		Continuation of grapherPath for URLs > 100 chars (characters 101-200)
`viewConfigId`	`string`		View configuration ID
`narrativeChartName`	`string`		Name of narrative chart

TypeScript Interface: GrapherErrorParams

`owid.grapher_hover`¶

Parameter	Type	Required	Description
`eventAction`	`GrapherInteractionEvent`	✓	Type of hover interaction
`grapherPath`	`string`		Grapher chart path
`grapherPathNext`	`string`		Continuation of grapherPath for URLs > 100 chars (characters 101-200)
`viewConfigId`	`string`		View configuration ID
`narrativeChartName`	`string`		Name of narrative chart
`eventTarget`	`string`		Target element (e.g., country name)

TypeScript Interface: GrapherHoverParams

`owid.grapher_view`¶

Parameter	Type	Description
`grapherPath`	`string`	Grapher chart path (e.g., '/grapher/life-expectancy')
`grapherPathNext`	`string`	Continuation of grapherPath for URLs > 100 chars (characters 101-200)
`viewConfigId`	`string`	View configuration ID for multi-dimensional data pages
`narrativeChartName`	`string`	Name of the narrative chart if embedded

TypeScript Interface: GrapherViewParams

Explorer Events¶

`owid.explorer_country_selector`¶

Parameter	Type	Required	Description
`eventAction`	`EntitySelectorEvent`	✓	Entity selector action
`eventContext`	`string`		Additional context
`explorerPath`	`string`		Explorer path

TypeScript Interface: ExplorerCountrySelectorParams

`owid.explorer_view`¶

Parameter	Type	Required	Description
`explorerPath`	`string`	✓	Explorer path (e.g., '/explorers/migration')
`explorerView`	`string`	✓	JSON string of the explorer view state
`viewConfigId`	`string`		Chart config ID of the explorer view

TypeScript Interface: ExplorerViewParams

Shared Events¶

`owid.detail_on_demand`¶

Parameter	Type	Required	Description
`eventAction`	`"show" \\| string`	✓	Action type - typically 'show'
`eventTarget`	`string`	✓	Target element ID
`explorerPath`	`string`		Explorer path if triggered from explorer
`grapherPath`	`string`		Grapher path if triggered from grapher

TypeScript Interface: DetailOnDemandParams

`owid.expander`¶

Parameter	Type	Required	Description
`eventAction`	`"open" \\| "close"`	✓	Action type - 'open' or 'close'
`eventTarget`	`string`	✓	Target element ID
`explorerPath`	`string`		Explorer path if in explorer
`grapherPath`	`string`		Grapher path if in grapher

TypeScript Interface: ExpanderParams

`owid.filter`¶

Parameter	Type	Required	Description
`eventAction`	`"country_page_search"`	✓	Always 'country_page_search' for this event
`eventContext`	`string`	✓	Search query or filter context

TypeScript Interface: FilterParams

`owid.keyboard_shortcut`¶

Parameter	Type	Required	Description
`eventAction`	`string`	✓	The keyboard shortcut name
`eventContext`	`string`	✓	The key combination (e.g., 'Ctrl+K')
`explorerPath`	`string`		Explorer path if in explorer
`grapherPath`	`string`		Grapher path if in grapher

TypeScript Interface: KeyboardShortcutParams

`owid.translate_page`¶

TypeScript Interface: TranslatePageParams

Event Action Types¶

The following type definitions are used across multiple events:

`EntitySelectorEvent`¶

enter
select
deselect
sortBy
sortOrder
filterBy
clear

`GrapherImageDownloadEvent`¶

chart_download_png
chart_download_svg

`GrapherInteractionEvent`¶

map_country_hover: hover over a country in the map or on the globe
map_legend_hover: hover over a legend item on the map tab

`SiteUserSurveyParams`¶

user_role_show
thank_you_show
user_role_submit
free-form
user_role_submit
long-list
short-list
other
feedback_submit
user_role_dismiss
thank_you_dismiss

`UserSurveyExperimentArm`¶

long-list
short-list
free-form

`UserSurveyRoleAnswer`¶

free-form
long-list
short-list

GA Events¶

Site Events¶

owid.site_chart_preview_mouseover¶

owid.site_click¶

owid.site_error¶

owid.site_form_submit¶

owid.site_guided_chart_link_click¶

owid.site_instantsearch_click¶

owid.site_search¶

owid.site_search_autocomplete_click¶

owid.site_search_result_click¶

owid.site_static_viz_download¶

Grapher Events¶

owid.grapher_click¶

owid.grapher_entity_selector¶

owid.grapher_error¶

owid.grapher_hover¶

owid.grapher_view¶