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

package/CHANGELOG.md

@@ -1,3 +1,17 @@
+# [@adobe/spacecat-shared-rum-api-client-v2.31.0](https://github.com/adobe/spacecat-shared/compare/@adobe/spacecat-shared-rum-api-client-v2.30.0...@adobe/spacecat-shared-rum-api-client-v2.31.0) (2025-06-25)
+
+
+### Features
+
+* expose urls with most paid traffic  ([#825](https://github.com/adobe/spacecat-shared/issues/825)) ([88dde01](https://github.com/adobe/spacecat-shared/commit/88dde01843ae32643a54d93868b7ef7eec10a62a))
+
+# [@adobe/spacecat-shared-rum-api-client-v2.30.0](https://github.com/adobe/spacecat-shared/compare/@adobe/spacecat-shared-rum-api-client-v2.29.0...@adobe/spacecat-shared-rum-api-client-v2.30.0) (2025-06-25)
+
+
+### Features
+
+* SITES-32914 implement `startDate` and `endDate` in RUM client ([#819](https://github.com/adobe/spacecat-shared/issues/819)) ([1520465](https://github.com/adobe/spacecat-shared/commit/15204653ca7a1c3f04b1df30afc1a72f74d2b254))
+
 # [@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)
 
 

package/README.md

@@ -46,6 +46,21 @@ const result = await rumApiClient.query('cwv', opts);
 console.log(`Query result: ${result}`);
 ```
 
+**Using startTime and endTime for precise date ranges:**
+
+```js
+const opts = {
+  domain: 'www.aem.live',
+  domainkey: '<domain-key>',
+  granularity: 'daily',
+  startTime: '2024-01-01T00:00:00Z',
+  endTime: '2024-01-31T23:59:59Z'
+};
+
+const result = await rumApiClient.query('cwv', opts);
+console.log(`Query result: ${result}`);
+```
+
 **Note**: All query names must be lowercase.
 
 ### Query Options: the 'opts' object
@@ -54,8 +69,10 @@ console.log(`Query result: ${result}`);
 |-------------|----------|---------|----------------------------------------------------------|
 | domain      | yes      |         | The domain for which to fetch data.                      |
 | domainkey   | no       |         | Provide directly or omit to auto-fetch using `RUM_ADMIN_KEY`. |
-| interval    | no       | 7       | Interval in days (integer).                              |
+| interval    | no       | 7       | Interval in days (integer). Ignored when startTime/endTime are provided. |
 | granularity | no       | daily   | 'daily' or 'hourly'.                                     |
+| startTime   | no       |         | Start time in ISO 8601 format (e.g., "2024-01-01T00:00:00Z"). Must be before endTime. Format `YYYY-MM-DD` or `YYYY-MM-DDTHH:MM:SSZ` |
+| endTime     | no       |         | End time in ISO 8601 format (e.g., "2024-01-31T23:59:59Z"). Must be after startTime.  Format `YYYY-MM-DD` or `YYYY-MM-DDTHH:MM:SSZ` |
 
 
 ### Retrieving and Caching the Domainkey

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@adobe/spacecat-shared-rum-api-client",
-  "version": "2.29.0",
+  "version": "2.31.0",
   "description": "Shared modules of the Spacecat Services - Rum API client",
   "type": "module",
   "engines": {

package/src/common/rum-bundler-client.js

@@ -22,6 +22,24 @@ const ONE_DAY = ONE_HOUR * HOURS_IN_DAY;
 
 const CHUNK_SIZE = 31;
 
+/**
+ * Parses a date string and returns a Date object.
+ * Supports both ISO 8601 format (e.g., "2024-01-01T00:00:00Z")
+ * and simple date format (e.g., "2024-01-01").
+ * For simple date strings, assumes UTC timezone.
+ * @param {string} dateString - The date string to parse
+ * @returns {Date} The parsed Date object
+ */
+function parseDate(dateString) {
+  // If it's a simple date string (YYYY-MM-DD), convert to ISO format
+  if (/^\d{4}-\d{2}-\d{2}$/.test(dateString)) {
+    return new Date(`${dateString}T00:00:00.000Z`);
+  }
+
+  // Otherwise, let the Date constructor handle it (ISO 8601, etc.)
+  return new Date(dateString);
+}
+
 function isBotTraffic(bundle) {
   return bundle?.userAgent?.includes('bot');
 }
@@ -54,6 +72,24 @@ function getUrlChunks(urls, chunkSize) {
     .map((_, index) => urls.slice(index * chunkSize, (index + 1) * chunkSize));
 }
 
+function generateUrlsForDateRange(startDate, endDate, domain, granularity, domainkey) {
+  const urls = [];
+  const currentDate = parseDate(startDate);
+  const endDateTime = parseDate(endDate);
+
+  while (currentDate < endDateTime) {
+    urls.push(constructUrl(domain, currentDate, granularity, domainkey));
+
+    if (granularity.toUpperCase() === GRANULARITY.HOURLY) {
+      currentDate.setUTCHours(currentDate.getUTCHours() + 1);
+    } else {
+      currentDate.setUTCDate(currentDate.getUTCDate() + 1);
+    }
+  }
+
+  return urls;
+}
+
 /* c8 ignore start */
 /*
  * throw-away code for a single customer who customized the experimentation engine
@@ -165,23 +201,46 @@ async function fetchBundles(opts, log) {
     granularity = GRANULARITY.DAILY,
     checkpoints = [],
     filterBotTraffic = true,
+    startTime,
+    endTime,
   } = opts;
 
   if (!hasText(domain) || !hasText(domainkey)) {
     throw new Error('Missing required parameters');
   }
 
-  const multiplier = granularity.toUpperCase() === GRANULARITY.HOURLY ? ONE_HOUR : ONE_DAY;
-  const range = granularity.toUpperCase() === GRANULARITY.HOURLY
-    ? interval * HOURS_IN_DAY
-    : interval + 1;
+  // Validate startTime and endTime if provided
+  if (startTime && endTime) {
+    const start = parseDate(startTime);
+    const end = parseDate(endTime);
 
-  const urls = [];
-  const currentDate = new Date();
+    if (Number.isNaN(start.getTime()) || Number.isNaN(end.getTime())) {
+      throw new Error('Invalid startTime or endTime format. Use ISO 8601 format (e.g., "2024-01-01T00:00:00Z") or simple date format (e.g., "2024-01-01")');
+    }
 
-  for (let i = 0; i < range; i += 1) {
-    const date = new Date(currentDate.getTime() - i * multiplier);
-    urls.push(constructUrl(domain, date, granularity, domainkey));
+    if (start >= end) {
+      throw new Error('startTime must be before endTime');
+    }
+  }
+
+  let urls = [];
+
+  if (startTime && endTime) {
+    // Use custom date range
+    urls = generateUrlsForDateRange(startTime, endTime, domain, granularity, domainkey);
+  } else {
+    // Use existing interval-based logic
+    const multiplier = granularity.toUpperCase() === GRANULARITY.HOURLY ? ONE_HOUR : ONE_DAY;
+    const range = granularity.toUpperCase() === GRANULARITY.HOURLY
+      ? interval * HOURS_IN_DAY
+      : interval + 1;
+
+    const currentDate = new Date();
+
+    for (let i = 0; i < range; i += 1) {
+      const date = new Date(currentDate.getTime() - i * multiplier);
+      urls.push(constructUrl(domain, date, granularity, domainkey));
+    }
   }
 
   const chunks = getUrlChunks(urls, CHUNK_SIZE);
@@ -197,7 +256,6 @@ async function fetchBundles(opts, log) {
       return response;
     }));
     const bundles = await Promise.all(responses.map((response) => response.json()));
-
     bundles.forEach((b) => {
       b.rumBundles
         .filter((bundle) => !filterBotTraffic || !isBotTraffic(bundle))

package/src/functions/traffic-metrics.js

@@ -15,8 +15,21 @@ import { DELIMITER, generateKey, loadBundles } from '../utils.js';
 import { classifyTraffic } from '../common/traffic.js';
 import { getPageType, isConsentClick } from '../common/page.js';
 
-function getTrafficSource(bundle) {
-  return classifyTraffic(bundle).type;
+function getTrafficSource(bundle, memo) {
+  const id = `${bundle.id}-${bundle.url}-${bundle.time}`;
+  if (id in memo) {
+    return memo[id];
+  }
+  const result = classifyTraffic(bundle);
+  // eslint-disable-next-line no-param-reassign
+  memo[id] = result;
+  return result;
+}
+
+function getTrafficSourceKey(bundle, memo) {
+  const classifyResult = getTrafficSource(bundle, memo);
+  const { type, category, vendor } = classifyResult;
+  return `${type}:${category}:${vendor}`;
 }
 
 function getDeviceType(bundle) {
@@ -35,36 +48,54 @@ function addPageTypeDeviceTypeFacet(dataChunks, pageTypes) {
   });
 }
 
-function addPageTypeTrafficSourceDeviceTypes(dataChunks, pageTypes) {
+function addPageTypeTrafficSourceDeviceTypes(dataChunks, pageTypes, memo) {
   dataChunks.addFacet('pageTrafficDeviceTypes', (bundle) => {
     const deviceType = getDeviceType(bundle);
     const pageType = getPageType(bundle, pageTypes);
-    return generateKey(pageType, getTrafficSource(bundle), deviceType);
+    return generateKey(pageType, getTrafficSourceKey(bundle, memo), deviceType);
   });
 }
 
-function addPageTypeTrafficSourceFacet(dataChunks, pageTypes) {
+function addPageTypeTrafficSourceFacet(dataChunks, pageTypes, memo) {
   dataChunks.addFacet('pageTypeTrafficSources', (bundle) => {
     const pageType = getPageType(bundle, pageTypes);
-    return generateKey(pageType, getTrafficSource(bundle));
+    return generateKey(pageType, getTrafficSourceKey(bundle, memo));
   });
 }
 
-function handler(bundles, options = { pageTypes: null }) {
+/**
+ * Handler for traffic metrics.
+ * @param {Array} bundles - The RUM bundles.
+ * @param {Object} options - Options object.
+ * @param {Object} [options.pageTypes] - Page type regex or mapping.
+ * @param {string} [options.trafficType] - Eg, 'paid', 'earned', 'owned', 'all'. Defaults to 'all'.
+ */
+function handler(bundles, options = { pageTypes: null, trafficType: 'all' }) {
   const dataChunks = new DataChunks();
-  const { pageTypes: pageTypeOpt } = options;
+  const trafficSourceMemo = {};
+  const { pageTypes: pageTypeOpt, trafficType = 'all' } = options;
+
+  let filteredBundles = bundles;
+  if (trafficType && trafficType !== 'all') {
+    filteredBundles = bundles
+      .filter((bundle) => getTrafficSource(bundle, trafficSourceMemo).type === trafficType);
+  }
+
+  const getTS = (bundle) => getTrafficSourceKey(bundle, trafficSourceMemo);
 
-  loadBundles(bundles, dataChunks);
+  loadBundles(filteredBundles, dataChunks);
 
   const metricFilter = (metrics) => {
-    const { ctr, enters, sumOfAllClicks } = metrics;
+    const {
+      ctr, enters, sumOfAllClicks, facet,
+    } = metrics;
     return {
-      ctr: ctr.sum / ctr.weight,
+      ctr: ctr.weight !== 0 ? ctr.sum / ctr.weight : 0,
       clickedSessions: ctr.sum,
-      totalSessions: ctr.weight,
+      pageViews: facet.weight,
       sessionsWithEnter: enters.sum,
-      clicksOverViews: ctr.weight ? ctr.sum / ctr.weight : 0,
-      bounceRate: ctr.weight ? (1 - (ctr.sum / ctr.weight)) : 0,
+      clicksOverViews: ctr.weight !== 0 ? ctr.sum / ctr.weight : 0,
+      bounceRate: ctr.weight !== 0 ? (1 - (ctr.sum / ctr.weight)) : 1,
       totalNumClicks: sumOfAllClicks.sum,
       avgClicksPerSession: ctr.sum ? sumOfAllClicks.sum / ctr.sum : 0,
     };
@@ -72,25 +103,25 @@ function handler(bundles, options = { pageTypes: null }) {
 
   dataChunks.addFacet('urls', (bundle) => bundle.url);
 
-  dataChunks.addFacet('trafficSources', (bundle) => getTrafficSource(bundle));
+  dataChunks.addFacet('trafficSources', (bundle) => getTS(bundle));
 
-  dataChunks.addFacet('urlTrafficSources', (bundle) => generateKey(bundle.url, getTrafficSource(bundle)));
+  dataChunks.addFacet('urlTrafficSources', (bundle) => generateKey(bundle.url, getTS(bundle)));
 
   dataChunks.addFacet('urlDeviceTypes', (bundle) => generateKey(bundle.url, getDeviceType(bundle)));
 
   dataChunks.addFacet('deviceTypes', (bundle) => getDeviceType(bundle));
 
-  dataChunks.addFacet('urlTrafficSourceDeviceTypes', (bundle) => generateKey(bundle.url, getTrafficSource(bundle), getDeviceType(bundle)));
+  dataChunks.addFacet('urlTrafficSourceDeviceTypes', (bundle) => generateKey(bundle.url, getTS(bundle), getDeviceType(bundle)));
 
-  dataChunks.addFacet('deviceTypeTrafficSources', (bundle) => generateKey(getDeviceType(bundle), getTrafficSource(bundle)));
+  dataChunks.addFacet('deviceTypeTrafficSources', (bundle) => generateKey(getDeviceType(bundle), getTS(bundle)));
 
   addPageTypeFacet(dataChunks, pageTypeOpt);
 
-  addPageTypeTrafficSourceFacet(dataChunks, pageTypeOpt);
+  addPageTypeTrafficSourceFacet(dataChunks, pageTypeOpt, trafficSourceMemo);
 
   addPageTypeDeviceTypeFacet(dataChunks, pageTypeOpt);
 
-  addPageTypeTrafficSourceDeviceTypes(dataChunks, pageTypeOpt);
+  addPageTypeTrafficSourceDeviceTypes(dataChunks, pageTypeOpt, trafficSourceMemo);
 
   dataChunks.addSeries('ctr', (bundle) => {
     const isClicked = bundle.events.some((e) => e.checkpoint === 'click');
@@ -111,100 +142,108 @@ function handler(bundles, options = { pageTypes: null }) {
     return containsEnter ? bundle.weight : 0;
   });
 
-  const urls = dataChunks.facets.urls.map((facet) => {
-    const url = facet.value;
-    return {
-      ...metricFilter(facet.metrics),
-      url,
-    };
-  });
+  const urls = dataChunks.facets.urls.map((facet) => ({
+    ...metricFilter({ ...facet.metrics, facet }),
+    url: facet.value,
+    urls: [facet.value],
+  }));
 
   const pageType = dataChunks.facets.pageType.map((facet) => {
     const type = facet.value;
     return {
-      ...metricFilter(facet.metrics),
+      ...metricFilter({ ...facet.metrics, facet }),
       type,
+      urls: [...new Set(facet.entries.map((b) => b.url))],
     };
   });
 
   const deviceTypes = dataChunks.facets.deviceTypes.map((facet) => {
     const deviceType = facet.value;
     return {
-      ...metricFilter(facet.metrics),
+      ...metricFilter({ ...facet.metrics, facet }),
       deviceType,
+      urls: [...new Set(facet.entries.map((b) => b.url))],
     };
   });
 
   const urlDeviceTypes = dataChunks.facets.urlDeviceTypes.map((facet) => {
     const [url, deviceType] = facet.value.split(DELIMITER);
     return {
-      ...metricFilter(facet.metrics),
+      ...metricFilter({ ...facet.metrics, facet }),
       url,
       deviceType,
+      urls: [...new Set(facet.entries.map((b) => b.url))],
     };
   });
 
   const trafficSources = dataChunks.facets.trafficSources.map((facet) => {
     const source = facet.value;
     return {
-      ...metricFilter(facet.metrics),
+      ...metricFilter({ ...facet.metrics, facet }),
       source,
+      urls: [...new Set(facet.entries.map((b) => b.url))],
     };
   });
 
   const urlTrafficSources = dataChunks.facets.urlTrafficSources.map((facet) => {
     const [url, source] = facet.value.split(DELIMITER);
     return {
-      ...metricFilter(facet.metrics),
+      ...metricFilter({ ...facet.metrics, facet }),
       url,
       source,
+      urls: [...new Set(facet.entries.map((b) => b.url))],
     };
   });
 
   const urlTrafficSourceDeviceTypes = dataChunks.facets.urlTrafficSourceDeviceTypes.map((facet) => {
     const [url, source, deviceType] = facet.value.split(DELIMITER);
     return {
-      ...metricFilter(facet.metrics),
+      ...metricFilter({ ...facet.metrics, facet }),
       url,
       source,
       deviceType,
+      urls: [...new Set(facet.entries.map((b) => b.url))],
     };
   });
 
   const pageTypeTrafficSources = dataChunks.facets.pageTypeTrafficSources.map((facet) => {
     const [type, source] = facet.value.split(DELIMITER);
     return {
-      ...metricFilter(facet.metrics),
+      ...metricFilter({ ...facet.metrics, facet }),
       type,
       source,
+      urls: [...new Set(facet.entries.map((b) => b.url))],
     };
   });
 
   const pageTypeDeviceTypes = dataChunks.facets.pageTypeDeviceTypes.map((facet) => {
     const [type, deviceType] = facet.value.split(DELIMITER);
     return {
-      ...metricFilter(facet.metrics),
+      ...metricFilter({ ...facet.metrics, facet }),
       type,
       deviceType,
+      urls: [...new Set(facet.entries.map((b) => b.url))],
     };
   });
 
   const deviceTypeTrafficSources = dataChunks.facets.deviceTypeTrafficSources.map((facet) => {
     const [deviceType, source] = facet.value.split(DELIMITER);
     return {
-      ...metricFilter(facet.metrics),
+      ...metricFilter({ ...facet.metrics, facet }),
       deviceType,
       source,
+      urls: [...new Set(facet.entries.map((b) => b.url))],
     };
   });
 
   const pageTrafficDeviceTypes = dataChunks.facets.pageTrafficDeviceTypes.map((facet) => {
     const [type, source, deviceType] = facet.value.split(DELIMITER);
     return {
-      ...metricFilter(facet.metrics),
+      ...metricFilter({ ...facet.metrics, facet }),
       type,
       source,
       deviceType,
+      urls: [...new Set(facet.entries.map((b) => b.url))],
     };
   });
 

package/src/index.d.ts

@@ -28,6 +28,16 @@ export interface RUMAPIOptions {
    */
   interval?: number;
 
+  /**
+   * Start Date
+   */
+  startDate?: string;
+
+  /**
+   * End Date
+   */
+  endDate?: string;
+
   /**
    * Granularity can be 'hourly' or 'daily'.
    * @default 'daily'