semrush-api-client 0.1.17 → 0.1.19

package/dist/backlinks/backlinksOverview.d.ts

@@ -6,4 +6,4 @@ export declare function getBacklinksOverview(this: SemrushAPIClient, { target, t
     target_type?: BacklinksTargetType;
     export_columns?: BacklinkstExportColumns[];
     outputObj?: boolean;
-}): Promise<string | Record<string, string>[]>;
+}): Promise<Record<string, string>[]>;

package/dist/backlinks/getAnchors.d.ts

@@ -9,4 +9,4 @@ export declare function getAnchors(this: SemrushAPIClient, { target, target_type
     displaySort?: DisplaySort;
     outputObj?: boolean;
     display_limit?: number;
-}): Promise<string | Record<string, string>[]>;
+}): Promise<Record<string, string>[]>;

package/dist/backlinks/getAnchors.js

@@ -7,7 +7,7 @@ async function getAnchors({ target, target_type = "domain", export_columns = [
     "backlinks_num",
     "first_seen",
     "last_seen",
-], displaySort = "backlinks_num_desc", display_limit = 1000, outputObj = true, }) {
+], displaySort = "backlinks_num_desc", display_limit = 10, outputObj = true, }) {
     const params = {
         type: "backlinks_anchors",
         target,

package/dist/backlinks/getBacklinks.d.ts

@@ -9,4 +9,4 @@ export declare function getBacklinks(this: SemrushAPIClient, { target, target_ty
     displaySort?: DisplaySort;
     outputObj?: boolean;
     display_limit?: number;
-}): Promise<string | Record<string, string>[]>;
+}): Promise<Record<string, string>[]>;

package/dist/backlinks/getBacklinks.js

@@ -24,7 +24,7 @@ async function getBacklinks({ target, target_type = "domain", export_columns = [
     "sitewide",
     "newlink",
     "lostlink",
-], displaySort = "page_ascore_desc", display_limit = 1000, outputObj = true, }) {
+], displaySort = "page_ascore_desc", display_limit = 10, outputObj = true, }) {
     const params = {
         type: "backlinks",
         target,

package/dist/backlinks/getIndexedPages.d.ts

@@ -9,4 +9,4 @@ export declare function getIndexedPages(this: SemrushAPIClient, { target, target
     displaySort?: DisplaySort;
     outputObj?: boolean;
     display_limit?: number;
-}): Promise<string | Record<string, string>[]>;
+}): Promise<Record<string, string>[]>;

package/dist/backlinks/getIndexedPages.js

@@ -10,7 +10,7 @@ async function getIndexedPages({ target, target_type = "domain", export_columns
     "last_seen",
     "external_num",
     "internal_num",
-], displaySort = "backlinks_num_desc", display_limit = 1000, outputObj = true, }) {
+], displaySort = "backlinks_num_desc", display_limit = 10, outputObj = true, }) {
     const params = {
         type: "backlinks_pages",
         target,

package/dist/backlinks/getReferringDomains.d.ts

@@ -9,4 +9,4 @@ export declare function getReferringDomains(this: SemrushAPIClient, { target, ta
     displaySort?: DisplaySort;
     outputObj?: boolean;
     display_limit?: number;
-}): Promise<string | Record<string, string>[]>;
+}): Promise<Record<string, string>[]>;

package/dist/backlinks/getReferringDomains.js

