分析事件端点

    本参考描述了 /events,即您应用于向 Meilisearch Cloud 提交分析事件的端点。它还描述了可接受的事件对象以及您必须包含在其中的数据。

    /events 端点

    /events 端点仅适用于已启用分析和监控的 Meilisearch Cloud 项目。

    发送事件

    POSThttps://edge.meilisearch.com/events

    向 Meilisearch Cloud 发送分析事件。接受 clickconversion 事件。

    将分析事件绑定到用户

    默认情况下,Meilisearch 将分析事件与触发它们的用户的最新搜索相关联。在您的搜索和事件请求中包含相同的 X-MS-USER-ID 标头以手动 将分析事件绑定到用户

    示例

    curl \
      -X POST 'https://edge.meilisearch.com/events' \
      -H 'Content-Type: application/json' \
      -H 'Authorization: Bearer DEFAULT_SEARCH_API_KEY' \
      --data-binary '{
        "eventType": "click",
        "eventName": "Search Result Clicked",
        "indexUid": "products",
        "objectId": "0",
        "position": 0
      }'
    响应:201 Created

    click 事件对象

    click 事件必须传递具有以下字段的对象

    {
      "eventType": "click",
      "eventName": "Search Result Clicked",
      "indexUid": "products",
      "objectId": "0",
      "position": 0
    }
    

    conversion 事件对象

    conversion 事件必须传递具有以下字段的对象

    {
      "eventType": "conversion",
      "eventName": "Product Added To Cart",
      "indexUid": "products",
      "objectID": "0",
      "position": 0
    }