Analytics

Enable Meilisearch Cloud analytics to help you understand how users search in your application.

You must have a Meilisearch Cloud account to access search analytics.

Log into your Meilisearch Cloud account and navigate to your project's overview. Find the "Analytics and monitoring" section and click on the "Enable analytics and monitoring" button:

Meilisearch Cloud will begin processing your request. The "Analytics and monitoring" section will update when the feature is enabled.

When you enable analytics, Meilisearch Cloud changes your project's API URL. Meilisearch Cloud is only able to track metrics for queries sent to this URL.

Update your application so all API requests point to the new URL:

curl \
  -X POST 'https://edge.meilisearch.com/indexes/products/search' \
  -H 'Content-Type: application/json' \
  --data-binary '{ "q": "green socks" }'

The previous API URL will remain functional, but requests targeting it will not send any data to the analytics interface. If you created any custom API keys using the previous URL, you will need to replace them.

To track metrics like click-through rate and average click position, Meilisearch Cloud needs to know when users click on search results.

Every time a user clicks on a search result, your application must send a click event to the POST endpoint of Meilisearch Cloud analytics route:

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
  }'

The click event must deliver an object with the following fields:

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

• eventType: a string indicating this is a click event
• eventName: a string describing the event
• indexUid: a string indicating the clicked document's index
• objectId: a string indicating the clicked document's primary key
• position: an integer indicating the clicked document's position in the list of search results

To track conversion rate, first identify what should count as a conversion for your application. For example, in a web shop, a conversion might be a user finalizing the checkout process.

Once you have established what counts as a conversion in your application, configure it to send a conversion event to the POST endpoint of Meilisearch Cloud analytics route:

curl \
  -X POST 'https://edge.meilisearch.com/events' \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Bearer Meilisearch_API_Key'
  --data-binary '{
    "eventType": "conversion",
    "eventName": "Product Added To Cart",
    "indexUid": "products",
    "objectId": "0",
    "position": 0
  }'

It is not possible to associate multiple conversion events with the same search.

The conversion event must deliver an object with the following fields:

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

• eventType: indicates this is a conversion event
• eventName: a string describing the event
• indexUid: the document's index
• objectID: the document's primary key
• position: the document's position in the list of search results

Log into your Meilisearch Cloud account and navigate to your project's overview. Find the "Analytics and monitoring" section and press the "Disable analytics and monitoring" button:

Disabling analytics changes your API URL. Update your application so all API requests point to the correct URL:

curl \
  -X POST 'https://PROJECT_URL/indexes/products/search' \
  -H 'Content-Type: application/json' \
  --data-binary '{ "q": "green socks" }'

The previous API URL will remain functional, but Meilisearch recommends not using it after disabling analytics in your project. If you created any custom API keys using the previous URL, you will need to replace them.

Update your application so it is no longer sending conversion and click events to Meilisearch Cloud.