@@ -11,7 +11,7 @@ async function getReferringDomains({ target, target_type = "domain", export_colu
     "country",
     "first_seen",
     "last_seen",
-], displaySort = "backlinks_num_desc", display_limit = 1000, outputObj = true, }) {
+], displaySort = "backlinks_num_desc", display_limit = 10, outputObj = true, }) {
     const params = {
         type: "backlinks_refdomains",
         target,

package/dist/client/index.js

@@ -60,7 +60,7 @@ class SemrushAPIClient {
         }
         catch (error) {
             if (axios_1.default.isAxiosError(error)) {
-                throw new Error(`API request failed: ${error.message}`);
+                throw new Error(`API request failed: ${error.message}${error.code ? ` (code: ${error.code})` : ""}${error.response?.status ? ` (status: ${error.response.status})` : ""}`);
             }
             else {
                 throw new Error(`Unexpected error: ${error}`);

package/dist/domain/getAdsCopies.d.ts

@@ -7,5 +7,5 @@ export declare function getAdsCopies(this: SemrushAPIClient, { domain, export_co
     database?: Database;
     outputObj?: boolean;
     display_limit?: number;
-}): Promise<string | Record<string, string>[]>;
+}): Promise<Record<string, string>[]>;
 export {};

package/dist/domain/getAdsCopies.js

@@ -1,7 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.getAdsCopies = getAdsCopies;
-async function getAdsCopies({ domain, export_columns = ["Tt", "Ds", "Vu", "Ur", "Pc", "Un"], database = "us", display_limit = 1000, outputObj = true, }) {
+async function getAdsCopies({ domain, export_columns = ["Tt", "Ds", "Vu", "Ur", "Pc", "Un"], database = "us", display_limit = 10, outputObj = true, }) {
     const params = {
         type: "domain_adwords_unique",
         export_columns: export_columns.join(","),

package/dist/domain/getDomainOrganicSearchKeywords.d.ts

@@ -11,5 +11,5 @@ export declare function getDomainOrganicSearchKeywords(this: SemrushAPIClient, {
     outputObj?: boolean;
     displayPositionsType?: displayPositionType;
     display_limit?: number;
-}): Promise<string | Record<string, string>[]>;
+}): Promise<Record<string, string>[]>;
 export {};

package/dist/domain/getDomainOrganicSearchKeywords.js

@@ -14,7 +14,7 @@ async function getDomainOrganicSearchKeywords({ domain, export_columns = [
     "Co",
     "Nr",
     "Td",
-], database = "us", displayPosition, displayPositionsType, display_limit = 1000, outputObj = true, }) {
+], database = "us", displayPosition, displayPositionsType, display_limit = 10, outputObj = true, }) {
     const params = {
         type: "domain_organic",
         export_columns: export_columns.join(","),

package/dist/domain/getDomainOverview.d.ts

@@ -8,4 +8,4 @@ export declare function getDomainOverview(this: SemrushAPIClient, { domain, expo
     display_limit?: number;
     outputObj?: boolean;
     displayDate?: string;
-}): Promise<string | Record<string, string>[]>;
+}): Promise<Record<string, string>[]>;

package/dist/domain/getDomainOverview.js

@@ -23,7 +23,7 @@ async function getDomainOverview({ domain, export_columns = [
     "Sc",
     "Srn",
     "Srl",
-], database = "us", displayDate, display_limit = 1000, outputObj = true, }) {
+], database = "us", displayDate, display_limit = 10, outputObj = true, }) {
     const params = {
         type: "domain_ranks",
         export_columns: export_columns.join(","),

package/dist/domain/getDomainPaidSearchKeywords.d.ts

@@ -9,5 +9,5 @@ export declare function getDomainPaidSearchKeywords(this: SemrushAPIClient, { do
     database?: Database;
     outputObj?: boolean;
     display_limit?: number;
-}): Promise<string | Record<string, string>[]>;
+}): Promise<Record<string, string>[]>;
 export {};

package/dist/keyword/getBroadMatchKeywords.d.ts

@@ -9,4 +9,4 @@ export declare function getBroadMatchKeywords(this: SemrushAPIClient, { phrase,
     displaySort?: DisplaySort;
     outputObj?: boolean;
     display_limit?: number;
-}): Promise<string | Record<string, string>[]>;
+}): Promise<Record<string, string>[]>;

package/dist/keyword/getBroadMatchKeywords.js

@@ -1,7 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.getBroadMatchKeywords = getBroadMatchKeywords;
-async function getBroadMatchKeywords({ phrase, export_columns = ["Ph", "Nq", "Cp", "Co", "Nr", "Td", "In", "Kd"], database = "us", displaySort = "nq_desc", display_limit = 1000, outputObj = true, }) {
+async function getBroadMatchKeywords({ phrase, export_columns = ["Ph", "Nq", "Cp", "Co", "Nr", "Td", "In", "Kd"], database = "us", displaySort = "nq_desc", display_limit = 10, outputObj = true, }) {
     const params = {
         type: "phrase_fullsearch",
         phrase,

package/dist/keyword/getKeywordDifficulty.d.ts

@@ -6,5 +6,5 @@ export declare function getKeywordDifficulty(this: SemrushAPIClient, { phrases,
     export_columns?: ExportColumns[];
     database?: Database;
     outputObj?: boolean;
-}): Promise<string | Record<string, string>[]>;
+}): Promise<Record<string, string>[]>;
 export {};

package/dist/keyword/getKeywordOverview.d.ts

@@ -6,5 +6,5 @@ export declare function getKeywordOverview(this: SemrushAPIClient, { phrase, exp
     export_columns?: KeywordExportColumns[];
     database?: Database;
     outputObj?: boolean;
-}): Promise<string | Record<string, string>[]>;
+}): Promise<Record<string, string>[]>;
 export {};

