Merge pull request #3593 from meilisearch/feat-ignore-search-analytics

feat: how to exclude search from analytics

Author: qdequele

capabilities/analytics/how_to/ignore_search_requests.mdx

@@ -0,0 +1,18 @@
+---
+title: Exclude search requests from analytics
+sidebarTitle: Exclude search requests from analytics
+description: Learn how to improve your analytics by excluding search requests.
+---
+
+import CodeSamplesAnalyticsExcludeSearchRequests from "/snippets/generated-code-samples/code_samples_analytics_exclude_search_requests.mdx";
+
+You may want to exclude specific search requests from analytics in certain use cases, such as:
+
+- When initializing a page and displaying initial results to users
+- When building UI components such as category filters
+
+# Exclude searches from your analytics
+
+To exclude specific searches from your analytics, set the `analytics` parameter to `false`.
+
+<CodeSamplesAnalyticsExcludeSearchRequests />

config/navigation.json

@@ -298,7 +298,8 @@
                   "pages": [
                     "capabilities/analytics/how_to/bind_events_to_user",
                     "capabilities/analytics/how_to/track_click_events",
-                    "capabilities/analytics/how_to/track_conversion_events"
+                    "capabilities/analytics/how_to/track_conversion_events",
+                    "capabilities/analytics/how_to/ignore_search_requests"
                   ]
                 },
                 {

snippets/generated-code-samples/code_samples_analytics_exclude_search_requests.mdx

@@ -0,0 +1,12 @@
+<CodeGroup>
+
+```bash cURL
+curl \
+  -X POST 'MEILISEARCH_URL/indexes/INDEX_NAME/search?analytics=false' \
+  -H 'Content-Type: application/json' \
+  -H 'Authorization: Bearer DEFAULT_SEARCH_API_KEY' \
+  -H 'X-MS-USER-ID: MEILISEARCH_USER_ID' \
+  --data-binary '{}'
+```
+
+</CodeGroup>