Spec-Zone.ru › Elasticsearch 8
›Elasticsearch Руководство [8.17] ›REST API ›API аналитики поведения

Отправка события в коллекцию аналитики

Эта функциональность находится в бета-версии и может быть изменена. Дизайн и код менее зрелые, чем у официальных функций GA, и предоставляются как есть без каких-либо гарантий. Бета-функции не подпадают под SLA поддержки официальных функций GA.

Новая справка по API

Для получения самых актуальных данных об API обратитесь к API аналитики поведения.

Отправьте событие в коллекцию аналитики поведения.

Запрос

POST _application/analytics/<collection_name>/event/<event_type>

Параметры пути

<collection_name>
(Обязательно, строка) Имя коллекции аналитики, в которую нужно внести событие.
<event_type>
(Обязательно, строка) Тип события аналитики. Может быть одним из page_view, search, search_click.

Тело запроса

Полные параметры тела запроса можно найти в: Справочнике по событиям.

Предварительные условия

Требуется привилегия кластера post_behavioral_analytics_event.

Коды ответов

202
Событие принято и будет обработано.
404
Коллекция аналитики <collection_name> не существует.
400
Возникает, либо когда тип события неизвестен, либо когда содержимое события содержит недопустимые данные.

Примеры

Следующий пример отправляет событие search_click в коллекцию аналитики, называемую my_analytics_collection:

resp = client.search_application.post_behavioral_analytics_event(
    collection_name="my_analytics_collection",
    event_type="search_click",
    payload={
        "session": {
            "id": "1797ca95-91c9-4e2e-b1bd-9c38e6f386a9"
        },
        "user": {
            "id": "5f26f01a-bbee-4202-9298-81261067abbd"
        },
        "search": {
            "query": "search term",
            "results": {
                "items": [
                    {
                        "document": {
                            "id": "123",
                            "index": "products"
                        }
                    }
                ],
                "total_results": 10
            },
            "sort": {
                "name": "relevance"
            },
            "search_application": "website"
        },
        "document": {
            "id": "123",
            "index": "products"
        }
    },
)
print(resp)
const response = await client.transport.request({
  method: "POST",
  path: "/_application/analytics/my_analytics_collection/event/search_click",
  body: {
    session: {
      id: "1797ca95-91c9-4e2e-b1bd-9c38e6f386a9",
    },
    user: {
      id: "5f26f01a-bbee-4202-9298-81261067abbd",
    },
    search: {
      query: "search term",
      results: {
        items: [
          {
            document: {
              id: "123",
              index: "products",
            },
          },
        ],
        total_results: 10,
      },
      sort: {
        name: "relevance",
      },
      search_application: "website",
    },
    document: {
      id: "123",
      index: "products",
    },
  },
});
console.log(response);
POST _application/analytics/my_analytics_collection/event/search_click
{
  "session": {
    "id": "1797ca95-91c9-4e2e-b1bd-9c38e6f386a9"
  },
  "user": {
    "id": "5f26f01a-bbee-4202-9298-81261067abbd"
  },
  "search":{
    "query": "search term",
    "results": {
      "items": [
        {
          "document": {
            "id": "123",
            "index": "products"
          }
        }
      ],
      "total_results": 10
    },
    "sort": {
      "name": "relevance"
    },
    "search_application": "website"
  },
  "document":{
    "id": "123",
    "index": "products"
  }
}

© 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/post-analytics-collection-event.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API