@adobe/spacecat-shared-rum-api-client 2.13.0 → 2.13.2

package/CHANGELOG.md

@@ -1,3 +1,17 @@
+# [@adobe/spacecat-shared-rum-api-client-v2.13.2](https://github.com/adobe/spacecat-shared/compare/@adobe/spacecat-shared-rum-api-client-v2.13.1...@adobe/spacecat-shared-rum-api-client-v2.13.2) (2024-12-02)
+
+
+### Bug Fixes
+
+* **cwv:** include organic pageviews in the response ([#464](https://github.com/adobe/spacecat-shared/issues/464)) ([0aaf49f](https://github.com/adobe/spacecat-shared/commit/0aaf49fa82a0ed8ec1ee753eacac64ac6d8625a8))
+
+# [@adobe/spacecat-shared-rum-api-client-v2.13.1](https://github.com/adobe/spacecat-shared/compare/@adobe/spacecat-shared-rum-api-client-v2.13.0...@adobe/spacecat-shared-rum-api-client-v2.13.1) (2024-11-30)
+
+
+### Bug Fixes
+
+* **deps:** update external fixes ([#465](https://github.com/adobe/spacecat-shared/issues/465)) ([d8ebb23](https://github.com/adobe/spacecat-shared/commit/d8ebb23fbd3d292479a4118dc6a9fb9931a31694))
+
 # [@adobe/spacecat-shared-rum-api-client-v2.13.0](https://github.com/adobe/spacecat-shared/compare/@adobe/spacecat-shared-rum-api-client-v2.12.6...@adobe/spacecat-shared-rum-api-client-v2.13.0) (2024-11-28)
 
 

package/README.md

@@ -141,53 +141,72 @@ Lists all the experiments for a specified domain within the requested interval.
 An example response:
 
 ```json
-{
-  "https://www.aem.live/home": [
-    {
-      "experiment": "short-home",
-      "variants": [
-        {
-          "name": "challenger-1",
-          "views": 1300,
-          "click": {
-            ".hero": 100,
-            ".header #navmenu-0": 100,
-            ".roi-calculator .button": 100,
-            ".hero .button": 100
-          },
-          "convert": {},
-          "formsubmit": {}
-        },
-        {
-          "name": "control",
-          "views": 800,
-          "click": {
-            ".hero .button": 100,
-            ".header .button": 200,
-            ".header #navmenu-0": 200
-          },
-          "convert": {},
-          "formsubmit": {}
-        }
-      ]
-    }
-  ],
-
-  "https://www.aem.live/new-exp-page": [
-    {
-      "experiment": "visitor-behavior",
-      "variants": [
-        {
-          "name": "https://www.aem.live/some-other-page",
-          "views": 500,
-          "click": {},
-          "convert": {},
-          "formsubmit": {}
-        }
-      ]
-    }
-  ]
-}
+[
+  {
+    "type": "url",
+    "url": "https://www.aem.live/home",
+    "pageviews": 2620,
+    "organic": 1900,
+    "metrics": [
+      {
+        "deviceType": "desktop",
+        "pageviews": 2420,
+        "lcp": 2099.699999988079,
+        "lcpCount": 8,
+        "cls": 0.011145537287059668,
+        "clsCount": 7,
+        "inp": 8,
+        "inpCount": 5,
+        "ttfb": 548,
+        "ttfbCount": 16
+      },
+      {
+        "deviceType": "mobile",
+        "pageviews": 100,
+        "lcp": 2454.2,
+        "lcpCount": 1,
+        "cls": 0.26956930913977606,
+        "clsCount": 1,
+        "inp": null,
+        "inpCount": 0,
+        "ttfb": 807.2999999858439,
+        "ttfbCount": 1
+      }
+    ]
+  },
+  {
+    "type": "url",
+    "url": "https://www.aem.live/docs/",
+    "pageviews": 1910,
+    "organic": 602,
+    "metrics": [
+      {
+        "deviceType": "desktop",
+        "pageviews": 1804,
+        "lcp": 665.9000000059605,
+        "lcpCount": 11,
+        "cls": 0.012401669733174766,
+        "clsCount": 11,
+        "inp": 32,
+        "inpCount": 8,
+        "ttfb": 253.20000000298023,
+        "ttfbCount": 12
+      },
+      {
+        "deviceType": "mobile",
+        "pageviews": 106,
+        "lcp": 26276.5,
+        "lcpCount": 4,
+        "cls": null,
+        "clsCount": 5,
+        "inp": 48,
+        "inpCount": 1,
+        "ttfb": 86,
+        "ttfbCount": 5
+      }
+    ]
+  }
+]
 
 ```
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@adobe/spacecat-shared-rum-api-client",
-  "version": "2.13.0",
+  "version": "2.13.2",
   "description": "Shared modules of the Spacecat Services - Rum API client",
   "type": "module",
   "engines": {
@@ -45,7 +45,7 @@
   },
   "devDependencies": {
     "chai": "5.1.2",
-    "chai-as-promised": "8.0.0",
+    "chai-as-promised": "8.0.1",
     "nock": "13.5.6",
     "sinon": "19.0.2",
     "sinon-chai": "4.0.0",

package/src/functions/cwv.js

@@ -93,6 +93,9 @@ function handler(rawBundles, opts = []) {
   // counts metrics per each facet
   METRICS.forEach((metric) => dataChunks.addSeries(metric, series[metric]));
 
+  // count organic traffic per each facet
+  dataChunks.addSeries('organic', series.organic);
+
   const patternsResult = dataChunks.facets.patternsDevices.reduce((acc, facet) => {
     const [pattern, deviceType] = facet.value.split(DELIMITER);
     const patternData = Object.values(urlToPatternMap).find((p) => p.pattern === pattern);
@@ -102,11 +105,13 @@ function handler(rawBundles, opts = []) {
       name: patternData.name,
       pattern,
       pageviews: 0,
+      organic: 0,
       metrics: [],
     };
 
     // Increment the total pageviews for pattern
     acc[pattern].pageviews += facet.weight;
+    acc[pattern].organic += facet.metrics.organic.sum;
 
     // Add metrics for the specific device type
     acc[pattern].metrics.push({
@@ -125,11 +130,13 @@ function handler(rawBundles, opts = []) {
       type: FACET_TYPE.URL,
       url,
       pageviews: 0,
+      organic: 0,
       metrics: [],
     };
 
     // Increment the total pageviews for url
     acc[url].pageviews += facet.weight;
+    acc[url].organic += facet.metrics.organic.sum;
 
     // Add metrics for the specific device type
     acc[url].metrics.push({
@@ -152,5 +159,11 @@ function handler(rawBundles, opts = []) {
 
 export default {
   handler,
-  checkpoints: METRICS.map((metric) => `cwv-${metric}`),
+  checkpoints: [
+    ...METRICS.map((metric) => `cwv-${metric}`),
+    'utm',
+    'paid',
+    'email',
+    'enter',
+  ],
 };