返回首頁v1.12文件

    分析事件端點

    此參考資料說明 /events 端點，您應該使用此端點將分析事件提交至 Meilisearch Cloud。它也說明了接受的事件物件以及您必須包含在其中的資料。

    /events 端點

    /events 端點僅適用於啟用分析和監控的 Meilisearch Cloud 專案。

    傳送事件
    POSThttps://edge.meilisearch.com/events

    將分析事件傳送至 Meilisearch Cloud。接受 click 和 conversion 事件。

    將分析事件綁定至使用者

    預設情況下，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
}