向分析集合发布事件

编辑

此功能处于 Beta 版阶段,可能会发生更改。其设计和代码不如官方 GA 功能成熟,按原样提供,不提供任何担保。Beta 版功能不受官方 GA 功能的支持 SLA 的约束。

将事件发布到行为分析集合。

请求

编辑

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

路径参数

编辑
<collection_name>
(必需,字符串) 您想要摄取事件的分析集合名称。
<event_type>
(必需,字符串) 分析事件类型。可以是 page_viewsearchsearch_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",
    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"
        }
    },
)
print(resp)
const response = await client.searchApplication.postBehavioralAnalyticsEvent({
  collection_name: "my_analytics_collection",
  event_type: "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"
  }
}