本参考文档描述了 /events 端点，该端点用于向 Meilisearch Cloud 提交分析事件。同时详细说明了可接受的事件对象及其必须包含的数据内容。

​
/events 端点

/events 端点仅对已启用分析和监控功能的 Meilisearch Cloud 项目开放。

​
发送事件

POST https://edge.meilisearch.com/events

向 Meilisearch Cloud 发送分析事件。接受 click 和 conversion 两种事件类型。

默认情况下，Meilisearch 会将分析事件与触发该事件的用户最近一次搜索相关联。如需手动将分析事件绑定到用户，请在搜索请求和事件请求中包含相同的 X-MS-USER-ID 请求头。

​
示例

响应: 201 Created

​
click 事件对象

click 事件必须传递包含以下字段的对象：

{
  "eventType": "click",
  "eventName": "Search Result Clicked",
  "indexUid": "products",
  "objectId": "0",
  "position": 0
}
  • eventType: 标识此为 click 事件的字符串
  • eventName: 描述事件的字符串
  • indexUid: 标识被点击文档所属索引的字符串
  • objectId: 标识被点击文档主键的字符串
  • position: 表示被点击文档在搜索结果列表中位置的整数

​
conversion 事件对象

conversion 事件必须传递包含以下字段的对象：

{
  "eventType": "conversion",
  "eventName": "Product Added To Cart",
  "indexUid": "products",
  "objectID": "0",
  "position": 0
}
  • eventType: 表示这是一个 conversion 事件
  • eventName: 描述事件的字符串
  • indexUid: 文档所属的索引
  • objectID: 文档的主键
  • position: 文档在搜索结果列表中的位置