package/dist/keyword/getPhraseQuestions.d.ts

@@ -9,4 +9,4 @@ export declare function getPhraseQuestions(this: SemrushAPIClient, { phrase, exp
     displaySort?: DisplaySort;
     outputObj?: boolean;
     display_limit?: number;
-}): Promise<string | Record<string, string>[]>;
+}): Promise<Record<string, string>[]>;

package/dist/keyword/getPhraseQuestions.js

@@ -1,7 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.getPhraseQuestions = getPhraseQuestions;
-async function getPhraseQuestions({ phrase, export_columns = ["Ph", "Nq", "Cp", "Co", "Nr", "Td", "In", "Kd"], database = "us", displaySort = "nq_desc", display_limit = 1000, outputObj = true, }) {
+async function getPhraseQuestions({ phrase, export_columns = ["Ph", "Nq", "Cp", "Co", "Nr", "Td", "In", "Kd"], database = "us", displaySort = "nq_desc", display_limit = 10, outputObj = true, }) {
     const params = {
         type: "phrase_questions",
         phrase,

package/dist/keyword/getRelatedKeywords.d.ts

@@ -1,6 +1,5 @@
 import { SemrushAPIClient } from "../client";
 import { Database } from "../type/general/database";
-export type IndexedPagephraseType = "root_domain" | "domain" | "url";
 export type ExportColumns = "Ph" | "Nq" | "Cp" | "Co" | "Nr" | "Td" | "Rr" | "Fk" | "In" | "Kd";
 export type DisplaySort = "nq_asc" | "nq_desc" | "cp_asc" | "cp_desc" | "co_asc" | "co_desc" | "nr_asc" | "nr_desc" | "rr_asc" | "rr_desc" | "kd_asc" | "kd_desc";
 export declare function getRelatedKeywords(this: SemrushAPIClient, { phrase, export_columns, database, displaySort, display_limit, outputObj, }: {
@@ -10,4 +9,4 @@ export declare function getRelatedKeywords(this: SemrushAPIClient, { phrase, exp
     displaySort?: DisplaySort;
     outputObj?: boolean;
     display_limit?: number;
-}): Promise<string | Record<string, string>[]>;
+}): Promise<Record<string, string>[]>;

package/dist/keyword/getRelatedKeywords.js

@@ -12,7 +12,7 @@ async function getRelatedKeywords({ phrase, export_columns = [
     "Fk",
     "In",
     "Kd",
-], database = "us", displaySort = "nq_desc", display_limit = 1000, outputObj = true, }) {
+], database = "us", displaySort = "nq_desc", display_limit = 10, outputObj = true, }) {
     const params = {
         type: "phrase_related",
         phrase,

package/dist/overview/getRankDifference.d.ts

@@ -7,5 +7,5 @@ export declare function getRankDifference(this: SemrushAPIClient, { domain, expo
     database?: Database;
     display_limit?: number;
     outputObj?: boolean;
-}): Promise<string | Record<string, string>[]>;
+}): Promise<Record<string, string>[]>;
 export {};

package/dist/overview/getSemrushRank.d.ts

@@ -6,5 +6,5 @@ export declare function getSemrushRank(this: SemrushAPIClient, { export_columns,
     database?: Database;
     display_limit?: number;
     outputObj?: boolean;
-}): Promise<string | Record<string, string>[]>;
+}): Promise<Record<string, string>[]>;
 export {};

package/dist/overview/getSemrushRank.js

@@ -1,7 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.getSemrushRank = getSemrushRank;
-async function getSemrushRank({ export_columns = ["Dn", "Rk", "Or", "Ot", "Oc", "Ad", "At", "Ac"], database = "us", display_limit = 1000, outputObj = true, }) {
+async function getSemrushRank({ export_columns = ["Dn", "Rk", "Or", "Ot", "Oc", "Ad", "At", "Ac"], database = "us", display_limit = 10, outputObj = true, }) {
     const params = {
         type: "rank",
         export_columns: export_columns.join(","),

package/dist/trend/getTrafficSummary.d.ts

@@ -6,4 +6,4 @@ export declare function getTrafficSummary(this: SemrushAPIClient, { domains, exp
     export_columns?: ExportColumns[];
     country?: Country;
     outputObj?: boolean;
-}): Promise<string | Record<string, string>[]>;
+}): Promise<Record<string, string>[]>;

package/package.json

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