@adobe/spacecat-shared-rum-api-client 2.28.0 → 2.29.0

package/CHANGELOG.md

@@ -1,3 +1,17 @@
+# [@adobe/spacecat-shared-rum-api-client-v2.29.0](https://github.com/adobe/spacecat-shared/compare/@adobe/spacecat-shared-rum-api-client-v2.28.1...@adobe/spacecat-shared-rum-api-client-v2.29.0) (2025-06-20)
+
+
+### Features
+
+* high organic low ctr detection using traffic instead of thresholds ([#815](https://github.com/adobe/spacecat-shared/issues/815)) ([54569fb](https://github.com/adobe/spacecat-shared/commit/54569fb5d9b5fbe8400da0aadbae148380866fda))
+
+# [@adobe/spacecat-shared-rum-api-client-v2.28.1](https://github.com/adobe/spacecat-shared/compare/@adobe/spacecat-shared-rum-api-client-v2.28.0...@adobe/spacecat-shared-rum-api-client-v2.28.1) (2025-05-31)
+
+
+### Bug Fixes
+
+* **deps:** update external fixes ([#779](https://github.com/adobe/spacecat-shared/issues/779)) ([07f8cce](https://github.com/adobe/spacecat-shared/commit/07f8cce73e33bfb9c61fe14f2ef28012b872437d))
+
 # [@adobe/spacecat-shared-rum-api-client-v2.28.0](https://github.com/adobe/spacecat-shared/compare/@adobe/spacecat-shared-rum-api-client-v2.27.2...@adobe/spacecat-shared-rum-api-client-v2.28.0) (2025-05-30)
 
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@adobe/spacecat-shared-rum-api-client",
-  "version": "2.28.0",
+  "version": "2.29.0",
   "description": "Shared modules of the Spacecat Services - Rum API client",
   "type": "module",
   "engines": {
@@ -46,7 +46,7 @@
   "devDependencies": {
     "chai": "5.2.0",
     "chai-as-promised": "8.0.1",
-    "nock": "14.0.4",
+    "nock": "14.0.5",
     "sinon": "20.0.0",
     "sinon-chai": "4.0.0",
     "typescript": "5.8.3"

package/src/functions/opportunities/high-organic-low-ctr.js

@@ -13,16 +13,15 @@
 import trafficAcquisition from '../traffic-acquisition.js';
 import { getCTRByUrlAndVendor, getSiteAvgCTR } from '../../common/aggregateFns.js';
 
-const DAILY_EARNED_THRESHOLD = 1000;
-const CTR_THRESHOLD_RATIO = 0.95;
-const DAILY_PAGEVIEW_THRESHOLD = 1000;
 const VENDORS_TO_CONSIDER = 5;
+const MAX_OPPORTUNITIES = 10;
 
 const MAIN_TYPES = ['paid', 'earned', 'owned'];
 
 function convertToOpportunity(traffic) {
   const {
-    url, total, ctr, paid, owned, earned, sources, siteAvgCTR, ctrByUrlAndVendor, pageOnTime,
+    url, total, ctr, paid, percentileScore, owned, earned,
+    sources, siteAvgCTR, ctrByUrlAndVendor, pageOnTime,
   } = traffic;
 
   const vendors = sources.reduce((acc, { type, views }) => {
@@ -51,6 +50,7 @@ function convertToOpportunity(traffic) {
     trackedKPISiteAverage: siteAvgCTR,
     pageViews: total,
     samples: total, // todo: get the actual number of samples
+    percentileScore,
     metrics: [{
       type: 'traffic',
       vendor: '*',
@@ -106,33 +106,48 @@ function convertToOpportunity(traffic) {
   return opportunity;
 }
 
-function hasHighOrganicTraffic(interval, traffic) {
-  const { earned } = traffic;
-  return earned >= DAILY_EARNED_THRESHOLD * interval;
-}
+/**
+ * Sort pages by earned AND overall traffic using percentile scoring.
+ * @param {Array} pages - List of { url, total, earned }
+ * @returns {Array} List of pages sorted by joint strength
+ */
+function sortPagesByEarnedAndOverallTraffic(pages) {
+  if (!Array.isArray(pages) || pages.length === 0) return [];
 
-function hasLowerCTR(ctr, siteAvgCTR) {
-  return ctr < CTR_THRESHOLD_RATIO * siteAvgCTR;
-}
+  const sortedOverall = [...pages].sort((a, b) => a.total - b.total);
+  const sortedEarned = [...pages].sort((a, b) => {
+    if (a.earned === b.earned) {
+      return a.total - b.total;
+    }
+    return a.earned - b.earned;
+  });
+  const n = pages.length;
+
+  const percentiles = pages.map((p) => {
+    const totalPercentile = sortedOverall.findIndex((x) => x.url === p.url) / (n - 1);
+    const earnedPercentile = sortedEarned.findIndex((x) => x.url === p.url) / (n - 1);
+    const percentileScore = totalPercentile * earnedPercentile;
+    return { ...p, percentileScore };
+  });
 
-function handler(bundles, opts = {}) {
-  const { interval = 7 } = opts;
+  return percentiles.sort((a, b) => b.percentileScore - a.percentileScore);
+}
 
+function handler(bundles) {
   const trafficByUrl = trafficAcquisition.handler(bundles);
   const ctrByUrlAndVendor = getCTRByUrlAndVendor(bundles);
   const siteAvgCTR = getSiteAvgCTR(bundles);
+  const pagesSortedByEarnedAndOverallTraffic = sortPagesByEarnedAndOverallTraffic(
+    trafficByUrl,
+  ).slice(0, MAX_OPPORTUNITIES);
 
-  return trafficByUrl.filter((traffic) => traffic.total > interval * DAILY_PAGEVIEW_THRESHOLD)
-    .filter(hasHighOrganicTraffic.bind(null, interval))
-    .filter((traffic) => hasLowerCTR(ctrByUrlAndVendor[traffic.url].value, siteAvgCTR))
-    .map((traffic) => ({
-      ...traffic,
-      ctr: ctrByUrlAndVendor[traffic.url].value,
-      siteAvgCTR,
-      ctrByUrlAndVendor: ctrByUrlAndVendor[traffic.url].vendors,
-      pageOnTime: traffic.maxTimeDelta,
-    }))
-    .map(convertToOpportunity);
+  return pagesSortedByEarnedAndOverallTraffic.map((traffic) => ({
+    ...traffic,
+    ctr: ctrByUrlAndVendor[traffic.url].value,
+    siteAvgCTR,
+    ctrByUrlAndVendor: ctrByUrlAndVendor[traffic.url].vendors,
+    pageOnTime: traffic.maxTimeDelta,
+  })).map(convertToOpportunity);
 }
 
 export default {

package/src/functions/traffic-acquisition.js

@@ -47,7 +47,7 @@ function formatTraffic(row) {
     url, weight, type, category, vendor, events = [],
   } = row;
 
-  const maxTimeDelta = events.reduce((max, e) => Math.max(max, e.timeDelta), 0);
+  const maxTimeDelta = events.reduce((max, e) => Math.max(max, e.timeDelta || 0), 0);
 
   return {
     url,