semrush-api-client 0.1.11 → 0.1.13

package/dist/backlinks/backlinksOverview.d.ts

@@ -1,7 +1,7 @@
 import { SemrushAPIClient } from "../client";
 export type BacklinksTargetType = "root_domain" | "domain" | "url";
 export type BacklinkstExportColumns = "ascore" | "total" | "domains_num" | "urls_num" | "ips_num" | "ipclassc_num" | "follows_num" | "nofollows_num" | "sponsored_num" | "ugc_num" | "texts_num" | "images_num" | "forms_num" | "frames_num";
-export declare function backlinksOverview(this: SemrushAPIClient, { target, target_type, export_columns, outputObj, }: {
+export declare function getBacklinksOverview(this: SemrushAPIClient, { target, target_type, export_columns, outputObj, }: {
     target: string;
     target_type?: BacklinksTargetType;
     export_columns?: BacklinkstExportColumns[];

package/dist/backlinks/backlinksOverview.js

@@ -1,7 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.backlinksOverview = backlinksOverview;
-async function backlinksOverview({ target, target_type = "domain", export_columns = [
+exports.getBacklinksOverview = getBacklinksOverview;
+async function getBacklinksOverview({ target, target_type = "domain", export_columns = [
     "ascore",
     "total",
     "domains_num",

package/dist/backlinks/getAnchors.d.ts

@@ -0,0 +1,12 @@
+import { SemrushAPIClient } from "../client";
+export type AnchorsTargetType = "root_domain" | "domain" | "url";
+export type AnchorsExportColumns = "anchor" | "domains_num" | "backlinks_num" | "first_seen" | "last_seen";
+export type DisplaySort = "page_ascore_asc" | "page_ascore_desc" | "domains_num_asc" | "domains_num_desc" | "backlinks_num_asc" | "backlinks_num_desc" | "first_seen_asc" | "first_seen_desc" | "last_seen_asc" | "last_seen_desc";
+export declare function getAnchors(this: SemrushAPIClient, { target, target_type, export_columns, displaySort, display_limit, outputObj, }: {
+    target: string;
+    target_type?: AnchorsTargetType;
+    export_columns?: AnchorsExportColumns[];
+    displaySort?: DisplaySort;
+    outputObj?: boolean;
+    display_limit?: number;
+}): Promise<string | Record<string, string>[]>;

package/dist/backlinks/getAnchors.js

@@ -0,0 +1,20 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getAnchors = getAnchors;
+async function getAnchors({ target, target_type = "domain", export_columns = [
+    "anchor",
+    "domains_num",
+    "backlinks_num",
+    "first_seen",
+    "last_seen",
+], displaySort = "backlinks_num_desc", display_limit = 1000, outputObj = true, }) {
+    const params = {
+        type: "backlinks_anchors",
+        target,
+        target_type,
+        display_sort: displaySort,
+        display_limit,
+        export_columns: export_columns.join(","),
+    };
+    return this.get(this.ANALYTICS_URL + "v1/", params, outputObj);
+}

package/dist/backlinks/getBacklinks.d.ts

@@ -0,0 +1,12 @@
+import { SemrushAPIClient } from "../client";
+export type BacklinksTargetType = "root_domain" | "domain" | "url";
+export type BacklinkstExportColumns = "page_ascore" | "response_code" | "source_size" | "external_num" | "internal_num" | "redirect_url" | "source_url" | "source_title" | "image_url" | "target_url" | "target_title" | "anchor" | "image_alt" | "last_seen" | "first_seen" | "nofollow" | "form" | "frame" | "image" | "sitewide" | "newlink" | "lostlink";
+export type DisplaySort = "page_ascore_asc" | "page_ascore_desc" | "last_seen_asc" | "last_seen_desc" | "first_seen_asc" | "first_seen_desc";
+export declare function getBacklinks(this: SemrushAPIClient, { target, target_type, export_columns, displaySort, display_limit, outputObj, }: {
+    target: string;
+    target_type?: BacklinksTargetType;
+    export_columns?: BacklinkstExportColumns[];
+    displaySort?: DisplaySort;
+    outputObj?: boolean;
+    display_limit?: number;
+}): Promise<string | Record<string, string>[]>;

package/dist/backlinks/getBacklinks.js

@@ -0,0 +1,37 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getBacklinks = getBacklinks;
+async function getBacklinks({ target, target_type = "domain", export_columns = [
+    "page_ascore",
+    "response_code",
+    "source_size",
+    "external_num",
+    "internal_num",
+    "redirect_url",
+    "source_url",
+    "source_title",
+    "image_url",
+    "target_url",
+    "target_title",
+    "anchor",
+    "image_alt",
+    "last_seen",
+    "first_seen",
+    "nofollow",
+    "form",
+    "frame",
+    "image",
+    "sitewide",
+    "newlink",
+    "lostlink",
+], displaySort = "page_ascore_desc", display_limit = 1000, outputObj = true, }) {
+    const params = {
+        type: "backlinks",
+        target,
+        target_type,
+        display_sort: displaySort,
+        display_limit,
+        export_columns: export_columns.join(","),
+    };
+    return this.get(this.ANALYTICS_URL + "v1/", params, outputObj);
+}

package/dist/backlinks/getIndexedPages.d.ts

@@ -0,0 +1,12 @@
+import { SemrushAPIClient } from "../client";
+export type IndexedPageTargetType = "root_domain" | "domain" | "url";
+export type ExportColumns = "source_url" | "source_title" | "response_code" | "backlinks_num" | "domains_num" | "last_seen" | "external_num" | "internal_num";
+export type DisplaySort = "backlinks_num_asc" | "backlinks_num_desc" | "domains_num_asc" | "domains_num_desc" | "last_seen_asc" | "last_seen_desc";
+export declare function getIndexedPages(this: SemrushAPIClient, { target, target_type, export_columns, displaySort, display_limit, outputObj, }: {
+    target: string;
+    target_type?: IndexedPageTargetType;
+    export_columns?: ExportColumns[];
+    displaySort?: DisplaySort;
+    outputObj?: boolean;
+    display_limit?: number;
+}): Promise<string | Record<string, string>[]>;

package/dist/backlinks/getIndexedPages.js

@@ -0,0 +1,23 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getIndexedPages = getIndexedPages;
+async function getIndexedPages({ target, target_type = "domain", export_columns = [
+    "source_url",
+    "source_title",
+    "response_code",
+    "backlinks_num",
+    "domains_num",
+    "last_seen",
+    "external_num",
+    "internal_num",
+], displaySort = "backlinks_num_desc", display_limit = 1000, outputObj = true, }) {
+    const params = {
+        type: "backlinks_pages",
+        target,
+        target_type,
+        display_sort: displaySort,
+        display_limit,
+        export_columns: export_columns.join(","),
+    };
+    return this.get(this.ANALYTICS_URL + "v1/", params, outputObj);
+}

package/dist/client/index.d.ts

@@ -1,6 +1,6 @@
 import { getDomainOverview } from "../overview/getDomainOverview";
 import { getKeywordOverview } from "../keyword/getKeywordOverview";
-import { backlinksOverview } from "../backlinks/backlinksOverview";
+import { getBacklinksOverview } from "../backlinks/backlinksOverview";
 import { getRankDifference } from "../overview/getRankDifference";
 import { getDomainOrganic } from "../domain/getDomainOrganic";
 import { getDomainPaidSearchKeywords } from "../domain/getDomainPaidSearchKeywords";
@@ -8,6 +8,9 @@ import { getAdsCopies } from "../domain/getAdsCopies";
 import { getTrafficSummary } from "../trend/getTrafficSummary";
 import { getSemrushRank } from "../overview/getSemrushRank";
 import { getKeywordDifficulty } from "../keyword/getKeywordDifficulty";
+import { getBacklinks } from "../backlinks/getBacklinks";
+import { getAnchors } from "../backlinks/getAnchors";
+import { getIndexedPages } from "../backlinks/getIndexedPages";
 export declare class SemrushAPIClient {
     private client;
     private api_key;
@@ -20,7 +23,7 @@ export declare class SemrushAPIClient {
     get<T>(url: string, params?: Record<string, any>, outputObj?: boolean): Promise<T>;
     getDomainOverview: typeof getDomainOverview;
     getKeywordOverview: typeof getKeywordOverview;
-    backlinksOverview: typeof backlinksOverview;
+    getBacklinksOverview: typeof getBacklinksOverview;
     getRankDifference: typeof getRankDifference;
     getSemrushRank: typeof getSemrushRank;
     getDomainOrganic: typeof getDomainOrganic;
@@ -28,4 +31,7 @@ export declare class SemrushAPIClient {
     getAdsCopies: typeof getAdsCopies;
     getTrafficSummary: typeof getTrafficSummary;
     getKeywordDifficulty: typeof getKeywordDifficulty;
+    getBacklinks: typeof getBacklinks;
+    getAnchors: typeof getAnchors;
+    getIndexedPages: typeof getIndexedPages;
 }

package/dist/client/index.js

@@ -15,6 +15,9 @@ const getAdsCopies_1 = require("../domain/getAdsCopies");
 const getTrafficSummary_1 = require("../trend/getTrafficSummary");
 const getSemrushRank_1 = require("../overview/getSemrushRank");
 const getKeywordDifficulty_1 = require("../keyword/getKeywordDifficulty");
+const getBacklinks_1 = require("../backlinks/getBacklinks");
+const getAnchors_1 = require("../backlinks/getAnchors");
+const getIndexedPages_1 = require("../backlinks/getIndexedPages");
 class SemrushAPIClient {
     client;
     api_key;
@@ -62,7 +65,7 @@ class SemrushAPIClient {
     }
     getDomainOverview = getDomainOverview_1.getDomainOverview;
     getKeywordOverview = getKeywordOverview_1.getKeywordOverview;
-    backlinksOverview = backlinksOverview_1.backlinksOverview;
+    getBacklinksOverview = backlinksOverview_1.getBacklinksOverview;
     getRankDifference = getRankDifference_1.getRankDifference;
     getSemrushRank = getSemrushRank_1.getSemrushRank;
     getDomainOrganic = getDomainOrganic_1.getDomainOrganic;
@@ -70,5 +73,8 @@ class SemrushAPIClient {
     getAdsCopies = getAdsCopies_1.getAdsCopies;
     getTrafficSummary = getTrafficSummary_1.getTrafficSummary;
     getKeywordDifficulty = getKeywordDifficulty_1.getKeywordDifficulty;
+    getBacklinks = getBacklinks_1.getBacklinks;
+    getAnchors = getAnchors_1.getAnchors;
+    getIndexedPages = getIndexedPages_1.getIndexedPages;
 }
 exports.SemrushAPIClient = SemrushAPIClient;

package/dist/overview/getDomainOverview.js

@@ -1,8 +1,29 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.getDomainOverview = getDomainOverview;
-async function getDomainOverview({ domain, export_columns = ["Dn", "Or", "Rk", "Ot", "Oc"], database = "us", display_limit = 1000, outputObj = true, // Default to true for output object
- }) {
+async function getDomainOverview({ domain, export_columns = [
+    "Db",
+    "Dt",
+    "Dn",
+    "Rk",
+    "Or",
+    "Ot",
+    "Oc",
+    "Ad",
+    "At",
+    "Ac",
+    "Sh",
+    "Sv",
+    "FKn",
+    "FPn",
+    "Sr",
+    "Srb",
+    "St",
+    "Stb",
+    "Sc",
+    "Srn",
+    "Srl",
+], database = "us", display_limit = 1000, outputObj = true, }) {
     const params = {
         type: "domain_ranks",
         export_columns: export_columns.join(","),

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "semrush-api-client",
-  "version": "0.1.11",
+  "version": "0.1.13",
   "description": "",
   "license": "Apache-2.0",
   "main": "dist/index.js",

package/dist/domain/getDomainRank.js

@@ -1 +0,0 @@
-"use strict";