Analytics events endpoint

This reference describes /events, the endpoint you should use to submit analytics events to Meilisearch Cloud. It also describes the accepted event objects and the data you must include in them.

Use /events to submit analytics events such as click and conversion to Meilisearch Cloud.

Send an event

Send an analytics event to Meilisearch Cloud.

Body

Name	Type	Default value	Description
eventType	String	N/A	The event type, such as click or conversion, required
eventName	String	N/A	A string describing the event, required
indexUid	String	N/A	The name of the index of the clicked document, required
queryUid	String	N/A	The search query’s UID
objectId	String	N/A	The clicked document’s primary key value
objectName	String	N/A	A string describing the document
position	Integer	N/A	An integer indicating the clicked document’s position in the search result list
userId	String	N/A	An arbitrary string identifying the user who performed the action

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

You must provide a string identifying your user if you want Meilisearch Cloud to track conversion and click events.

You may do that in two ways:

• Specify the user ID in the payload, using the userId field
• Specify the user ID with the X-MS-USER-ID header with your /events and search requests

Example

Response: 201 Created