本参考资料描述了 /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: 文档在搜索结果列表中的位置