Add plugin for Matomo to track site search keywords #17
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Use the plugins API for autocomplete, hook into the state change, retrieve the query term from the use, and send the query term together with the search results from the global context to Matomo. * autocomplete plugins: https://www.algolia.com/doc/ui-libraries/autocomplete/core-concepts/plugins/ * autocomplete state: https://www.algolia.com/doc/ui-libraries/autocomplete/core-concepts/state/ * autocomplete access data with context: https://www.algolia.com/doc/ui-libraries/autocomplete/core-concepts/context/ https://developer.matomo.org/guides/tracking-javascript-guide#internal-search-tracking Relates to typesense#16
The Matomo plugin only sends data under the following conditions: * The modal UI is opened * The query string has length greater than 0 * The query term wasn't used before Increase debounce limit to 500 ms.
To activate the Matomo plugin, add `matomoSearchAnalytics: true` to the properties in the call to the docsearch function. Per default, the plugin is deactivated.
Only send search terms when they have a least three characters of length. Otherwise, search analytics is cluttered with strings of no further use. Refs typesense#4
ngulden
force-pushed
the
ngulden/matomo-plugin
branch
from
8165cd5
to
1a73cc3
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Change Summary
Use the plugins API for autocomplete, hook into the state change, retrieve the query term from the use, and send the query term together with the search results from the global context to Matomo.
https://developer.matomo.org/guides/tracking-javascript-guide#internal-search-tracking
Relates to #16
The implementation requires that the Matomo tracking code is already part of the web page that calls the docsearch modal. It just references it and adds the call for the Matomo site search.
To use the plugin, you need to add
matomoSearchAnalytics: trueto the properties for thedocsearch()function.PR Checklist