› › ›

Behavioral Analytics API overview

This page outlines all the APIs available for behavioral analytics and links to their documentation.

Behavioral Analytics REST APIs

Behavioral Analytics relies on a number of Elasticsearch APIs to manage analytics collections. Refer to the API documentation for the details.

Behavioral Analytics Clients

Behavioral Analytics integrates onto your website using one of our JavaScript clients:

Browser tracker - integrated into your website using a <script> tag.
- View the README in GitHub.
Javascript Tracker - integrated into your website using a JavaScript module.
- View the README in GitHub.

Search UI integration

To simplify the integration of Behavioral Analytics into your website, we provide a Search UI integration. This integration automatically sends Behavioral Analytics events to your collection as your customer interacts with your search experience.

Refer to the Search UI analytics plugin documentation.

Searchkit integration

Behavioral Analytics also integrates with Searchkit, an open source library for building UIs on top of Elasticsearch.

© 2023-2025 Elasticsearch
As of September 2024, Elasticsearch is available under a choice of three licenses: the Server Side Public License (SSPL), the Elastic License, or the AGPLv3 (OSI approved).
Elasticsearch and the Elasticsearch logo are trademarks of Elasticsearch B.V., registered in the U.S. and in other countries.
https://www.elastic.co/guide/en/elasticsearch/reference/8.17/behavioral-analytics-api.html