@adobe/spacecat-shared-athena-client 1.9.0 → 1.9.2

package/CHANGELOG.md

@@ -1,3 +1,17 @@
+# [@adobe/spacecat-shared-athena-client-v1.9.2](https://github.com/adobe/spacecat-shared/compare/@adobe/spacecat-shared-athena-client-v1.9.1...@adobe/spacecat-shared-athena-client-v1.9.2) (2026-01-19)
+
+
+### Bug Fixes
+
+* added function getTrafficTypeAnalysisTemplate to athena client ([#1266](https://github.com/adobe/spacecat-shared/issues/1266)) ([1103cbb](https://github.com/adobe/spacecat-shared/commit/1103cbbc7893fc209d4dc3e07feb64372d8e77e8))
+
+# [@adobe/spacecat-shared-athena-client-v1.9.1](https://github.com/adobe/spacecat-shared/compare/@adobe/spacecat-shared-athena-client-v1.9.0...@adobe/spacecat-shared-athena-client-v1.9.1) (2025-12-08)
+
+
+### Bug Fixes
+
+* use updated shared utils ([#1226](https://github.com/adobe/spacecat-shared/issues/1226)) ([ac8b015](https://github.com/adobe/spacecat-shared/commit/ac8b0159128257f107e08a6b868b69ebe66312d2))
+
 # [@adobe/spacecat-shared-athena-client-v1.9.0](https://github.com/adobe/spacecat-shared/compare/@adobe/spacecat-shared-athena-client-v1.8.4...@adobe/spacecat-shared-athena-client-v1.9.0) (2025-12-08)
 
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@adobe/spacecat-shared-athena-client",
-  "version": "1.9.0",
+  "version": "1.9.2",
   "description": "Shared modules of the Spacecat Services - AWS Athena Client",
   "type": "module",
   "engines": {
@@ -35,7 +35,7 @@
     "access": "public"
   },
   "dependencies": {
-    "@adobe/spacecat-shared-utils": "1.81.1",
+    "@adobe/spacecat-shared-utils": "1.82.1",
     "@aws-sdk/client-athena": "3.940.0"
   },
   "devDependencies": {

package/src/index.js

@@ -262,6 +262,7 @@ export {
   buildPageTypeCase,
   getTrafficAnalysisQueryPlaceholdersFilled,
   getTop3PagesWithTrafficLostTemplate,
+  getTrafficTypeAnalysisTemplate,
 } from './traffic-analysis/queries.js';
 export { TrafficDataResponseDto } from './traffic-analysis/traffic-data-base-response.js';
 export { TrafficDataWithCWVDto } from './traffic-analysis/traffic-data-with-cwv.js';

package/src/traffic-analysis/queries.js

@@ -101,9 +101,9 @@ export function getTrafficAnalysisQueryPlaceholdersFilled({
     throw new Error('Missing required parameters: week, month or year');
   }
 
-  if (numTemporalSeries > 1 && week) {
+  if (numTemporalSeries > 1 && week && week > 0) {
     dimensions.push('week');
-  } else if (numTemporalSeries > 1 && month) {
+  } else if (numTemporalSeries > 1 && month && month > 0) {
     dimensions.push('month');
   }
   const dimensionColumns = dimensions.join(', ');
@@ -242,3 +242,103 @@ ORDER BY traffic_loss DESC
 ${limit ? `LIMIT ${limit}` : ''}
 `.trim();
 }
+
+/**
+ * Generates the top 3 pages with traffic lost SQL query with consent and referrer parameters.
+ * @param {Object} params - Template parameters
+ * @param {string} params.siteId - Site ID
+ * @param {string} params.tableName - Table name
+ * @param {string} params.temporalCondition - Temporal condition
+ * @param {string} params.dimensionColumns - Dimension columns
+ * @param {string} params.groupBy - Group by clause
+ * @param {string} params.dimensionColumnsPrefixed - Prefixed dimension columns
+ * @param {number} params.pageViewThreshold - Minimum total pageviews for path to include
+ * @param {number} params.limit - Limit the number of results
+ * @returns {string} The SQL query string
+ */
+export function getTrafficTypeAnalysisTemplate({
+  siteId,
+  tableName,
+  temporalCondition,
+  dimensionColumns,
+  groupBy,
+  dimensionColumnsPrefixed,
+  pageViewThreshold,
+  limit,
+}) {
+  return `
+WITH min_totals AS (
+    SELECT
+        path AS min_key,
+        CAST(SUM(pageviews) AS BIGINT) AS total_pageviews
+    FROM ${tableName}
+    WHERE siteid = '${siteId}'
+    AND (${temporalCondition})
+    GROUP BY path
+    HAVING SUM(pageviews) >= ${pageViewThreshold}
+),
+raw AS (
+    SELECT
+        week,
+        month,
+        path,
+        trf_type,
+        trf_channel,
+        trf_platform,
+        device,
+        utm_source,
+        utm_medium,
+        utm_campaign,
+        referrer,
+        consent,
+        notfound,
+        pageviews,
+        clicked,
+        engaged,
+        latest_scroll,
+        CASE WHEN latest_scroll >= 10000 THEN 1 ELSE 0 END AS engaged_scroll,
+        lcp,
+        cls,
+        inp
+    FROM ${tableName} m
+    JOIN min_totals t ON m.path = t.min_key
+    WHERE m.siteid = '${siteId}'
+    AND (${temporalCondition})
+),
+agg AS (
+    SELECT
+        ${dimensionColumns},
+        COUNT(*)                          AS row_count,
+        CAST(SUM(pageviews) AS BIGINT)   AS pageviews,
+        CAST(SUM(clicked) AS BIGINT)     AS clicks,
+        CAST(SUM(engaged) AS BIGINT)     AS engagements,
+        CAST(SUM(engaged_scroll) AS BIGINT) AS engaged_scroll,
+        approx_percentile(latest_scroll, 0.70) AS p70_scroll,
+        approx_percentile(lcp, 0.70)     AS p70_lcp,
+        approx_percentile(cls, 0.70)     AS p70_cls,
+        approx_percentile(inp, 0.70)     AS p70_inp
+    FROM raw
+    GROUP BY ${groupBy}
+),
+grand_total AS (
+    SELECT CAST(SUM(pageviews) AS BIGINT) AS total_pv FROM agg
+)
+SELECT
+    ${dimensionColumnsPrefixed},
+    CAST(a.pageviews AS DOUBLE) * (1 - CAST(a.engagements AS DOUBLE) / NULLIF(a.row_count, 0)) AS traffic_loss,
+    1 - CAST(a.engagements AS DOUBLE) / NULLIF(a.row_count, 0)  AS bounce_rate,
+    a.pageviews,
+    CAST(a.pageviews AS DOUBLE) / NULLIF(t.total_pv, 0)         AS pct_pageviews,
+    CAST(a.clicks AS DOUBLE)      / NULLIF(a.row_count, 0)      AS click_rate,
+    CAST(a.engagements AS DOUBLE) / NULLIF(a.row_count, 0)      AS engagement_rate,
+    CAST(a.engaged_scroll AS DOUBLE) / NULLIF(a.row_count, 0) AS engaged_scroll_rate,
+    a.p70_scroll,
+    a.p70_lcp,
+    a.p70_cls,
+    a.p70_inp
+FROM agg a
+CROSS JOIN grand_total t
+ORDER BY traffic_loss DESC
+${limit ? `LIMIT ${limit}` : ''}
+`.trim();
+}