@adobe/spacecat-shared-ahrefs-client 1.6.5 → 1.6.6

package/CHANGELOG.md

@@ -1,3 +1,10 @@
+# [@adobe/spacecat-shared-ahrefs-client-v1.6.6](https://github.com/adobe/spacecat-shared/compare/@adobe/spacecat-shared-ahrefs-client-v1.6.5...@adobe/spacecat-shared-ahrefs-client-v1.6.6) (2025-02-12)
+
+
+### Bug Fixes
+
+* **ahrefs-client:** enhance organic keywords query to use in HOTLCTR opportunity ([#589](https://github.com/adobe/spacecat-shared/issues/589)) ([23aef2e](https://github.com/adobe/spacecat-shared/commit/23aef2eef7a2e44b3d68ec8ba64378e8d4a3b605))
+
 # [@adobe/spacecat-shared-ahrefs-client-v1.6.5](https://github.com/adobe/spacecat-shared/compare/@adobe/spacecat-shared-ahrefs-client-v1.6.4...@adobe/spacecat-shared-ahrefs-client-v1.6.5) (2025-02-08)
 
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@adobe/spacecat-shared-ahrefs-client",
-  "version": "1.6.5",
+  "version": "1.6.6",
   "description": "Shared modules of the Spacecat Services - Ahrefs Client",
   "type": "module",
   "engines": {

package/src/index.d.ts

@@ -73,7 +73,13 @@ export default class AhrefsAPIClient {
 
   /**
    * Asynchronous method to get organic keywords.
+   * @param url
+   * @param country
+   * @param keywordFilter
+   * @param limit
+   * @param mode
    */
-  getOrganicKeywords(url: string, country?: string, keywordFilter?: string[], limit?: number):
+  getOrganicKeywords(url: string, country?: string, keywordFilter?: string[],
+                     limit?: number, mode?: string):
       Promise<{ result: object, fullAuditRef: string }>;
 }

package/src/index.js

@@ -172,7 +172,7 @@ export default class AhrefsAPIClient {
     return this.sendRequest('/site-explorer/metrics-history', queryParams);
   }
 
-  async getOrganicKeywords(url, country = 'us', keywordFilter = [], limit = 200) {
+  async getOrganicKeywords(url, country = 'us', keywordFilter = [], limit = 10, mode = 'prefix') {
     if (!hasText(url)) {
       throw new Error(`Invalid URL: ${url}`);
     }
@@ -185,18 +185,25 @@ export default class AhrefsAPIClient {
     if (!Number.isInteger(limit) || limit < 1) {
       throw new Error(`Invalid limit: ${limit}`);
     }
+    if (!['prefix', 'exact'].includes(mode)) {
+      throw new Error(`Invalid mode: ${mode}`);
+    }
+
     const queryParams = {
       country,
       date: new Date().toISOString().split('T')[0],
       select: [
         'keyword',
         'sum_traffic',
-        'best_position_url',
+        'volume',
+        'best_position',
+        'cpc',
+        'is_branded',
       ].join(','),
       order_by: 'sum_traffic:desc',
       target: url,
-      limit: getLimit(limit, 2000),
-      mode: 'prefix',
+      limit: getLimit(limit, 100),
+      mode,
       output: 'json',
     };
     if (keywordFilter.length > 0) {