This documentation contains work-in-progress information for future Elastic Stack and Cloud releases. Use the version selector to view supported release docs. It also contains some Elastic Cloud serverless information. Check out our serverless docs for more details.
« Build a search experience with the Search Application client Get started with Behavioral Analytics »
Elastic Docs ›Elasticsearch Guide [master] ›Search your data

Search analytics

edit

Search analytics

edit

Behavioral Analytics is an analytics event collection platform. Use these tools to analyze your users' searching and clicking behavior. Leverage this information to improve the relevance of your search results and identify gaps in your content.

Get started by embedding one of our JavaScript clients on your website or application and instrumenting the user actions you want to track. For example, you can track when a user searches, when they click on a search result, or when a user visits a particular page on your website.

Data and analytics are stored in Elasticsearch indices, for advanced analysis and visualization.

Even if you don’t use Elastic for search, you can use these tools to collect analytics from your application/website.

Availability and prerequisites

edit

Behavioral Analytics is a beta feature. Beta features are subject to change and are not covered by the support SLA of general release (GA) features. Elastic plans to promote this feature to GA in a future release.

Expand to learn about version history
  • Behavioral Analytics was introduced in Elastic 8.7.0 to the Enterprise Search service.
  • There was a breaking schema change in 8.8.0. (See Migrating from 8.7 to 8.8 in the Search documentation if you’re upgrading from 8.7 to 8.8.)
  • The feature was moved to Elasticsearch in 8.10, meaning the Enterprise Search service is no longer required as of 8.10.

Analytics are available to all Elastic Cloud users.

Analytics are also available to self-managed deployments that satisfy subscription requirements. View the requirements for this feature under the Elastic Search section of the Elastic Stack subscriptions page.

Your Elastic deployment must include the Elasticsearch and Kibanaservices.

Documentation

edit

The following documentation is available in the Elasticsearch docs:

Additional documentation is available in the following places:

GDPR compliance

Users may be concerned about the privacy implications of analytics data collection. Behavioral Analytics is fully GDPR compliant, because no personal data are collected.

To integrate the behavioral analytics client, session data are stored in two tokens:

  • User Token. A unique identifier for the user. Stored under EA_UID cookie. Default time length is 24 hours from the first time the user visits the site.
  • Session Token. A unique identifier for the session. Stored under EA_SID cookie. Time length is 30 minutes from the last time the user visits the site.

These tokens enable the client to identify a user across sessions. They do not collect sensitive information, such as IP addresses or location data, or any other personal data.

« Build a search experience with the Search Application client Get started with Behavioral Analytics »