From e1897623508dfca4b518862674f0d06980a1b23f Mon Sep 17 00:00:00 2001
From: Srivishnu Ayyagari <vishnu.ayyagari@gmail.com>
Date: Wed, 29 Jan 2025 20:01:50 +0530
Subject: [PATCH] feat: Add documentation for filtering by custom data in
 analytics

---
 docs/analytics-filter-by-custom-data.md | 90 +++++++++++++++++++++++++
 sidebars.js                             |  1 +
 2 files changed, 91 insertions(+)
 create mode 100644 docs/analytics-filter-by-custom-data.md

diff --git a/docs/analytics-filter-by-custom-data.md b/docs/analytics-filter-by-custom-data.md
new file mode 100644
index 000000000..501e7e397
--- /dev/null
+++ b/docs/analytics-filter-by-custom-data.md
@@ -0,0 +1,90 @@
+---
+id: analytics-filter-by-custom-data
+title: Filter by Custom Data
+sidebar_label: Filter by Custom Data
+description: Analyze the test case level insights of your test automation execution on LambdaTest.
+keywords:
+  - analytics
+url: https://www.lambdatest.com/support/docs/analytics-filter-by-custom-data/
+site_name: LambdaTest
+slug: analytics-filter-by-custom-data/
+---
+
+<script type="application/ld+json"
+      dangerouslySetInnerHTML={{ __html: JSON.stringify({
+       "@context": "https://schema.org",
+        "@type": "BreadcrumbList",
+        "itemListElement": [{
+          "@type": "ListItem",
+          "position": 1,
+          "name": "Home",
+          "item": "https://www.lambdatest.com"
+        },{
+          "@type": "ListItem",
+          "position": 2,
+          "name": "Support",
+          "item": "https://www.lambdatest.com/support/docs/"
+        },{
+          "@type": "ListItem",
+          "position": 3,
+          "name": "Test Overview",
+          "item": "https://www.lambdatest.com/support/docs/analytics-filter-by-custom-data/"
+        }]
+      })
+    }}
+></script>
+import NewTag from '../src/component/newTag';
+
+
+Ability to sent any custom `key` and `value` pair to LambdaTest platform and then filter the test cases based on the custom data. This feature is available for `Web Automation` and `App Automation` coming soon.
+
+## Prerequisites For Insights:
+
+1. You should have an active LambdaTest account.
+2. You should han active subscription plan with Web Automation.
+3. You should have executed at least one test on the LambdaTest Web Automation platform.
+
+## Capture Custom Data Filter for Insights in Web Automation &nbsp;<NewTag value="BETA" bgColor="#ffec02" color="#000" />
+
+### Update your existing test capabilities
+
+You can use the `customData` capability to send custom data to the LambdaTest platform. The custom data will be displayed in the `Builds Comparison Insights` module. The custom data will be displayed in the `Custom Data` Filter. You can filter the test cases based on the custom data.
+
+```js
+{
+  "capabilities": {
+    "browserName": "chrome",
+    "version": "latest",
+    "platform": "Windows 10",
+    // highlight-start
+    "customData": {
+      "key": "value"
+    }
+    // highlight-end
+  }
+}
+
+```
+
+
+## How To Access Custom Filters?
+
+:::note
+
+Currently, the feature is in the <NewTag value="BETA" bgColor="#ffec02" color="#000" /> phase and will be supported for Build Comparison for Web Automation.
+
+:::
+
+1. Go to the `Insights` tab on the left navigation bar and click on the `Builds Comparison`.
+2. Select the `Build` from the list to drill-down.
+3. Now, search for `Test Case` widgets in the `Web Automation, App Automation & HyperExecute` products.
+4. Add the widgets to the dashboard by clicking on the `Add Widget` button.
+
+
+## Custom Filters Use Cases
+
+1. You can send the `key` and `value` pair to the LambdaTest platform.
+2. You can filter the test cases based on the custom data.
+
+
+
diff --git a/sidebars.js b/sidebars.js
index 1da12be9e..f548957e0 100644
--- a/sidebars.js
+++ b/sidebars.js
@@ -2999,6 +2999,7 @@ module.exports = {
     "analytics-dashboard-features",
     "analytics-widget-drill-down-export",
     "analytics-widget-filter-by-regex",
+    "analytics-filter-by-custom-data",
     "analytics-faqs",
   ],