@adobe/spacecat-shared-athena-client 1.2.5 → 1.3.1

package/CHANGELOG.md

@@ -1,3 +1,18 @@
+# [@adobe/spacecat-shared-athena-client-v1.3.1](https://github.com/adobe/spacecat-shared/compare/@adobe/spacecat-shared-athena-client-v1.3.0...@adobe/spacecat-shared-athena-client-v1.3.1) (2025-09-06)
+
+
+### Bug Fixes
+
+* **deps:** update external fixes ([#920](https://github.com/adobe/spacecat-shared/issues/920)) ([1a6b1e1](https://github.com/adobe/spacecat-shared/commit/1a6b1e1ac9531a41c86406ada4bd4ab903307fdc))
+
+# [@adobe/spacecat-shared-athena-client-v1.3.0](https://github.com/adobe/spacecat-shared/compare/@adobe/spacecat-shared-athena-client-v1.2.5...@adobe/spacecat-shared-athena-client-v1.3.0) (2025-08-20)
+
+
+### Features
+
+* add query by month and other fixes ([#917](https://github.com/adobe/spacecat-shared/issues/917)) ([57e4144](https://github.com/adobe/spacecat-shared/commit/57e41443bfdcf9068251f6656e5c0cfcebf32d21))
+* add threshold for pageviews ([#923](https://github.com/adobe/spacecat-shared/issues/923)) ([5b989cd](https://github.com/adobe/spacecat-shared/commit/5b989cd7c38ac946609143ed5402d2ff1600c581))
+
 # [@adobe/spacecat-shared-athena-client-v1.2.5](https://github.com/adobe/spacecat-shared/compare/@adobe/spacecat-shared-athena-client-v1.2.4...@adobe/spacecat-shared-athena-client-v1.2.5) (2025-08-09)
 
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@adobe/spacecat-shared-athena-client",
-  "version": "1.2.5",
+  "version": "1.3.1",
   "description": "Shared modules of the Spacecat Services - AWS Athena Client",
   "type": "module",
   "engines": {
@@ -35,14 +35,14 @@
     "access": "public"
   },
   "dependencies": {
-    "@aws-sdk/client-athena": "3.864.0",
-    "@adobe/spacecat-shared-utils": "1.43.0"
+    "@aws-sdk/client-athena": "3.883.0",
+    "@adobe/spacecat-shared-utils": "1.48.0"
   },
   "devDependencies": {
-    "chai": "5.2.1",
-    "chai-as-promised": "8.0.1",
+    "chai": "5.3.3",
+    "chai-as-promised": "8.0.2",
     "sinon": "20.0.0",
-    "sinon-chai": "4.0.0",
+    "sinon-chai": "4.0.1",
     "typescript": "5.9.2"
   }
 }

package/src/traffic-analysis/queries.js

@@ -9,7 +9,7 @@
  * OF ANY KIND, either express or implied. See the License for the specific language
  * governing permissions and limitations under the License.
  */
-import { getDateRanges } from '@adobe/spacecat-shared-utils';
+import { getTemporalCondition } from '@adobe/spacecat-shared-utils';
 import { getTrafficAnalysisTemplate } from './traffic-analysis-template.js';
 
 /**
@@ -33,6 +33,7 @@ export function getTrafficAnalysisQueryPlaceholders() {
     'dimensionColumnsPrefixed',
     'groupBy',
     'pageTypeCase',
+    'pageViewThreshold',
     'siteId',
     'tableName',
     'temporalCondition',
@@ -66,6 +67,7 @@ export function buildPageTypeCase(pageTypes, column) {
  *
  * @param {Object} params - Input parameters.
  * @param {number} params.week - The ISO week number (1–53).
+ * @param {number} params.month - Month number (1-12).
  * @param {number} params.year - The year (e.g. 2025).
  * @param {string} params.siteId - UUID of the site.
  * @param {string[]} [params.dimensions] - Dimensions to group by (e.g. ['utm_campaign', 'device']).
@@ -74,10 +76,12 @@ export function buildPageTypeCase(pageTypes, column) {
  * @param {Object|null} [params.pageTypes=null] - Optional pageType rules for CASE generation.
  * @param {string[]|null} [params.trfTypes] - Traffic type to filter by before
  *  grouping (e.g ['paid']).
+ * @param {number} [params.pageViewThreshold=1000] - Minimum total pageviews for a path to include.
  * @returns {Object} Template values for SQL generation.
  */
 export function getTrafficAnalysisQueryPlaceholdersFilled({
   week,
+  month,
   year,
   siteId,
   dimensions,
@@ -85,9 +89,15 @@ export function getTrafficAnalysisQueryPlaceholdersFilled({
   pageTypes = null,
   pageTypeMatchColumn = 'path',
   trfTypes = null,
+  temporalCondition = null,
+  pageViewThreshold = 1000,
 }) {
-  if (!week || !year || !siteId || !tableName) {
-    throw new Error('Missing required parameters: week, year, siteId, or tableName');
+  if (!siteId || !tableName) {
+    throw new Error('Missing required parameters: siteId, or tableName');
+  }
+
+  if (!temporalCondition && ((!week && !month) || !year)) {
+    throw new Error('Missing required parameters: week, month or year');
   }
 
   if (!Array.isArray(dimensions) || dimensions.length === 0) {
@@ -97,10 +107,10 @@ export function getTrafficAnalysisQueryPlaceholdersFilled({
   const dimensionColumns = dimensions.join(', ');
   const dimensionColumnsPrefixed = dimensions.map((col) => `a.${col}`).join(', ');
 
-  const dateRanges = getDateRanges(week, year);
-  const temporalCondition = dateRanges
-    .map((r) => `(year=${r.year} AND month=${r.month} AND week=${week})`)
-    .join(' OR ');
+  let tempCondition = null;
+  if (!temporalCondition) {
+    tempCondition = getTemporalCondition({ week, month, year });
+  }
 
   let pageTypeCase = 'NULL as page_type';
   if (dimensions.includes('page_type') && pageTypes) {
@@ -119,8 +129,9 @@ export function getTrafficAnalysisQueryPlaceholdersFilled({
     dimensionColumns,
     dimensionColumnsPrefixed,
     tableName,
-    temporalCondition,
+    temporalCondition: tempCondition,
     pageTypeCase,
     trfTypeCondition,
+    pageViewThreshold,
   };
 }

package/src/traffic-analysis/traffic-analysis-template.js

@@ -20,6 +20,7 @@
  * @param {string} params.groupBy - Group by clause
  * @param {string} params.dimensionColumnsPrefixed - Prefixed dimension columns
  * @param {string} params.pageTypeCase - Page type case statement
+ * @param {number} params.pageViewThreshold - Minimum total pageviews for path to include
  * @returns {string} The SQL query string
  */
 export function getTrafficAnalysisTemplate({
@@ -31,9 +32,21 @@ export function getTrafficAnalysisTemplate({
   groupBy,
   dimensionColumnsPrefixed,
   pageTypeCase,
+  pageViewThreshold,
 }) {
   return `
-WITH raw AS (
+WITH min_totals AS (
+    SELECT
+        path AS min_key,
+        CAST(SUM(pageviews) AS BIGINT) AS total_pageviews
+    FROM ${tableName}
+    WHERE siteid = '${siteId}'
+    AND (${temporalCondition})
+    AND ${trfTypeCondition}
+    GROUP BY path
+    HAVING SUM(pageviews) >= ${pageViewThreshold}
+),
+raw AS (
     SELECT
         path,
         ${pageTypeCase},   
@@ -55,8 +68,9 @@ WITH raw AS (
         lcp,
         cls,
         inp
-    FROM ${tableName}
-    WHERE siteid = '${siteId}'
+    FROM ${tableName} m
+    JOIN min_totals t ON m.path = t.min_key
+    WHERE m.siteid = '${siteId}'
     AND (${temporalCondition})
     AND ${trfTypeCondition}
 ),
@@ -85,7 +99,7 @@ SELECT
     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,
     1 - CAST(a.engagements AS DOUBLE) / NULLIF(a.row_count, 0)  AS bounce_rate,
-    a.engaged_scroll,
+    CAST(a.engaged_scroll AS DOUBLE) / NULLIF(a.row_count, 0) AS engaged_scroll_rate,
     a.p70_scroll,
     a.p70_lcp,
     a.p70_cls,

package/src/traffic-analysis/traffic-data-base-response.js

@@ -28,7 +28,7 @@ export const TrafficDataResponseDto = {
    *   click_rate: number,
    *   engagement_rate: number,
    *   bounce_rate: number,
-   *   engaged_scroll: number,
+   *   engaged_scroll_rate: number,
    *   p70_scroll: number,
    * }} JSON object.
    */
@@ -45,7 +45,7 @@ export const TrafficDataResponseDto = {
     click_rate: data.click_rate,
     engagement_rate: data.engagement_rate,
     bounce_rate: data.bounce_rate,
-    engaged_scroll: data.engaged_scroll,
+    engaged_scroll_rate: data.engaged_scroll_rate,
     p70_scroll: data.p70_scroll,
   }),
 };