Skip to content

Commit 76401c5

Browse files
added metrics reference
1 parent 2105208 commit 76401c5

File tree

5 files changed

+65
-3
lines changed

5 files changed

+65
-3
lines changed

docs.json

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -209,7 +209,8 @@
209209
"learn/analytics/configure_analytics_events",
210210
"learn/analytics/bind_events_user",
211211
"learn/analytics/migrate_analytics_monitoring",
212-
"learn/analytics/events_endpoint"
212+
"learn/analytics/events_endpoint",
213+
"learn/analytics/analytics_metrics_reference"
213214
]
214215
},
215216
{
Lines changed: 56 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,56 @@
1+
---
2+
title: Analytics metrics reference
3+
description: This reference describes the metrics you can find in the Meilisearch Cloud analytics interface.
4+
---
5+
6+
## Total searches
7+
8+
Total number of searches made in the selected indexes during the specified period.
9+
10+
## Total users
11+
12+
Total number of users who performed a search in the selected indexes.
13+
14+
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.
15+
16+
## No result rate
17+
18+
Percentage of searches that did not return any results.
19+
20+
## Click-through rate
21+
22+
The ratio between the number of times users clicked on a result and the number of times Meilisearch showed that result. Since users will click on results that potentially match what they were looking for, a higher number indicates better relevancy.
23+
24+
Meilisearch does not have access to this information by default. You must [configure your application to submit click events](/learn/analytics/configure_analytics_events) to Meilisearch if you want to track it in the Meilisearch Cloud interface.
25+
26+
## Average click position
27+
28+
The average list position of clicked search results. A lower number means users have clicked on the first search results and indicates good relevancy.
29+
30+
Meilisearch does not have access to this information by default. You must [configure your application to submit click events](/learn/analytics/configure_analytics_events) to Meilisearch if you want to track it in the Meilisearch Cloud interface.
31+
32+
## Conversion
33+
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.
35+
36+
You must explicitly configure your application to send conversion events when conditions are met.
37+
38+
## Search requests
39+
40+
Total number of search requests within the specified time period.
41+
42+
## Search latency
43+
44+
The amount of time between a user making a search request and Meilisearch Cloud returning search results. A lower number indicates users receive search results more quickly.
45+
46+
## Most searched queries
47+
48+
Most common query terms users have used while searching.
49+
50+
## Searches without results
51+
52+
Most common query terms that did not return any search results.
53+
54+
## Countries with most searches
55+
56+
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
@@ -7,7 +7,7 @@ description: This guide shows you how to manually differentiate users across sea
77
import CodeSamplesAnalyticsEventBindSearch1 from '/snippets/samples/code_samples_analytics_event_bind_search_1.mdx';
88
import CodeSamplesAnalyticsEventBindEvent1 from '/snippets/samples/code_samples_analytics_event_bind_event_1.mdx';
99

10-
This guide shows you how to to manually link analytics events to specific users.
10+
This guide shows you how to manually link analytics events to specific users.
1111

1212
## Requirements
1313

learn/analytics/events_endpoint.mdx

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
11
---
22
title: Analytics events endpoint
3-
sidebarTitle: Analytics events endpoint
43
description: 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.
54
---
65

reference/api/overview.mdx

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -153,6 +153,12 @@ Responses will include a `metadata` object:
153153
| `primaryKey` | String | Primary key field name, if index has a primary key |
154154
| `remote` | String | Remote instance name, if request targets a remote instance |
155155

156+
<Note>
157+
A search refers to a single HTTP search request. Every search request is assigned a `requestUid`. A query UID is a combination of `q` and `indexUid`.
158+
159+
In the context of multi-search, for any given `searchUid` there may be multiple `queryUid` values.
160+
</Note>
161+
156162
## Request body
157163

158164
The request body is data sent to the API. It is used with PUT, POST, and PATCH methods to create or update a resource. You must provide request bodies in JSON.

0 commit comments

Comments
 (0)