Skip to content

Commit d578685

Browse files
minor fixes
1 parent 527db41 commit d578685

File tree

4 files changed

+17
-13
lines changed

4 files changed

+17
-13
lines changed

learn/analytics/analytics_metrics_reference.mdx

Lines changed: 9 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -5,11 +5,11 @@ description: This reference describes the metrics you can find in the Meilisearc
55

66
## Total searches
77

8-
Total number of searches made in the selected indexes during the specified period. Multi-search and federated search requests count as a single search.
8+
Total number of searches made during the specified period. Multi-search and federated search requests count as a single search.
99

1010
## Total users
1111

12-
Total number of users who performed a search in the selected indexes.
12+
Total number of users who performed a search in the specified period.
1313

1414
Include the [user ID](/learn/analytics/bind_events_user) in your search request headers for the most accurate metrics. If search requests do not provide any user ID, the total amount of unique users will increase, as each request is assigned to a unique user ID.
1515

@@ -31,9 +31,13 @@ Meilisearch does not have access to this information by default. You must [confi
3131

3232
## Conversion
3333

34-
The percentage of searches resulting in a [conversion event](/learn/analytics/configure_analytics_events) in your application. Conversion events vary depending on your application and indicate a user has performed a specific desired action. For example, a conversion for an e-commerce website might mean a user has bought a product.
34+
The percentage of searches resulting in a conversion event in your application. Conversion events vary depending on your application and indicate a user has performed a specific desired action. For example, a conversion for an e-commerce website might mean a user has bought a product.
3535

36-
You must explicitly configure your application to send conversion events when conditions are met.
36+
You must explicitly [configure your application to send conversion](/learn/analytics/configure_analytics_events) events when conditions are met.
37+
38+
<Note>
39+
It is not possible to associate multiple `conversion` events with the same query.
40+
</Note>
3741

3842
## Search requests
3943

@@ -53,4 +57,4 @@ Most common query terms that did not return any search results.
5357

5458
## Countries with most searches
5559

56-
List of countries that generate the largest amount of search requests.
60+
List of countries that generate the largest amount of search requests.

learn/analytics/bind_events_user.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ You can assign user IDs to search requests by including an `X-MS-USER-ID` header
2424
Replace `SEARCH_USER_ID` with any value that uniquely identifies that user. This may be an authenticated user's ID when running searches from your own back end, or a hash of the user's IP address.
2525

2626
<Note>
27-
Assigning user IDs to search requests is optional. If a Meilisearch Cloud search request does not have an ID, Meilisearch will automaticalle generate one.
27+
Assigning user IDs to search requests is optional. If a Meilisearch Cloud search request does not have an ID, Meilisearch will automatically generate one.
2828
</Note>
2929

3030
## Assign user IDs to analytics events

learn/analytics/configure_analytics_events.mdx

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -14,21 +14,21 @@ You must have a [Meilisearch Cloud](https://meilisearch.com/cloud) account to ac
1414

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

17-
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:
17+
Every time a user clicks on a search result, your application must send a `click` event to the `POST` endpoint of Meilisearch Cloud's `/events` route:
1818

1919
<CodeSamplesAnalyticsEventClick1 />
2020

21-
You must explicitly submit a `userId` associated with the event. This can be any arbitrary string you can use to identify the user, such as their profile ID in your application or their hashed IP address. You may submit user IDs directly on the event payload, or setting a `X-MS-USER-ID` request header.
21+
You must explicitly submit a `userId` associated with the event. This can be any arbitrary string you use to identify the user, such as their profile ID in your application or their hashed IP address. You may submit user IDs directly on the event payload, or setting a `X-MS-USER-ID` request header.
2222

23-
Specifying a `queryUid` is optional but recommended as it ensures Meilisearch correctly associates the search query with the event. You can find the query UID in the `metadata` field present in Meilisearch Cloud's search query response.
23+
Specifying a `queryUid` is optional but recommended as it ensures Meilisearch correctly associates the search query with the event. You can find the query UID in the [`metadata` field present in Meilisearch Cloud's search query responses](/reference/api/overview#search-metadata).
2424

2525
For more information, consult the [analytics events endpoint reference](/learn/analytics/events_endpoint).
2626

2727
## Configure conversion rate
2828

29-
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.
29+
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.
3030

31-
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:
31+
Once you have established what is a conversion in your application, configure it to send a `conversion` event to the `POST` endpoint of Meilisearch Cloud analytics route:
3232

3333
<CodeSamplesAnalyticsEventConversion1 />
3434

learn/analytics/events_endpoint.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -37,12 +37,12 @@ Send an analytics event to Meilisearch Cloud.
3737
```
3838

3939
<Note>
40-
You must provide a string identifying your user if you want Meilisearch Cloud to track analytics and click events.
40+
You must provide a string identifying your user if you want Meilisearch Cloud to track conversion and click events.
4141

4242
You may do that in two ways:
4343

4444
- Specify the user ID in the payload, using the `userId` field
45-
- Specify the user ID with the `X-MS-USER-ID` header when sending search and other analytics events
45+
- Specify the user ID with the `X-MS-USER-ID` header with your `/events` and search requests
4646
</Note>
4747

4848
#### Example

0 commit comments

Comments
 (0)