dataforseo-client 1.0.10 → 1.0.12

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (5) hide show
  1. package/main.d.ts +1018 -480
  2. package/main.js +958 -450
  3. package/main.js.map +1 -1
  4. package/main.ts +1961 -943
  5. package/package.json +1 -1
package/main.d.ts CHANGED
@@ -1826,6 +1826,12 @@ export declare class BacklinksApi {
1826
1826
  */
1827
1827
  bulkNewLostReferringDomainsLive(body: (BacklinksBulkNewLostReferringDomainsLiveRequestInfo | undefined)[] | undefined): Promise<BacklinksBulkNewLostReferringDomainsLiveResponseInfo | null>;
1828
1828
  protected processBulkNewLostReferringDomainsLive(response: Response): Promise<BacklinksBulkNewLostReferringDomainsLiveResponseInfo | null>;
1829
+ /**
1830
+ * @param body (optional)
1831
+ * @return Successful operation
1832
+ */
1833
+ bulkPagesSummaryLive(body: (BacklinksBulkPagesSummaryLiveRequestInfo | undefined)[] | undefined): Promise<BacklinksBulkPagesSummaryLiveResponseInfo | null>;
1834
+ protected processBulkPagesSummaryLive(response: Response): Promise<BacklinksBulkPagesSummaryLiveResponseInfo | null>;
1829
1835
  }
1830
1836
  export declare class OnPageApi {
1831
1837
  private http;
@@ -3105,6 +3111,46 @@ export declare class BaseMerchantSerpElementItem implements IBaseMerchantSerpEle
3105
3111
  export interface IBaseMerchantSerpElementItem {
3106
3112
  [key: string]: any;
3107
3113
  }
3114
+ export declare class RatingElement implements IRatingElement {
3115
+ /** type of element */
3116
+ type?: string | undefined;
3117
+ /** the alignment of the element in Google Shopping SERP
3118
+ possible values:
3119
+ left, right */
3120
+ position?: string | undefined;
3121
+ /** the type of rating
3122
+ here you can find the following elements: Max5, Percents, CustomMax */
3123
+ rating_type?: string | undefined;
3124
+ /** value of the rating */
3125
+ value?: string | undefined;
3126
+ /** the amount of feedback */
3127
+ votes_count?: number | undefined;
3128
+ /** the maximum value for a rating_type */
3129
+ rating_max?: number | undefined;
3130
+ [key: string]: any;
3131
+ constructor(data?: IRatingElement);
3132
+ init(_data?: any): void;
3133
+ static fromJS(data: any): RatingElement;
3134
+ toJSON(data?: any): any;
3135
+ }
3136
+ export interface IRatingElement {
3137
+ /** type of element */
3138
+ type?: string | undefined;
3139
+ /** the alignment of the element in Google Shopping SERP
3140
+ possible values:
3141
+ left, right */
3142
+ position?: string | undefined;
3143
+ /** the type of rating
3144
+ here you can find the following elements: Max5, Percents, CustomMax */
3145
+ rating_type?: string | undefined;
3146
+ /** value of the rating */
3147
+ value?: string | undefined;
3148
+ /** the amount of feedback */
3149
+ votes_count?: number | undefined;
3150
+ /** the maximum value for a rating_type */
3151
+ rating_max?: number | undefined;
3152
+ [key: string]: any;
3153
+ }
3108
3154
  export declare class BaseBusinessDataSerpElementItem implements IBaseBusinessDataSerpElementItem {
3109
3155
  [key: string]: any;
3110
3156
  protected _discriminator: string;
@@ -8484,6 +8530,8 @@ export declare class PopularProductsElement implements IPopularProductsElement {
8484
8530
  description?: string | undefined;
8485
8531
  /** seller of the product */
8486
8532
  seller?: string | undefined;
8533
+ /** URL of the image */
8534
+ image_url?: string | undefined;
8487
8535
  /** price indicated in the element */
8488
8536
  price?: PriceInfo | undefined;
8489
8537
  /** the item’s rating
@@ -8504,6 +8552,8 @@ export interface IPopularProductsElement {
8504
8552
  description?: string | undefined;
8505
8553
  /** seller of the product */
8506
8554
  seller?: string | undefined;
8555
+ /** URL of the image */
8556
+ image_url?: string | undefined;
8507
8557
  /** price indicated in the element */
8508
8558
  price?: PriceInfo | undefined;
8509
8559
  /** the item’s rating
@@ -8527,6 +8577,8 @@ left, right */
8527
8577
  position?: string | undefined;
8528
8578
  /** the XPath of the element */
8529
8579
  xpath?: string | undefined;
8580
+ /** title of the row */
8581
+ title?: string | undefined;
8530
8582
  /** additional items present in the element
8531
8583
  if there are none, equals null */
8532
8584
  items?: (PopularProductsElement | undefined)[] | undefined;
@@ -8556,6 +8608,8 @@ left, right */
8556
8608
  position?: string | undefined;
8557
8609
  /** the XPath of the element */
8558
8610
  xpath?: string | undefined;
8611
+ /** title of the row */
8612
+ title?: string | undefined;
8559
8613
  /** additional items present in the element
8560
8614
  if there are none, equals null */
8561
8615
  items?: (PopularProductsElement | undefined)[] | undefined;
@@ -20035,7 +20089,8 @@ answer_box, carousel, events, featured_snippet, hotels_pack, images, jobs, local
20035
20089
  se_results_count?: number | undefined;
20036
20090
  /** the number of results returned in the items array */
20037
20091
  items_count?: number | undefined;
20038
- /** items featured in the faq_box */
20092
+ /** additional items present in the element
20093
+ if there are none, equals null */
20039
20094
  items?: (BaseSerpElementItem | undefined)[] | undefined;
20040
20095
  [key: string]: any;
20041
20096
  constructor(data?: ISerpBingOrganicLiveAdvancedResultInfo);
@@ -20075,7 +20130,8 @@ answer_box, carousel, events, featured_snippet, hotels_pack, images, jobs, local
20075
20130
  se_results_count?: number | undefined;
20076
20131
  /** the number of results returned in the items array */
20077
20132
  items_count?: number | undefined;
20078
- /** items featured in the faq_box */
20133
+ /** additional items present in the element
20134
+ if there are none, equals null */
20079
20135
  items?: (BaseSerpElementItem | undefined)[] | undefined;
20080
20136
  [key: string]: any;
20081
20137
  }
@@ -24101,8 +24157,7 @@ featured_snippet, images, local_pack, hotels_pack, organic, paid, people_also_as
24101
24157
  se_results_count?: number | undefined;
24102
24158
  /** the number of results returned in the items array */
24103
24159
  items_count?: number | undefined;
24104
- /** additional items present in the element
24105
- if there are none, equals null */
24160
+ /** items featured in the faq_box */
24106
24161
  items?: (BaseSerpElementItem | undefined)[] | undefined;
24107
24162
  [key: string]: any;
24108
24163
  constructor(data?: ISerpYahooOrganicLiveAdvancedResultInfo);
@@ -24142,8 +24197,7 @@ featured_snippet, images, local_pack, hotels_pack, organic, paid, people_also_as
24142
24197
  se_results_count?: number | undefined;
24143
24198
  /** the number of results returned in the items array */
24144
24199
  items_count?: number | undefined;
24145
- /** additional items present in the element
24146
- if there are none, equals null */
24200
+ /** items featured in the faq_box */
24147
24201
  items?: (BaseSerpElementItem | undefined)[] | undefined;
24148
24202
  [key: string]: any;
24149
24203
  }
@@ -34301,70 +34355,6 @@ you will find the specified tag value in the data object of the response */
34301
34355
  tag?: string | undefined;
34302
34356
  [key: string]: any;
34303
34357
  }
34304
- export declare class KeywordData implements IKeywordData {
34305
- /** search engine type */
34306
- se_type?: string | undefined;
34307
- /** returned keyword */
34308
- keyword?: string | undefined;
34309
- /** location code in a POST array */
34310
- location_code?: number | undefined;
34311
- /** language code in a POST array */
34312
- language_code?: string | undefined;
34313
- /** keyword data for the returned keyword */
34314
- keyword_info?: KeywordInfo | undefined;
34315
- /** additional information about the keyword */
34316
- keyword_properties?: KeywordProperties | undefined;
34317
- /** impressions data for the returned keyword idea
34318
- Note that all data in the impressions_info object is deprecated and provided only as legacy to avoid maintenance issues
34319
- daily_impressions values provide a more accurate alternative to Google search volume data;
34320
- the 999 bid is used to mitigate account-specific factors Google considers when calculating impressions
34321
- learn more about impressions in this help center article */
34322
- impressions_info?: ImpressionsInfo | undefined;
34323
- /** SERP data
34324
- the value will be null if you didn’t set the field include_serp_info to true in the POST array or if there is no SERP data for this keyword in our database */
34325
- serp_info?: SerpInfo | undefined;
34326
- /** backlink data for the returned keyword
34327
- this object provides the average number of backlinks, referring pages and domains, as well as the average rank values among the top-10 websites ranking organically for the keyword */
34328
- avg_backlinks_info?: AvgBacklinksInfo | undefined;
34329
- /** search intent info for the returned keyword
34330
- learn about search intent in this help center article */
34331
- search_intent_info?: SearchIntentInfo | undefined;
34332
- [key: string]: any;
34333
- constructor(data?: IKeywordData);
34334
- init(_data?: any): void;
34335
- static fromJS(data: any): KeywordData;
34336
- toJSON(data?: any): any;
34337
- }
34338
- export interface IKeywordData {
34339
- /** search engine type */
34340
- se_type?: string | undefined;
34341
- /** returned keyword */
34342
- keyword?: string | undefined;
34343
- /** location code in a POST array */
34344
- location_code?: number | undefined;
34345
- /** language code in a POST array */
34346
- language_code?: string | undefined;
34347
- /** keyword data for the returned keyword */
34348
- keyword_info?: KeywordInfo | undefined;
34349
- /** additional information about the keyword */
34350
- keyword_properties?: KeywordProperties | undefined;
34351
- /** impressions data for the returned keyword idea
34352
- Note that all data in the impressions_info object is deprecated and provided only as legacy to avoid maintenance issues
34353
- daily_impressions values provide a more accurate alternative to Google search volume data;
34354
- the 999 bid is used to mitigate account-specific factors Google considers when calculating impressions
34355
- learn more about impressions in this help center article */
34356
- impressions_info?: ImpressionsInfo | undefined;
34357
- /** SERP data
34358
- the value will be null if you didn’t set the field include_serp_info to true in the POST array or if there is no SERP data for this keyword in our database */
34359
- serp_info?: SerpInfo | undefined;
34360
- /** backlink data for the returned keyword
34361
- this object provides the average number of backlinks, referring pages and domains, as well as the average rank values among the top-10 websites ranking organically for the keyword */
34362
- avg_backlinks_info?: AvgBacklinksInfo | undefined;
34363
- /** search intent info for the returned keyword
34364
- learn about search intent in this help center article */
34365
- search_intent_info?: SearchIntentInfo | undefined;
34366
- [key: string]: any;
34367
- }
34368
34358
  export declare class RankChanges implements IRankChanges {
34369
34359
  /** previous absolute rank in SERP
34370
34360
  indicates previous rank of the element in Google SERP;
@@ -34477,11 +34467,11 @@ the popularity rate based on reviews and displayed in SERP */
34477
34467
  /** sitelinks
34478
34468
  the links shown below some of Google’s search results
34479
34469
  if there are none, equals null */
34480
- links?: (LinkElement | undefined)[] | undefined;
34470
+ links?: (AdLinkElement | undefined)[] | undefined;
34481
34471
  /** contains information from the ‘About this result’ panel
34482
34472
  ‘About this result’ panel provides additional context about why Google returned this result for the given query;
34483
34473
  this feature appears after clicking on the three dots next to most results */
34484
- about_this_result?: AboutThisResultElement | undefined;
34474
+ about_this_result?: any | undefined;
34485
34475
  /** primary domain name in SERP */
34486
34476
  main_domain?: string | undefined;
34487
34477
  /** URL in SERP that does not specify the HTTPs protocol and domain name */
@@ -34563,11 +34553,11 @@ the popularity rate based on reviews and displayed in SERP */
34563
34553
  /** sitelinks
34564
34554
  the links shown below some of Google’s search results
34565
34555
  if there are none, equals null */
34566
- links?: (LinkElement | undefined)[] | undefined;
34556
+ links?: (AdLinkElement | undefined)[] | undefined;
34567
34557
  /** contains information from the ‘About this result’ panel
34568
34558
  ‘About this result’ panel provides additional context about why Google returned this result for the given query;
34569
34559
  this feature appears after clicking on the three dots next to most results */
34570
- about_this_result?: AboutThisResultElement | undefined;
34560
+ about_this_result?: any | undefined;
34571
34561
  /** primary domain name in SERP */
34572
34562
  main_domain?: string | undefined;
34573
34563
  /** URL in SERP that does not specify the HTTPs protocol and domain name */
@@ -34677,7 +34667,7 @@ export declare class DataforseoLabsGoogleRankedKeywordsLiveItem implements IData
34677
34667
  /** search engine type */
34678
34668
  se_type?: string | undefined;
34679
34669
  /** keyword data for the returned keyword */
34680
- keyword_data?: KeywordData | undefined;
34670
+ keyword_data?: KeywordDataInfo | undefined;
34681
34671
  /** contains data on the domain’s SERP element found for the returned keyword */
34682
34672
  ranked_serp_element?: RankedSerpElement | undefined;
34683
34673
  [key: string]: any;
@@ -34690,11 +34680,145 @@ export interface IDataforseoLabsGoogleRankedKeywordsLiveItem {
34690
34680
  /** search engine type */
34691
34681
  se_type?: string | undefined;
34692
34682
  /** keyword data for the returned keyword */
34693
- keyword_data?: KeywordData | undefined;
34683
+ keyword_data?: KeywordDataInfo | undefined;
34694
34684
  /** contains data on the domain’s SERP element found for the returned keyword */
34695
34685
  ranked_serp_element?: RankedSerpElement | undefined;
34696
34686
  [key: string]: any;
34697
34687
  }
34688
+ export declare class PaidDataforseoLabsSerpElementItem extends BaseDataforseoLabsSerpElementItem implements IPaidDataforseoLabsSerpElementItem {
34689
+ /** search engine type */
34690
+ se_type?: string | undefined;
34691
+ /** position within a group of elements with identical type values
34692
+ positions of elements with different type values are omitted from rank_group */
34693
+ rank_group?: number | undefined;
34694
+ /** absolute rank in SERP
34695
+ absolute position among all the elements in SERP */
34696
+ rank_absolute?: number | undefined;
34697
+ /** the alignment of the element in SERP
34698
+ can take the following values:
34699
+ left, right */
34700
+ position?: string | undefined;
34701
+ /** the XPath of the element */
34702
+ xpath?: string | undefined;
34703
+ /** title of the result in SERP */
34704
+ title?: string | undefined;
34705
+ /** subdomain in SERP */
34706
+ domain?: string | undefined;
34707
+ /** description of the results element in SERP */
34708
+ description?: string | undefined;
34709
+ /** breadcrumb in SERP */
34710
+ breadcrumb?: string | undefined;
34711
+ /** relevant URL in SERP */
34712
+ url?: string | undefined;
34713
+ /** words highlighted in bold within the results description */
34714
+ highlighted?: (string | undefined)[] | undefined;
34715
+ /** additional information about the result */
34716
+ extra?: {
34717
+ [key: string]: string;
34718
+ } | undefined;
34719
+ /** extended description
34720
+ if there is none, equals null */
34721
+ description_rows?: (string | undefined)[] | undefined;
34722
+ /** sitelinks
34723
+ the links shown below some of Google’s search results
34724
+ if there are none, equals null */
34725
+ links?: (AdLinkElement | undefined)[] | undefined;
34726
+ /** primary domain name in SERP */
34727
+ main_domain?: string | undefined;
34728
+ /** URL in SERP that does not specify the HTTPs protocol and domain name */
34729
+ relative_url?: string | undefined;
34730
+ /** estimated traffic volume
34731
+ estimated paid monthly traffic to the domain
34732
+ calculated as the product of CTR (click-through-rate) and search volume values of all keywords in the category that the domain ranks for
34733
+ learn more about how the metric is calculated in this help center article */
34734
+ etv?: number | undefined;
34735
+ /** estimated traffic volume based on impressions
34736
+ estimated paid monthly traffic to the domain
34737
+ calculated as the product of CTR (click-through-rate) and impressions values of all keywords in the category that the domain ranks for
34738
+ learn more about how the metric is calculated in this help center article */
34739
+ impressions_etv?: number | undefined;
34740
+ /** estimated cost of monthly search traffic
34741
+ represents the estimated cost of paid monthly traffic (USD) based on etv and cpc values of all keywords in the category that the domain ranks for
34742
+ learn more about how the metric is calculated in this help center article */
34743
+ estimated_paid_traffic_cost?: number | undefined;
34744
+ /** changes in rankings
34745
+ contains information about the ranking changes of the SERP element since the previous_updated_time */
34746
+ rank_changes?: RankChanges | undefined;
34747
+ /** backlinks information for the target website */
34748
+ backlinks_info?: BacklinksInfo | undefined;
34749
+ /** page and domain rank information */
34750
+ rank_info?: RankInfo | undefined;
34751
+ [key: string]: any;
34752
+ constructor(data?: IPaidDataforseoLabsSerpElementItem);
34753
+ init(_data?: any): void;
34754
+ static fromJS(data: any): PaidDataforseoLabsSerpElementItem;
34755
+ toJSON(data?: any): any;
34756
+ }
34757
+ export interface IPaidDataforseoLabsSerpElementItem extends IBaseDataforseoLabsSerpElementItem {
34758
+ /** search engine type */
34759
+ se_type?: string | undefined;
34760
+ /** position within a group of elements with identical type values
34761
+ positions of elements with different type values are omitted from rank_group */
34762
+ rank_group?: number | undefined;
34763
+ /** absolute rank in SERP
34764
+ absolute position among all the elements in SERP */
34765
+ rank_absolute?: number | undefined;
34766
+ /** the alignment of the element in SERP
34767
+ can take the following values:
34768
+ left, right */
34769
+ position?: string | undefined;
34770
+ /** the XPath of the element */
34771
+ xpath?: string | undefined;
34772
+ /** title of the result in SERP */
34773
+ title?: string | undefined;
34774
+ /** subdomain in SERP */
34775
+ domain?: string | undefined;
34776
+ /** description of the results element in SERP */
34777
+ description?: string | undefined;
34778
+ /** breadcrumb in SERP */
34779
+ breadcrumb?: string | undefined;
34780
+ /** relevant URL in SERP */
34781
+ url?: string | undefined;
34782
+ /** words highlighted in bold within the results description */
34783
+ highlighted?: (string | undefined)[] | undefined;
34784
+ /** additional information about the result */
34785
+ extra?: {
34786
+ [key: string]: string;
34787
+ } | undefined;
34788
+ /** extended description
34789
+ if there is none, equals null */
34790
+ description_rows?: (string | undefined)[] | undefined;
34791
+ /** sitelinks
34792
+ the links shown below some of Google’s search results
34793
+ if there are none, equals null */
34794
+ links?: (AdLinkElement | undefined)[] | undefined;
34795
+ /** primary domain name in SERP */
34796
+ main_domain?: string | undefined;
34797
+ /** URL in SERP that does not specify the HTTPs protocol and domain name */
34798
+ relative_url?: string | undefined;
34799
+ /** estimated traffic volume
34800
+ estimated paid monthly traffic to the domain
34801
+ calculated as the product of CTR (click-through-rate) and search volume values of all keywords in the category that the domain ranks for
34802
+ learn more about how the metric is calculated in this help center article */
34803
+ etv?: number | undefined;
34804
+ /** estimated traffic volume based on impressions
34805
+ estimated paid monthly traffic to the domain
34806
+ calculated as the product of CTR (click-through-rate) and impressions values of all keywords in the category that the domain ranks for
34807
+ learn more about how the metric is calculated in this help center article */
34808
+ impressions_etv?: number | undefined;
34809
+ /** estimated cost of monthly search traffic
34810
+ represents the estimated cost of paid monthly traffic (USD) based on etv and cpc values of all keywords in the category that the domain ranks for
34811
+ learn more about how the metric is calculated in this help center article */
34812
+ estimated_paid_traffic_cost?: number | undefined;
34813
+ /** changes in rankings
34814
+ contains information about the ranking changes of the SERP element since the previous_updated_time */
34815
+ rank_changes?: RankChanges | undefined;
34816
+ /** backlinks information for the target website */
34817
+ backlinks_info?: BacklinksInfo | undefined;
34818
+ /** page and domain rank information */
34819
+ rank_info?: RankInfo | undefined;
34820
+ [key: string]: any;
34821
+ }
34698
34822
  export declare class DataforseoLabsGoogleRankedKeywordsLiveResultInfo implements IDataforseoLabsGoogleRankedKeywordsLiveResultInfo {
34699
34823
  /** search engine type */
34700
34824
  se_type?: string | undefined;
@@ -35781,11 +35905,11 @@ you will find the specified tag value in the data object of the response */
35781
35905
  tag?: string | undefined;
35782
35906
  [key: string]: any;
35783
35907
  }
35784
- export declare class DataforseoLabsDomainIntersectionLiveItem implements IDataforseoLabsDomainIntersectionLiveItem {
35908
+ export declare class DataforseoLabsGoogleDomainIntersectionLiveItem implements IDataforseoLabsGoogleDomainIntersectionLiveItem {
35785
35909
  /** search engine type */
35786
35910
  se_type?: string | undefined;
35787
35911
  /** keyword data for the returned keyword */
35788
- keyword_data?: KeywordData | undefined;
35912
+ keyword_data?: KeywordDataInfo | undefined;
35789
35913
  /** contains data on the first domain’s SERP element found for the returned keyword
35790
35914
  the list of supported SERP elements can be found below */
35791
35915
  first_domain_serp_element?: BaseDataforseoLabsSerpElementItem | undefined;
@@ -35793,16 +35917,16 @@ the list of supported SERP elements can be found below */
35793
35917
  the list of supported SERP elements can be found below */
35794
35918
  second_domain_serp_element?: BaseDataforseoLabsSerpElementItem | undefined;
35795
35919
  [key: string]: any;
35796
- constructor(data?: IDataforseoLabsDomainIntersectionLiveItem);
35920
+ constructor(data?: IDataforseoLabsGoogleDomainIntersectionLiveItem);
35797
35921
  init(_data?: any): void;
35798
- static fromJS(data: any): DataforseoLabsDomainIntersectionLiveItem;
35922
+ static fromJS(data: any): DataforseoLabsGoogleDomainIntersectionLiveItem;
35799
35923
  toJSON(data?: any): any;
35800
35924
  }
35801
- export interface IDataforseoLabsDomainIntersectionLiveItem {
35925
+ export interface IDataforseoLabsGoogleDomainIntersectionLiveItem {
35802
35926
  /** search engine type */
35803
35927
  se_type?: string | undefined;
35804
35928
  /** keyword data for the returned keyword */
35805
- keyword_data?: KeywordData | undefined;
35929
+ keyword_data?: KeywordDataInfo | undefined;
35806
35930
  /** contains data on the first domain’s SERP element found for the returned keyword
35807
35931
  the list of supported SERP elements can be found below */
35808
35932
  first_domain_serp_element?: BaseDataforseoLabsSerpElementItem | undefined;
@@ -35827,7 +35951,7 @@ export declare class DataforseoLabsGoogleDomainIntersectionLiveResultInfo implem
35827
35951
  /** the number of results returned in the items array */
35828
35952
  items_count?: number | undefined;
35829
35953
  /** contains keywords, relevant SERP elements and related data */
35830
- items?: (DataforseoLabsDomainIntersectionLiveItem | undefined)[] | undefined;
35954
+ items?: (DataforseoLabsGoogleDomainIntersectionLiveItem | undefined)[] | undefined;
35831
35955
  [key: string]: any;
35832
35956
  constructor(data?: IDataforseoLabsGoogleDomainIntersectionLiveResultInfo);
35833
35957
  init(_data?: any): void;
@@ -35850,7 +35974,7 @@ export interface IDataforseoLabsGoogleDomainIntersectionLiveResultInfo {
35850
35974
  /** the number of results returned in the items array */
35851
35975
  items_count?: number | undefined;
35852
35976
  /** contains keywords, relevant SERP elements and related data */
35853
- items?: (DataforseoLabsDomainIntersectionLiveItem | undefined)[] | undefined;
35977
+ items?: (DataforseoLabsGoogleDomainIntersectionLiveItem | undefined)[] | undefined;
35854
35978
  [key: string]: any;
35855
35979
  }
35856
35980
  export declare class DataforseoLabsGoogleDomainIntersectionLiveTaskInfo extends BaseResponseTaskInfo implements IDataforseoLabsGoogleDomainIntersectionLiveTaskInfo {
@@ -37948,12 +38072,6 @@ learn more about how the metric is calculated in this help center article */
37948
38072
  ranking changes of the SERP element compared to the preceding month;
37949
38073
  Note: the changes are calculated even if the preceding month is not included in a POST request */
37950
38074
  rank_changes?: RankChanges | undefined;
37951
- /** search engine type */
37952
- se_type?: string | undefined;
37953
- /** backlinks information for the target website */
37954
- backlinks_info?: BacklinksInfo | undefined;
37955
- /** page and domain rank information */
37956
- rank_info?: RankInfo | undefined;
37957
38075
  [key: string]: any;
37958
38076
  constructor(data?: ILocalPackDataforseoLabsSerpElementItem);
37959
38077
  init(_data?: any): void;
@@ -38011,12 +38129,6 @@ learn more about how the metric is calculated in this help center article */
38011
38129
  ranking changes of the SERP element compared to the preceding month;
38012
38130
  Note: the changes are calculated even if the preceding month is not included in a POST request */
38013
38131
  rank_changes?: RankChanges | undefined;
38014
- /** search engine type */
38015
- se_type?: string | undefined;
38016
- /** backlinks information for the target website */
38017
- backlinks_info?: BacklinksInfo | undefined;
38018
- /** page and domain rank information */
38019
- rank_info?: RankInfo | undefined;
38020
38132
  [key: string]: any;
38021
38133
  }
38022
38134
  export declare class HotelsPackDataforseoLabsSerpElementItem extends BaseDataforseoLabsSerpElementItem implements IHotelsPackDataforseoLabsSerpElementItem {
@@ -38295,140 +38407,6 @@ kc:/shopping/gpc:organic-offers */
38295
38407
  items?: (KnowledgeGraphShoppingElement | undefined)[] | undefined;
38296
38408
  [key: string]: any;
38297
38409
  }
38298
- export declare class PaidDataforseoLabsSerpElementItem extends BaseDataforseoLabsSerpElementItem implements IPaidDataforseoLabsSerpElementItem {
38299
- /** position within a group of elements with identical type values
38300
- positions of elements with different type values are omitted from rank_group */
38301
- rank_group?: number | undefined;
38302
- /** absolute rank in SERP
38303
- absolute position among all the elements in SERP */
38304
- rank_absolute?: number | undefined;
38305
- /** the alignment of the element in SERP
38306
- can take the following values:
38307
- left, right */
38308
- position?: string | undefined;
38309
- /** the XPath of the element */
38310
- xpath?: string | undefined;
38311
- /** title of the result in SERP */
38312
- title?: string | undefined;
38313
- /** domain where a link points */
38314
- domain?: string | undefined;
38315
- /** description of the results element in SERP */
38316
- description?: string | undefined;
38317
- /** breadcrumb of the Ad element in SERP */
38318
- breadcrumb?: string | undefined;
38319
- /** relevant URL of the Ad element in SERP */
38320
- url?: string | undefined;
38321
- /** words highlighted in bold within the results description */
38322
- highlighted?: (string | undefined)[] | undefined;
38323
- /** additional information about the result */
38324
- extra?: {
38325
- [key: string]: string;
38326
- } | undefined;
38327
- /** extended description
38328
- if there is none, equals null */
38329
- description_rows?: (string | undefined)[] | undefined;
38330
- /** link of the element */
38331
- links?: (AdLinkElement | undefined)[] | undefined;
38332
- /** primary domain name in SERP */
38333
- main_domain?: string | undefined;
38334
- /** URL in SERP that does not specify the HTTPs protocol and domain name */
38335
- relative_url?: string | undefined;
38336
- /** estimated traffic volume
38337
- estimated organic monthly traffic to the domain
38338
- calculated as the product of CTR (click-through-rate) and search volume values of the returned keyword
38339
- learn more about how the metric is calculated in this help center article */
38340
- etv?: number | undefined;
38341
- /** estimated traffic volume based on impressions
38342
- estimated organic monthly traffic to the domain
38343
- calculated as the product of CTR (click-through-rate) and impressions values of the returned keyword
38344
- learn more about how the metric is calculated in this help center article */
38345
- impressions_etv?: number | undefined;
38346
- /** estimated cost of converting organic search traffic into paid
38347
- represents the estimated monthly cost of running ads for the returned keyword
38348
- the metric is calculated as the product of organic etv and paid cpc values and indicates the cost of driving the estimated volume of monthly organic traffic through PPC advertising in Google Search
38349
- learn more about how the metric is calculated in this help center article */
38350
- estimated_paid_traffic_cost?: number | undefined;
38351
- /** changes in rankings
38352
- ranking changes of the SERP element compared to the preceding month;
38353
- Note: the changes are calculated even if the preceding month is not included in a POST request */
38354
- rank_changes?: RankChanges | undefined;
38355
- /** search engine type */
38356
- se_type?: string | undefined;
38357
- /** backlinks information for the target website */
38358
- backlinks_info?: BacklinksInfo | undefined;
38359
- /** page and domain rank information */
38360
- rank_info?: RankInfo | undefined;
38361
- [key: string]: any;
38362
- constructor(data?: IPaidDataforseoLabsSerpElementItem);
38363
- init(_data?: any): void;
38364
- static fromJS(data: any): PaidDataforseoLabsSerpElementItem;
38365
- toJSON(data?: any): any;
38366
- }
38367
- export interface IPaidDataforseoLabsSerpElementItem extends IBaseDataforseoLabsSerpElementItem {
38368
- /** position within a group of elements with identical type values
38369
- positions of elements with different type values are omitted from rank_group */
38370
- rank_group?: number | undefined;
38371
- /** absolute rank in SERP
38372
- absolute position among all the elements in SERP */
38373
- rank_absolute?: number | undefined;
38374
- /** the alignment of the element in SERP
38375
- can take the following values:
38376
- left, right */
38377
- position?: string | undefined;
38378
- /** the XPath of the element */
38379
- xpath?: string | undefined;
38380
- /** title of the result in SERP */
38381
- title?: string | undefined;
38382
- /** domain where a link points */
38383
- domain?: string | undefined;
38384
- /** description of the results element in SERP */
38385
- description?: string | undefined;
38386
- /** breadcrumb of the Ad element in SERP */
38387
- breadcrumb?: string | undefined;
38388
- /** relevant URL of the Ad element in SERP */
38389
- url?: string | undefined;
38390
- /** words highlighted in bold within the results description */
38391
- highlighted?: (string | undefined)[] | undefined;
38392
- /** additional information about the result */
38393
- extra?: {
38394
- [key: string]: string;
38395
- } | undefined;
38396
- /** extended description
38397
- if there is none, equals null */
38398
- description_rows?: (string | undefined)[] | undefined;
38399
- /** link of the element */
38400
- links?: (AdLinkElement | undefined)[] | undefined;
38401
- /** primary domain name in SERP */
38402
- main_domain?: string | undefined;
38403
- /** URL in SERP that does not specify the HTTPs protocol and domain name */
38404
- relative_url?: string | undefined;
38405
- /** estimated traffic volume
38406
- estimated organic monthly traffic to the domain
38407
- calculated as the product of CTR (click-through-rate) and search volume values of the returned keyword
38408
- learn more about how the metric is calculated in this help center article */
38409
- etv?: number | undefined;
38410
- /** estimated traffic volume based on impressions
38411
- estimated organic monthly traffic to the domain
38412
- calculated as the product of CTR (click-through-rate) and impressions values of the returned keyword
38413
- learn more about how the metric is calculated in this help center article */
38414
- impressions_etv?: number | undefined;
38415
- /** estimated cost of converting organic search traffic into paid
38416
- represents the estimated monthly cost of running ads for the returned keyword
38417
- the metric is calculated as the product of organic etv and paid cpc values and indicates the cost of driving the estimated volume of monthly organic traffic through PPC advertising in Google Search
38418
- learn more about how the metric is calculated in this help center article */
38419
- estimated_paid_traffic_cost?: number | undefined;
38420
- /** changes in rankings
38421
- ranking changes of the SERP element compared to the preceding month;
38422
- Note: the changes are calculated even if the preceding month is not included in a POST request */
38423
- rank_changes?: RankChanges | undefined;
38424
- /** search engine type */
38425
- se_type?: string | undefined;
38426
- /** backlinks information for the target website */
38427
- backlinks_info?: BacklinksInfo | undefined;
38428
- /** page and domain rank information */
38429
- rank_info?: RankInfo | undefined;
38430
- [key: string]: any;
38431
- }
38432
38410
  export declare class GoogleReviewsDataforseoLabsSerpElementItem extends BaseDataforseoLabsSerpElementItem implements IGoogleReviewsDataforseoLabsSerpElementItem {
38433
38411
  /** position within a group of elements with identical type values
38434
38412
  positions of elements with different type values are omitted from rank_group */
@@ -39401,6 +39379,11 @@ if you use this parameter, our system will correlate data you obtain now with pr
39401
39379
  this parameter is intended to mitigate any inconsistencies that may result from changes to our database
39402
39380
  we recommend always setting correlate to true */
39403
39381
  correlate?: boolean | undefined;
39382
+ /** ignore highly similar keywords
39383
+ optional field
39384
+ if set to true, only data based on core keywords will be returned, data for all highly similar keywords will be excluded;
39385
+ default value: false */
39386
+ ignore_synonyms?: boolean | undefined;
39404
39387
  /** user-defined task identifier
39405
39388
  optional field
39406
39389
  the character limit is 255
@@ -39471,6 +39454,11 @@ if you use this parameter, our system will correlate data you obtain now with pr
39471
39454
  this parameter is intended to mitigate any inconsistencies that may result from changes to our database
39472
39455
  we recommend always setting correlate to true */
39473
39456
  correlate?: boolean | undefined;
39457
+ /** ignore highly similar keywords
39458
+ optional field
39459
+ if set to true, only data based on core keywords will be returned, data for all highly similar keywords will be excluded;
39460
+ default value: false */
39461
+ ignore_synonyms?: boolean | undefined;
39474
39462
  /** user-defined task identifier
39475
39463
  optional field
39476
39464
  the character limit is 255
@@ -39887,11 +39875,11 @@ you will find the specified tag value in the data object of the response */
39887
39875
  tag?: string | undefined;
39888
39876
  [key: string]: any;
39889
39877
  }
39890
- export declare class DataforseoLabsPageIntersectionLiveItem implements IDataforseoLabsPageIntersectionLiveItem {
39878
+ export declare class DataforseoLabsGooglePageIntersectionLiveItem implements IDataforseoLabsGooglePageIntersectionLiveItem {
39891
39879
  /** search engine type */
39892
39880
  se_type?: string | undefined;
39893
39881
  /** keyword data for the returned keyword */
39894
- keyword_data?: KeywordData | undefined;
39882
+ keyword_data?: KeywordDataInfo | undefined;
39895
39883
  /** contains data on the SERP elements found for the returned keyword
39896
39884
  data will be provided in separate arrays for each URL you specified in the pages object when setting a task;
39897
39885
  depending on the number of specified URLs, it can contain from 1 to 20 arrays named respectively */
@@ -39899,16 +39887,16 @@ depending on the number of specified URLs, it can contain from 1 to 20 arrays na
39899
39887
  [key: string]: BaseDataforseoLabsSerpElementItem;
39900
39888
  } | undefined;
39901
39889
  [key: string]: any;
39902
- constructor(data?: IDataforseoLabsPageIntersectionLiveItem);
39890
+ constructor(data?: IDataforseoLabsGooglePageIntersectionLiveItem);
39903
39891
  init(_data?: any): void;
39904
- static fromJS(data: any): DataforseoLabsPageIntersectionLiveItem;
39892
+ static fromJS(data: any): DataforseoLabsGooglePageIntersectionLiveItem;
39905
39893
  toJSON(data?: any): any;
39906
39894
  }
39907
- export interface IDataforseoLabsPageIntersectionLiveItem {
39895
+ export interface IDataforseoLabsGooglePageIntersectionLiveItem {
39908
39896
  /** search engine type */
39909
39897
  se_type?: string | undefined;
39910
39898
  /** keyword data for the returned keyword */
39911
- keyword_data?: KeywordData | undefined;
39899
+ keyword_data?: KeywordDataInfo | undefined;
39912
39900
  /** contains data on the SERP elements found for the returned keyword
39913
39901
  data will be provided in separate arrays for each URL you specified in the pages object when setting a task;
39914
39902
  depending on the number of specified URLs, it can contain from 1 to 20 arrays named respectively */
@@ -39935,7 +39923,7 @@ export declare class DataforseoLabsGooglePageIntersectionLiveResultInfo implemen
39935
39923
  /** the number of results returned in the items array */
39936
39924
  items_count?: number | undefined;
39937
39925
  /** contains keywords, relevant SERP elements and related data */
39938
- items?: (DataforseoLabsPageIntersectionLiveItem | undefined)[] | undefined;
39926
+ items?: (DataforseoLabsGooglePageIntersectionLiveItem | undefined)[] | undefined;
39939
39927
  [key: string]: any;
39940
39928
  constructor(data?: IDataforseoLabsGooglePageIntersectionLiveResultInfo);
39941
39929
  init(_data?: any): void;
@@ -39960,7 +39948,7 @@ export interface IDataforseoLabsGooglePageIntersectionLiveResultInfo {
39960
39948
  /** the number of results returned in the items array */
39961
39949
  items_count?: number | undefined;
39962
39950
  /** contains keywords, relevant SERP elements and related data */
39963
- items?: (DataforseoLabsPageIntersectionLiveItem | undefined)[] | undefined;
39951
+ items?: (DataforseoLabsGooglePageIntersectionLiveItem | undefined)[] | undefined;
39964
39952
  [key: string]: any;
39965
39953
  }
39966
39954
  export declare class DataforseoLabsGooglePageIntersectionLiveTaskInfo extends BaseResponseTaskInfo implements IDataforseoLabsGooglePageIntersectionLiveTaskInfo {
@@ -40133,7 +40121,7 @@ learn more about how the metric is calculated in this help center article */
40133
40121
  count?: number | undefined;
40134
40122
  [key: string]: any;
40135
40123
  }
40136
- export declare class DataforseoLabsBulkTrafficEstimationLiveItem implements IDataforseoLabsBulkTrafficEstimationLiveItem {
40124
+ export declare class DataforseoLabsBBulkTrafficEstimationLiveItem implements IDataforseoLabsBBulkTrafficEstimationLiveItem {
40137
40125
  /** search engine type */
40138
40126
  se_type?: string | undefined;
40139
40127
  /** target domain in a POST array */
@@ -40143,12 +40131,12 @@ export declare class DataforseoLabsBulkTrafficEstimationLiveItem implements IDat
40143
40131
  [key: string]: BulkMetricsInfo;
40144
40132
  } | undefined;
40145
40133
  [key: string]: any;
40146
- constructor(data?: IDataforseoLabsBulkTrafficEstimationLiveItem);
40134
+ constructor(data?: IDataforseoLabsBBulkTrafficEstimationLiveItem);
40147
40135
  init(_data?: any): void;
40148
- static fromJS(data: any): DataforseoLabsBulkTrafficEstimationLiveItem;
40136
+ static fromJS(data: any): DataforseoLabsBBulkTrafficEstimationLiveItem;
40149
40137
  toJSON(data?: any): any;
40150
40138
  }
40151
- export interface IDataforseoLabsBulkTrafficEstimationLiveItem {
40139
+ export interface IDataforseoLabsBBulkTrafficEstimationLiveItem {
40152
40140
  /** search engine type */
40153
40141
  se_type?: string | undefined;
40154
40142
  /** target domain in a POST array */
@@ -40173,7 +40161,7 @@ if there is no data, then the value is null */
40173
40161
  /** the number of results returned in the items array */
40174
40162
  items_count?: number | undefined;
40175
40163
  /** array of items with relevant traffic estimation data */
40176
- items?: (DataforseoLabsBulkTrafficEstimationLiveItem | undefined)[] | undefined;
40164
+ items?: (DataforseoLabsBBulkTrafficEstimationLiveItem | undefined)[] | undefined;
40177
40165
  [key: string]: any;
40178
40166
  constructor(data?: IDataforseoLabsGoogleBulkTrafficEstimationLiveResultInfo);
40179
40167
  init(_data?: any): void;
@@ -40194,7 +40182,7 @@ if there is no data, then the value is null */
40194
40182
  /** the number of results returned in the items array */
40195
40183
  items_count?: number | undefined;
40196
40184
  /** array of items with relevant traffic estimation data */
40197
- items?: (DataforseoLabsBulkTrafficEstimationLiveItem | undefined)[] | undefined;
40185
+ items?: (DataforseoLabsBBulkTrafficEstimationLiveItem | undefined)[] | undefined;
40198
40186
  [key: string]: any;
40199
40187
  }
40200
40188
  export declare class DataforseoLabsGoogleBulkTrafficEstimationLiveTaskInfo extends BaseResponseTaskInfo implements IDataforseoLabsGoogleBulkTrafficEstimationLiveTaskInfo {
@@ -40277,6 +40265,11 @@ date format: "yyyy-mm-dd"
40277
40265
  example:
40278
40266
  "2021-04-01" */
40279
40267
  date_to?: string | undefined;
40268
+ /** ignore highly similar keywords
40269
+ optional field
40270
+ if set to true only core keywords will be returned, all highly similar keywords will be excluded;
40271
+ default value: false */
40272
+ ignore_synonyms?: boolean | undefined;
40280
40273
  /** display results by item type
40281
40274
  optional field
40282
40275
  indicates the type of search results included in the response;
@@ -40350,6 +40343,11 @@ date format: "yyyy-mm-dd"
40350
40343
  example:
40351
40344
  "2021-04-01" */
40352
40345
  date_to?: string | undefined;
40346
+ /** ignore highly similar keywords
40347
+ optional field
40348
+ if set to true only core keywords will be returned, all highly similar keywords will be excluded;
40349
+ default value: false */
40350
+ ignore_synonyms?: boolean | undefined;
40353
40351
  /** display results by item type
40354
40352
  optional field
40355
40353
  indicates the type of search results included in the response;
@@ -40895,6 +40893,56 @@ you will find the specified tag value in the data object of the response */
40895
40893
  tag?: string | undefined;
40896
40894
  [key: string]: any;
40897
40895
  }
40896
+ export declare class KeywordDataKeywordDataInfo implements IKeywordDataKeywordDataInfo {
40897
+ /** search engine type
40898
+ search engine type specified in a POST request;
40899
+ for this endpoint, the field equals bing */
40900
+ se_type?: string | undefined;
40901
+ /** returned keyword */
40902
+ keyword?: string | undefined;
40903
+ /** location code in a POST array */
40904
+ location_code?: number | undefined;
40905
+ /** language code in a POST array */
40906
+ language_code?: string | undefined;
40907
+ /** keyword data for the returned keyword */
40908
+ keyword_info?: KeywordInfo | undefined;
40909
+ /** additional information about the keyword */
40910
+ keyword_properties?: KeywordProperties | undefined;
40911
+ /** SERP data
40912
+ the value will be null if you didn’t set the field include_serp_info to true in the POST array or if there is no SERP data for this keyword in our database */
40913
+ serp_info?: SerpInfo | undefined;
40914
+ /** backlink data for the returned keyword
40915
+ this object provides the average number of backlinks, referring pages and domains, as well as the average rank values among the top-10 websites ranking organically for the keyword */
40916
+ avg_backlinks_info?: AvgBacklinksInfo | undefined;
40917
+ [key: string]: any;
40918
+ constructor(data?: IKeywordDataKeywordDataInfo);
40919
+ init(_data?: any): void;
40920
+ static fromJS(data: any): KeywordDataKeywordDataInfo;
40921
+ toJSON(data?: any): any;
40922
+ }
40923
+ export interface IKeywordDataKeywordDataInfo {
40924
+ /** search engine type
40925
+ search engine type specified in a POST request;
40926
+ for this endpoint, the field equals bing */
40927
+ se_type?: string | undefined;
40928
+ /** returned keyword */
40929
+ keyword?: string | undefined;
40930
+ /** location code in a POST array */
40931
+ location_code?: number | undefined;
40932
+ /** language code in a POST array */
40933
+ language_code?: string | undefined;
40934
+ /** keyword data for the returned keyword */
40935
+ keyword_info?: KeywordInfo | undefined;
40936
+ /** additional information about the keyword */
40937
+ keyword_properties?: KeywordProperties | undefined;
40938
+ /** SERP data
40939
+ the value will be null if you didn’t set the field include_serp_info to true in the POST array or if there is no SERP data for this keyword in our database */
40940
+ serp_info?: SerpInfo | undefined;
40941
+ /** backlink data for the returned keyword
40942
+ this object provides the average number of backlinks, referring pages and domains, as well as the average rank values among the top-10 websites ranking organically for the keyword */
40943
+ avg_backlinks_info?: AvgBacklinksInfo | undefined;
40944
+ [key: string]: any;
40945
+ }
40898
40946
  export declare class DataforseoLabsAmazonRelatedKeywordsLiveItem implements IDataforseoLabsAmazonRelatedKeywordsLiveItem {
40899
40947
  /** search engine type */
40900
40948
  se_type?: string | undefined;
@@ -41367,7 +41415,7 @@ export declare class DataforseoLabsAmazonRankedKeywordsLiveItem implements IData
41367
41415
  /** search engine type */
41368
41416
  se_type?: string | undefined;
41369
41417
  /** keyword data for the returned keyword */
41370
- keyword_data?: KeywordData | undefined;
41418
+ keyword_data?: KeywordDataKeywordDataInfo | undefined;
41371
41419
  /** contains data on the products’s SERP element found for the returned keyword */
41372
41420
  ranked_serp_element?: AmazonRankedSerpElement | undefined;
41373
41421
  [key: string]: any;
@@ -41380,7 +41428,7 @@ export interface IDataforseoLabsAmazonRankedKeywordsLiveItem {
41380
41428
  /** search engine type */
41381
41429
  se_type?: string | undefined;
41382
41430
  /** keyword data for the returned keyword */
41383
- keyword_data?: KeywordData | undefined;
41431
+ keyword_data?: KeywordDataKeywordDataInfo | undefined;
41384
41432
  /** contains data on the products’s SERP element found for the returned keyword */
41385
41433
  ranked_serp_element?: AmazonRankedSerpElement | undefined;
41386
41434
  [key: string]: any;
@@ -42569,7 +42617,7 @@ if there is no data, then the value is null */
42569
42617
  /** the number of results returned in the items array */
42570
42618
  items_count?: number | undefined;
42571
42619
  /** array of items with relevant traffic estimation data */
42572
- items?: (DataforseoLabsBulkTrafficEstimationLiveItem | undefined)[] | undefined;
42620
+ items?: (DataforseoLabsBBulkTrafficEstimationLiveItem | undefined)[] | undefined;
42573
42621
  [key: string]: any;
42574
42622
  constructor(data?: IDataforseoLabsBingBulkTrafficEstimationLiveResultInfo);
42575
42623
  init(_data?: any): void;
@@ -42590,7 +42638,7 @@ if there is no data, then the value is null */
42590
42638
  /** the number of results returned in the items array */
42591
42639
  items_count?: number | undefined;
42592
42640
  /** array of items with relevant traffic estimation data */
42593
- items?: (DataforseoLabsBulkTrafficEstimationLiveItem | undefined)[] | undefined;
42641
+ items?: (DataforseoLabsBBulkTrafficEstimationLiveItem | undefined)[] | undefined;
42594
42642
  [key: string]: any;
42595
42643
  }
42596
42644
  export declare class DataforseoLabsBingBulkTrafficEstimationLiveTaskInfo extends BaseResponseTaskInfo implements IDataforseoLabsBingBulkTrafficEstimationLiveTaskInfo {
@@ -43191,6 +43239,40 @@ you will find the specified tag value in the data object of the response */
43191
43239
  tag?: string | undefined;
43192
43240
  [key: string]: any;
43193
43241
  }
43242
+ export declare class DataforseoLabsBingDomainIntersectionLiveItem implements IDataforseoLabsBingDomainIntersectionLiveItem {
43243
+ /** search engine type
43244
+ search engine type specified in a POST request;
43245
+ for this endpoint, the field equals bing */
43246
+ se_type?: string | undefined;
43247
+ /** keyword data for the returned keyword */
43248
+ keyword_data?: KeywordDataKeywordDataInfo | undefined;
43249
+ /** contains data on the first domain’s SERP element found for the returned keyword
43250
+ the list of supported SERP elements can be found below */
43251
+ first_domain_serp_element?: BaseDataforseoLabsSerpElementItem | undefined;
43252
+ /** contains data on the second domain’s SERP element found for the returned keyword
43253
+ the list of supported SERP elements can be found below */
43254
+ second_domain_serp_element?: BaseDataforseoLabsSerpElementItem | undefined;
43255
+ [key: string]: any;
43256
+ constructor(data?: IDataforseoLabsBingDomainIntersectionLiveItem);
43257
+ init(_data?: any): void;
43258
+ static fromJS(data: any): DataforseoLabsBingDomainIntersectionLiveItem;
43259
+ toJSON(data?: any): any;
43260
+ }
43261
+ export interface IDataforseoLabsBingDomainIntersectionLiveItem {
43262
+ /** search engine type
43263
+ search engine type specified in a POST request;
43264
+ for this endpoint, the field equals bing */
43265
+ se_type?: string | undefined;
43266
+ /** keyword data for the returned keyword */
43267
+ keyword_data?: KeywordDataKeywordDataInfo | undefined;
43268
+ /** contains data on the first domain’s SERP element found for the returned keyword
43269
+ the list of supported SERP elements can be found below */
43270
+ first_domain_serp_element?: BaseDataforseoLabsSerpElementItem | undefined;
43271
+ /** contains data on the second domain’s SERP element found for the returned keyword
43272
+ the list of supported SERP elements can be found below */
43273
+ second_domain_serp_element?: BaseDataforseoLabsSerpElementItem | undefined;
43274
+ [key: string]: any;
43275
+ }
43194
43276
  export declare class DataforseoLabsBingDomainIntersectionLiveResultInfo implements IDataforseoLabsBingDomainIntersectionLiveResultInfo {
43195
43277
  /** search engine type
43196
43278
  search engine type specified in a POST request;
@@ -43209,7 +43291,7 @@ for this endpoint, the field equals bing */
43209
43291
  /** the number of results returned in the items array */
43210
43292
  items_count?: number | undefined;
43211
43293
  /** contains keywords, relevant SERP elements and related data */
43212
- items?: (DataforseoLabsDomainIntersectionLiveItem | undefined)[] | undefined;
43294
+ items?: (DataforseoLabsBingDomainIntersectionLiveItem | undefined)[] | undefined;
43213
43295
  [key: string]: any;
43214
43296
  constructor(data?: IDataforseoLabsBingDomainIntersectionLiveResultInfo);
43215
43297
  init(_data?: any): void;
@@ -43234,7 +43316,7 @@ for this endpoint, the field equals bing */
43234
43316
  /** the number of results returned in the items array */
43235
43317
  items_count?: number | undefined;
43236
43318
  /** contains keywords, relevant SERP elements and related data */
43237
- items?: (DataforseoLabsDomainIntersectionLiveItem | undefined)[] | undefined;
43319
+ items?: (DataforseoLabsBingDomainIntersectionLiveItem | undefined)[] | undefined;
43238
43320
  [key: string]: any;
43239
43321
  }
43240
43322
  export declare class DataforseoLabsBingDomainIntersectionLiveTaskInfo extends BaseResponseTaskInfo implements IDataforseoLabsBingDomainIntersectionLiveTaskInfo {
@@ -43773,6 +43855,40 @@ you will find the specified tag value in the data object of the response */
43773
43855
  tag?: string | undefined;
43774
43856
  [key: string]: any;
43775
43857
  }
43858
+ export declare class DataforseoLabsBingPageIntersectionLiveItem implements IDataforseoLabsBingPageIntersectionLiveItem {
43859
+ /** search engine type
43860
+ search engine type specified in a POST request;
43861
+ for this endpoint, the field equals bing */
43862
+ se_type?: string | undefined;
43863
+ /** keyword data for the returned keyword */
43864
+ keyword_data?: KeywordDataKeywordDataInfo | undefined;
43865
+ /** contains data on the SERP elements found for the returned keyword
43866
+ data will be provided in separate arrays for each URL you specified in the pages object when setting a task;
43867
+ depending on the number of specified URLs, it can contain from 1 to 20 arrays named respectively */
43868
+ intersection_result?: {
43869
+ [key: string]: BaseDataforseoLabsSerpElementItem;
43870
+ } | undefined;
43871
+ [key: string]: any;
43872
+ constructor(data?: IDataforseoLabsBingPageIntersectionLiveItem);
43873
+ init(_data?: any): void;
43874
+ static fromJS(data: any): DataforseoLabsBingPageIntersectionLiveItem;
43875
+ toJSON(data?: any): any;
43876
+ }
43877
+ export interface IDataforseoLabsBingPageIntersectionLiveItem {
43878
+ /** search engine type
43879
+ search engine type specified in a POST request;
43880
+ for this endpoint, the field equals bing */
43881
+ se_type?: string | undefined;
43882
+ /** keyword data for the returned keyword */
43883
+ keyword_data?: KeywordDataKeywordDataInfo | undefined;
43884
+ /** contains data on the SERP elements found for the returned keyword
43885
+ data will be provided in separate arrays for each URL you specified in the pages object when setting a task;
43886
+ depending on the number of specified URLs, it can contain from 1 to 20 arrays named respectively */
43887
+ intersection_result?: {
43888
+ [key: string]: BaseDataforseoLabsSerpElementItem;
43889
+ } | undefined;
43890
+ [key: string]: any;
43891
+ }
43776
43892
  export declare class DataforseoLabsBingPageIntersectionLiveResultInfo implements IDataforseoLabsBingPageIntersectionLiveResultInfo {
43777
43893
  /** search engine type
43778
43894
  search engine type specified in a POST request;
@@ -43793,7 +43909,7 @@ for this endpoint, the field equals bing */
43793
43909
  /** the number of results returned in the items array */
43794
43910
  items_count?: number | undefined;
43795
43911
  /** contains keywords, relevant SERP elements and related data */
43796
- items?: (DataforseoLabsPageIntersectionLiveItem | undefined)[] | undefined;
43912
+ items?: (DataforseoLabsBingPageIntersectionLiveItem | undefined)[] | undefined;
43797
43913
  [key: string]: any;
43798
43914
  constructor(data?: IDataforseoLabsBingPageIntersectionLiveResultInfo);
43799
43915
  init(_data?: any): void;
@@ -43820,7 +43936,7 @@ for this endpoint, the field equals bing */
43820
43936
  /** the number of results returned in the items array */
43821
43937
  items_count?: number | undefined;
43822
43938
  /** contains keywords, relevant SERP elements and related data */
43823
- items?: (DataforseoLabsPageIntersectionLiveItem | undefined)[] | undefined;
43939
+ items?: (DataforseoLabsBingPageIntersectionLiveItem | undefined)[] | undefined;
43824
43940
  [key: string]: any;
43825
43941
  }
43826
43942
  export declare class DataforseoLabsBingPageIntersectionLiveTaskInfo extends BaseResponseTaskInfo implements IDataforseoLabsBingPageIntersectionLiveTaskInfo {
@@ -44121,7 +44237,7 @@ export declare class DataforseoLabsBingRankedKeywordsLiveItem implements IDatafo
44121
44237
  /** search engine type */
44122
44238
  se_type?: string | undefined;
44123
44239
  /** keyword data for the returned keyword */
44124
- keyword_data?: KeywordDataInfo | undefined;
44240
+ keyword_data?: KeywordDataKeywordDataInfo | undefined;
44125
44241
  /** contains data on the domain’s SERP element found for the returned keyword */
44126
44242
  ranked_serp_element?: RankedSerpElement | undefined;
44127
44243
  [key: string]: any;
@@ -44134,7 +44250,7 @@ export interface IDataforseoLabsBingRankedKeywordsLiveItem {
44134
44250
  /** search engine type */
44135
44251
  se_type?: string | undefined;
44136
44252
  /** keyword data for the returned keyword */
44137
- keyword_data?: KeywordDataInfo | undefined;
44253
+ keyword_data?: KeywordDataKeywordDataInfo | undefined;
44138
44254
  /** contains data on the domain’s SERP element found for the returned keyword */
44139
44255
  ranked_serp_element?: RankedSerpElement | undefined;
44140
44256
  [key: string]: any;
@@ -44477,7 +44593,7 @@ export declare class DataforseoLabsBingRelatedKeywordsLiveItem implements IDataf
44477
44593
  /** search engine type */
44478
44594
  se_type?: string | undefined;
44479
44595
  /** keyword data for the returned keyword */
44480
- keyword_data?: KeywordData | undefined;
44596
+ keyword_data?: KeywordDataKeywordDataInfo | undefined;
44481
44597
  /** keyword search depth */
44482
44598
  depth?: number | undefined;
44483
44599
  /** list of related keywords
@@ -44493,7 +44609,7 @@ export interface IDataforseoLabsBingRelatedKeywordsLiveItem {
44493
44609
  /** search engine type */
44494
44610
  se_type?: string | undefined;
44495
44611
  /** keyword data for the returned keyword */
44496
- keyword_data?: KeywordData | undefined;
44612
+ keyword_data?: KeywordDataKeywordDataInfo | undefined;
44497
44613
  /** keyword search depth */
44498
44614
  depth?: number | undefined;
44499
44615
  /** list of related keywords
@@ -44508,7 +44624,7 @@ export declare class DataforseoLabsBingRelatedKeywordsLiveResultInfo implements
44508
44624
  seed_keyword?: string | undefined;
44509
44625
  /** keyword data for the seed keyword
44510
44626
  fields in the array are identical to that of keyword_data */
44511
- seed_keyword_data?: KeywordData | undefined;
44627
+ seed_keyword_data?: KeywordDataKeywordDataInfo | undefined;
44512
44628
  /** location code in a POST array */
44513
44629
  location_code?: number | undefined;
44514
44630
  /** language code in a POST array */
@@ -44532,7 +44648,7 @@ export interface IDataforseoLabsBingRelatedKeywordsLiveResultInfo {
44532
44648
  seed_keyword?: string | undefined;
44533
44649
  /** keyword data for the seed keyword
44534
44650
  fields in the array are identical to that of keyword_data */
44535
- seed_keyword_data?: KeywordData | undefined;
44651
+ seed_keyword_data?: KeywordDataKeywordDataInfo | undefined;
44536
44652
  /** location code in a POST array */
44537
44653
  location_code?: number | undefined;
44538
44654
  /** language code in a POST array */
@@ -45961,7 +46077,7 @@ export declare class DataforseoLabsleKeywordsForAppLiveItem implements IDatafors
45961
46077
  /** search engine type */
45962
46078
  se_type?: string | undefined;
45963
46079
  /** keyword data for the returned keyword */
45964
- keyword_data?: KeywordData | undefined;
46080
+ keyword_data?: KeywordDataKeywordDataInfo | undefined;
45965
46081
  /** contains data on the domain’s SERP element found for the returned keyword */
45966
46082
  ranked_serp_element?: AppRankedSerpElementInfo | undefined;
45967
46083
  [key: string]: any;
@@ -45974,7 +46090,7 @@ export interface IDataforseoLabsleKeywordsForAppLiveItem {
45974
46090
  /** search engine type */
45975
46091
  se_type?: string | undefined;
45976
46092
  /** keyword data for the returned keyword */
45977
- keyword_data?: KeywordData | undefined;
46093
+ keyword_data?: KeywordDataKeywordDataInfo | undefined;
45978
46094
  /** contains data on the domain’s SERP element found for the returned keyword */
45979
46095
  ranked_serp_element?: AppRankedSerpElementInfo | undefined;
45980
46096
  [key: string]: any;
@@ -46577,7 +46693,7 @@ export declare class DataforseoLabsleAppIntersectionLiveItem implements IDatafor
46577
46693
  /** search engine type */
46578
46694
  se_type?: string | undefined;
46579
46695
  /** keyword data for the returned keyword */
46580
- keyword_data?: KeywordData | undefined;
46696
+ keyword_data?: KeywordDataKeywordDataInfo | undefined;
46581
46697
  /** contains SERP data for the returned keyword
46582
46698
  data will be provided in separate arrays for each app ID you specified in the app_ids object when setting a task;
46583
46699
  depending on the number of specified app IDs, it can contain from 1 to 20 arrays named respectively */
@@ -46594,7 +46710,7 @@ export interface IDataforseoLabsleAppIntersectionLiveItem {
46594
46710
  /** search engine type */
46595
46711
  se_type?: string | undefined;
46596
46712
  /** keyword data for the returned keyword */
46597
- keyword_data?: KeywordData | undefined;
46713
+ keyword_data?: KeywordDataKeywordDataInfo | undefined;
46598
46714
  /** contains SERP data for the returned keyword
46599
46715
  data will be provided in separate arrays for each app ID you specified in the app_ids object when setting a task;
46600
46716
  depending on the number of specified app IDs, it can contain from 1 to 20 arrays named respectively */
@@ -57520,8 +57636,6 @@ indicates ISO country codes of the domains where the referring links are located
57520
57636
  } | undefined;
57521
57637
  /** number of referring pages pointing at least one nofollow link to the target */
57522
57638
  referring_pages_nofollow?: number | undefined;
57523
- /** number of nofollow backlinks pointing to the target */
57524
- backlinks_nofollow?: number | undefined;
57525
57639
  [key: string]: any;
57526
57640
  constructor(data?: IBacklinksSummaryLiveResultInfo);
57527
57641
  init(_data?: any): void;
@@ -57625,8 +57739,6 @@ indicates ISO country codes of the domains where the referring links are located
57625
57739
  } | undefined;
57626
57740
  /** number of referring pages pointing at least one nofollow link to the target */
57627
57741
  referring_pages_nofollow?: number | undefined;
57628
- /** number of nofollow backlinks pointing to the target */
57629
- backlinks_nofollow?: number | undefined;
57630
57742
  [key: string]: any;
57631
57743
  }
57632
57744
  export declare class BacklinksSummaryLiveTaskInfo extends BaseResponseTaskInfo implements IBacklinksSummaryLiveTaskInfo {
@@ -62393,6 +62505,11 @@ for example, if you specify:
62393
62505
  we will return items falling between 2022-03-01 and 2022-05-31, namely, three items corresponding to the following dates: 2022-03-31, 2022-04-30, 2022-05-31
62394
62506
  if there is no data for a certain day/week/month/year, we will return 0 */
62395
62507
  group_range?: string | undefined;
62508
+ /** indicates if the subdomains of the target will be included in the search
62509
+ optional field
62510
+ if set to false, the subdomains will be ignored
62511
+ default value: true */
62512
+ include_subdomains?: boolean | undefined;
62396
62513
  /** user-defined task identifier
62397
62514
  optional field
62398
62515
  the character limit is 255
@@ -62443,6 +62560,11 @@ for example, if you specify:
62443
62560
  we will return items falling between 2022-03-01 and 2022-05-31, namely, three items corresponding to the following dates: 2022-03-31, 2022-04-30, 2022-05-31
62444
62561
  if there is no data for a certain day/week/month/year, we will return 0 */
62445
62562
  group_range?: string | undefined;
62563
+ /** indicates if the subdomains of the target will be included in the search
62564
+ optional field
62565
+ if set to false, the subdomains will be ignored
62566
+ default value: true */
62567
+ include_subdomains?: boolean | undefined;
62446
62568
  /** user-defined task identifier
62447
62569
  optional field
62448
62570
  the character limit is 255
@@ -62639,6 +62761,11 @@ for example, if you specify:
62639
62761
  we will return items falling between 2022-03-01 and 2022-05-31, namely, three items corresponding to the following dates: 2022-03-31, 2022-04-30, 2022-05-31
62640
62762
  if there is no data for a certain day/week/month/year, we will return 0 */
62641
62763
  group_range?: string | undefined;
62764
+ /** indicates if the subdomains of the target will be included in the search
62765
+ optional field
62766
+ if set to false, the subdomains will be ignored
62767
+ default value: true */
62768
+ include_subdomains?: boolean | undefined;
62642
62769
  /** user-defined task identifier
62643
62770
  optional field
62644
62771
  the character limit is 255
@@ -62691,6 +62818,11 @@ for example, if you specify:
62691
62818
  we will return items falling between 2022-03-01 and 2022-05-31, namely, three items corresponding to the following dates: 2022-03-31, 2022-04-30, 2022-05-31
62692
62819
  if there is no data for a certain day/week/month/year, we will return 0 */
62693
62820
  group_range?: string | undefined;
62821
+ /** indicates if the subdomains of the target will be included in the search
62822
+ optional field
62823
+ if set to false, the subdomains will be ignored
62824
+ default value: true */
62825
+ include_subdomains?: boolean | undefined;
62694
62826
  /** user-defined task identifier
62695
62827
  optional field
62696
62828
  the character limit is 255
@@ -63679,6 +63811,446 @@ export interface IBacklinksBulkNewLostReferringDomainsLiveResponseInfo extends I
63679
63811
  tasks?: (BacklinksBulkNewLostReferringDomainsLiveTaskInfo | undefined)[] | undefined;
63680
63812
  [key: string]: any;
63681
63813
  }
63814
+ export declare class BacklinksBulkPagesSummaryLiveRequestInfo implements IBacklinksBulkPagesSummaryLiveRequestInfo {
63815
+ /** domains, subdomains or webpages to get summary data for
63816
+ required field
63817
+ a domain or a subdomain should be specified without https:// and www.
63818
+ a page should be specified with absolute URL (including http:// or https://)
63819
+ you can specify up to 1000 pages, domains, or subdomains in each request.
63820
+ note that the URLs you set in a single request cannot belong to more than 100 different domains. */
63821
+ targets?: string[];
63822
+ /** the maximum number of returned pages
63823
+ optional field
63824
+ default value: 100
63825
+ maximum value: 1000 */
63826
+ limit?: number | undefined;
63827
+ /** offset in the results array of returned pages
63828
+ optional field
63829
+ default value: 0
63830
+ if you specify the 10 value, the first ten pages in the results array will be omitted and the data will be provided for the successive pages */
63831
+ offset?: number | undefined;
63832
+ /** maximum number of elements within internal arrays
63833
+ optional field
63834
+ you can use this field to limit the number of elements within the following arrays:
63835
+ referring_links_tld
63836
+ referring_links_types
63837
+ referring_links_attributes
63838
+ referring_links_platform_types
63839
+ referring_links_semantic_locations
63840
+ default value: 10
63841
+ maximum value: 1000 */
63842
+ internal_list_limit?: number | undefined;
63843
+ /** set what backlinks to return and count
63844
+ optional field
63845
+ you can use this field to choose what backlinks will be returned and used for aggregated metrics for your target;
63846
+ possible values:
63847
+ all – all backlinks will be returned and counted;
63848
+ live – backlinks found during the last check will be returned and counted;
63849
+ lost – lost backlinks will be returned and counted;
63850
+ default value: live */
63851
+ backlinks_status_type?: string | undefined;
63852
+ /** array of results filtering parameters
63853
+ optional field
63854
+ you can add several filters at once (8 filters maximum)
63855
+ you should set a logical operator and, or between the conditions
63856
+ the following operators are supported:
63857
+ regex, =, <>, in, not_in, like, not_like, ilike, not_ilike
63858
+ you can use the % operator with like and not_like to match any string of zero or more characters
63859
+ example:
63860
+ ["referring_links_types.anchors",">","1"]
63861
+ [["broken_pages",">","2"],
63862
+ "and",
63863
+ ["backlinks",">","10"]]
63864
+ [["first_seen",">","2017-10-23 11:31:45 +00:00"],
63865
+ "and",
63866
+ [["anchor","like","%seo%"],"or",["referring_domains",">","10"]]]
63867
+ The full list of possible filters is available here. */
63868
+ filters?: (any | undefined)[] | undefined;
63869
+ /** results sorting rules
63870
+ optional field
63871
+ you can use the same values as in the filters array to sort the results
63872
+ possible sorting types:
63873
+ asc – results will be sorted in the ascending order
63874
+ desc – results will be sorted in the descending order
63875
+ you should use a comma to set up a sorting type
63876
+ example:
63877
+ ["backlinks,desc"]
63878
+ note that you can set no more than three sorting rules in a single request
63879
+ you should use a comma to separate several sorting rules
63880
+ example:
63881
+ ["backlinks,desc","rank,asc"] */
63882
+ order_by?: string[] | undefined;
63883
+ /** filter the backlinks of your target
63884
+ optional field
63885
+ you can use this field to filter the initial backlinks that will be included in the dataset for aggregated metrics for your target
63886
+ you can filter the backlinks by all fields available in the response of this endpoint
63887
+ using this parameter, you can include only dofollow backlinks in the response and create a flexible backlinks dataset to calculate the metrics for
63888
+ example:
63889
+ "backlinks_filters": [["dofollow", "=", true]] */
63890
+ backlinks_filters?: (any | undefined)[] | undefined;
63891
+ /** indicates if the subdomains of the target will be included in the search
63892
+ optional field
63893
+ if set to false, the subdomains will be ignored
63894
+ default value: true */
63895
+ include_subdomains?: boolean | undefined;
63896
+ /** indicates if indirect links to the target will be included in the results
63897
+ optional field
63898
+ if set to true, the results will include data on indirect links pointing to a page that either redirects to the target, or points to a canonical page
63899
+ if set to false, indirect links will be ignored
63900
+ default value: true */
63901
+ include_indirect_links?: boolean | undefined;
63902
+ /** indicates whether the backlinks from subdomains of the target are excluded
63903
+ optional field
63904
+ if set to false, the backlinks from subdomains of the target will be ommited and you won’t receive the same domain in the response;
63905
+ default value: true */
63906
+ exclude_internal_backlinks?: boolean | undefined;
63907
+ /** user-defined task identifier
63908
+ optional field
63909
+ the character limit is 255
63910
+ you can use this parameter to identify the task and match it with the result
63911
+ you will find the specified tag value in the data object of the response */
63912
+ tag?: string | undefined;
63913
+ [key: string]: any;
63914
+ constructor(data?: IBacklinksBulkPagesSummaryLiveRequestInfo);
63915
+ init(_data?: any): void;
63916
+ static fromJS(data: any): BacklinksBulkPagesSummaryLiveRequestInfo;
63917
+ toJSON(data?: any): any;
63918
+ }
63919
+ export interface IBacklinksBulkPagesSummaryLiveRequestInfo {
63920
+ /** domains, subdomains or webpages to get summary data for
63921
+ required field
63922
+ a domain or a subdomain should be specified without https:// and www.
63923
+ a page should be specified with absolute URL (including http:// or https://)
63924
+ you can specify up to 1000 pages, domains, or subdomains in each request.
63925
+ note that the URLs you set in a single request cannot belong to more than 100 different domains. */
63926
+ targets?: string[];
63927
+ /** the maximum number of returned pages
63928
+ optional field
63929
+ default value: 100
63930
+ maximum value: 1000 */
63931
+ limit?: number | undefined;
63932
+ /** offset in the results array of returned pages
63933
+ optional field
63934
+ default value: 0
63935
+ if you specify the 10 value, the first ten pages in the results array will be omitted and the data will be provided for the successive pages */
63936
+ offset?: number | undefined;
63937
+ /** maximum number of elements within internal arrays
63938
+ optional field
63939
+ you can use this field to limit the number of elements within the following arrays:
63940
+ referring_links_tld
63941
+ referring_links_types
63942
+ referring_links_attributes
63943
+ referring_links_platform_types
63944
+ referring_links_semantic_locations
63945
+ default value: 10
63946
+ maximum value: 1000 */
63947
+ internal_list_limit?: number | undefined;
63948
+ /** set what backlinks to return and count
63949
+ optional field
63950
+ you can use this field to choose what backlinks will be returned and used for aggregated metrics for your target;
63951
+ possible values:
63952
+ all – all backlinks will be returned and counted;
63953
+ live – backlinks found during the last check will be returned and counted;
63954
+ lost – lost backlinks will be returned and counted;
63955
+ default value: live */
63956
+ backlinks_status_type?: string | undefined;
63957
+ /** array of results filtering parameters
63958
+ optional field
63959
+ you can add several filters at once (8 filters maximum)
63960
+ you should set a logical operator and, or between the conditions
63961
+ the following operators are supported:
63962
+ regex, =, <>, in, not_in, like, not_like, ilike, not_ilike
63963
+ you can use the % operator with like and not_like to match any string of zero or more characters
63964
+ example:
63965
+ ["referring_links_types.anchors",">","1"]
63966
+ [["broken_pages",">","2"],
63967
+ "and",
63968
+ ["backlinks",">","10"]]
63969
+ [["first_seen",">","2017-10-23 11:31:45 +00:00"],
63970
+ "and",
63971
+ [["anchor","like","%seo%"],"or",["referring_domains",">","10"]]]
63972
+ The full list of possible filters is available here. */
63973
+ filters?: (any | undefined)[] | undefined;
63974
+ /** results sorting rules
63975
+ optional field
63976
+ you can use the same values as in the filters array to sort the results
63977
+ possible sorting types:
63978
+ asc – results will be sorted in the ascending order
63979
+ desc – results will be sorted in the descending order
63980
+ you should use a comma to set up a sorting type
63981
+ example:
63982
+ ["backlinks,desc"]
63983
+ note that you can set no more than three sorting rules in a single request
63984
+ you should use a comma to separate several sorting rules
63985
+ example:
63986
+ ["backlinks,desc","rank,asc"] */
63987
+ order_by?: string[] | undefined;
63988
+ /** filter the backlinks of your target
63989
+ optional field
63990
+ you can use this field to filter the initial backlinks that will be included in the dataset for aggregated metrics for your target
63991
+ you can filter the backlinks by all fields available in the response of this endpoint
63992
+ using this parameter, you can include only dofollow backlinks in the response and create a flexible backlinks dataset to calculate the metrics for
63993
+ example:
63994
+ "backlinks_filters": [["dofollow", "=", true]] */
63995
+ backlinks_filters?: (any | undefined)[] | undefined;
63996
+ /** indicates if the subdomains of the target will be included in the search
63997
+ optional field
63998
+ if set to false, the subdomains will be ignored
63999
+ default value: true */
64000
+ include_subdomains?: boolean | undefined;
64001
+ /** indicates if indirect links to the target will be included in the results
64002
+ optional field
64003
+ if set to true, the results will include data on indirect links pointing to a page that either redirects to the target, or points to a canonical page
64004
+ if set to false, indirect links will be ignored
64005
+ default value: true */
64006
+ include_indirect_links?: boolean | undefined;
64007
+ /** indicates whether the backlinks from subdomains of the target are excluded
64008
+ optional field
64009
+ if set to false, the backlinks from subdomains of the target will be ommited and you won’t receive the same domain in the response;
64010
+ default value: true */
64011
+ exclude_internal_backlinks?: boolean | undefined;
64012
+ /** user-defined task identifier
64013
+ optional field
64014
+ the character limit is 255
64015
+ you can use this parameter to identify the task and match it with the result
64016
+ you will find the specified tag value in the data object of the response */
64017
+ tag?: string | undefined;
64018
+ [key: string]: any;
64019
+ }
64020
+ export declare class BacklinksBulkPagesSummaryLiveItem implements IBacklinksBulkPagesSummaryLiveItem {
64021
+ /** type of element */
64022
+ type?: string | undefined;
64023
+ /** page URL */
64024
+ url?: string | undefined;
64025
+ /** page rank
64026
+ rank of the page on the target website
64027
+ rank is calculated based on the method for node ranking in a linked database – a principle used in the original Google PageRank algorithm
64028
+ learn more about the metric and how it is calculated in this help center article */
64029
+ rank?: number | undefined;
64030
+ /** rank of the main domain
64031
+ rank of the main domain is calculated based on the method for node ranking in a linked database – a principle used in the original Google PageRank algorithm
64032
+ learn more about the metric and how it is calculated in this help center article */
64033
+ main_domain_rank?: number | undefined;
64034
+ /** number of backlinks */
64035
+ backlinks?: number | undefined;
64036
+ /** date and time when our crawler found a backlink to this page for the first time
64037
+ in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”
64038
+ example:
64039
+ 2019-11-15 12:57:46 +00:00 */
64040
+ first_seen?: string | undefined;
64041
+ /** date and time when the last backlink to this page was lost
64042
+ indicates the date and time when our crawler visited the page and it responded with 4xx or 5xx status code or the last backlink was removed
64043
+ in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”
64044
+ example:
64045
+ 2017-01-24 13:20:59 +00:00 */
64046
+ lost_date?: string | undefined;
64047
+ /** average spam score of the backlinks pointing to the page
64048
+ learn more about how the metric is calculated on this help center page */
64049
+ backlinks_spam_score?: number | undefined;
64050
+ /** number of broken backlinks
64051
+ number of broken backlinks pointing to the page */
64052
+ broken_backlinks?: number | undefined;
64053
+ /** number of broken pages
64054
+ number of pages that respond with 4xx or 5xx status codes where backlinks are pointing to */
64055
+ broken_pages?: number | undefined;
64056
+ /** indicates the number domains referring to the page */
64057
+ referring_domains?: number | undefined;
64058
+ /** number of domains pointing at least one nofollow link to the target */
64059
+ referring_domains_nofollow?: number | undefined;
64060
+ /** indicates the number of referring main domains */
64061
+ referring_main_domains?: number | undefined;
64062
+ /** number of main domains pointing at least one nofollow link to the target */
64063
+ referring_main_domains_nofollow?: number | undefined;
64064
+ /** number of referring IP addresses
64065
+ number of IP addresses pointing to this page */
64066
+ referring_ips?: number | undefined;
64067
+ /** number of referring subnetworks */
64068
+ referring_subnets?: number | undefined;
64069
+ /** indicates the number of pages pointing to the relevant url */
64070
+ referring_pages?: number | undefined;
64071
+ /** number of referring pages pointing at least one nofollow link to the target */
64072
+ referring_pages_nofollow?: number | undefined;
64073
+ /** top-level domains of the referring links
64074
+ contains top level domains and referring link count per each */
64075
+ referring_links_tld?: {
64076
+ [key: string]: number;
64077
+ } | undefined;
64078
+ /** types of referring links
64079
+ indicates the types of the referring links and link count per each type
64080
+ possible values:
64081
+ anchor, image, link, meta, canonical, alternate, redirect */
64082
+ referring_links_types?: {
64083
+ [key: string]: number;
64084
+ } | undefined;
64085
+ /** link attributes of the referring links
64086
+ indicates link attributes of the referring links and link count per each attribute */
64087
+ referring_links_attributes?: {
64088
+ [key: string]: number;
64089
+ } | undefined;
64090
+ /** types of referring platforms
64091
+ indicates referring platform types and and link count per each platform */
64092
+ referring_links_platform_types?: {
64093
+ [key: string]: number;
64094
+ } | undefined;
64095
+ /** semantic locations of the referring links
64096
+ indicates semantic elements in HTML where the referring links are located and link count per each semantic location
64097
+ you can get the full list of semantic elements here
64098
+ examples:
64099
+ article, section, footer */
64100
+ referring_links_semantic_locations?: {
64101
+ [key: string]: number;
64102
+ } | undefined;
64103
+ /** ISO country codes of the referring links
64104
+ indicates ISO country codes of the domains where the referring links are located and the link count per each country */
64105
+ referring_links_countries?: {
64106
+ [key: string]: number;
64107
+ } | undefined;
64108
+ [key: string]: any;
64109
+ constructor(data?: IBacklinksBulkPagesSummaryLiveItem);
64110
+ init(_data?: any): void;
64111
+ static fromJS(data: any): BacklinksBulkPagesSummaryLiveItem;
64112
+ toJSON(data?: any): any;
64113
+ }
64114
+ export interface IBacklinksBulkPagesSummaryLiveItem {
64115
+ /** type of element */
64116
+ type?: string | undefined;
64117
+ /** page URL */
64118
+ url?: string | undefined;
64119
+ /** page rank
64120
+ rank of the page on the target website
64121
+ rank is calculated based on the method for node ranking in a linked database – a principle used in the original Google PageRank algorithm
64122
+ learn more about the metric and how it is calculated in this help center article */
64123
+ rank?: number | undefined;
64124
+ /** rank of the main domain
64125
+ rank of the main domain is calculated based on the method for node ranking in a linked database – a principle used in the original Google PageRank algorithm
64126
+ learn more about the metric and how it is calculated in this help center article */
64127
+ main_domain_rank?: number | undefined;
64128
+ /** number of backlinks */
64129
+ backlinks?: number | undefined;
64130
+ /** date and time when our crawler found a backlink to this page for the first time
64131
+ in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”
64132
+ example:
64133
+ 2019-11-15 12:57:46 +00:00 */
64134
+ first_seen?: string | undefined;
64135
+ /** date and time when the last backlink to this page was lost
64136
+ indicates the date and time when our crawler visited the page and it responded with 4xx or 5xx status code or the last backlink was removed
64137
+ in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”
64138
+ example:
64139
+ 2017-01-24 13:20:59 +00:00 */
64140
+ lost_date?: string | undefined;
64141
+ /** average spam score of the backlinks pointing to the page
64142
+ learn more about how the metric is calculated on this help center page */
64143
+ backlinks_spam_score?: number | undefined;
64144
+ /** number of broken backlinks
64145
+ number of broken backlinks pointing to the page */
64146
+ broken_backlinks?: number | undefined;
64147
+ /** number of broken pages
64148
+ number of pages that respond with 4xx or 5xx status codes where backlinks are pointing to */
64149
+ broken_pages?: number | undefined;
64150
+ /** indicates the number domains referring to the page */
64151
+ referring_domains?: number | undefined;
64152
+ /** number of domains pointing at least one nofollow link to the target */
64153
+ referring_domains_nofollow?: number | undefined;
64154
+ /** indicates the number of referring main domains */
64155
+ referring_main_domains?: number | undefined;
64156
+ /** number of main domains pointing at least one nofollow link to the target */
64157
+ referring_main_domains_nofollow?: number | undefined;
64158
+ /** number of referring IP addresses
64159
+ number of IP addresses pointing to this page */
64160
+ referring_ips?: number | undefined;
64161
+ /** number of referring subnetworks */
64162
+ referring_subnets?: number | undefined;
64163
+ /** indicates the number of pages pointing to the relevant url */
64164
+ referring_pages?: number | undefined;
64165
+ /** number of referring pages pointing at least one nofollow link to the target */
64166
+ referring_pages_nofollow?: number | undefined;
64167
+ /** top-level domains of the referring links
64168
+ contains top level domains and referring link count per each */
64169
+ referring_links_tld?: {
64170
+ [key: string]: number;
64171
+ } | undefined;
64172
+ /** types of referring links
64173
+ indicates the types of the referring links and link count per each type
64174
+ possible values:
64175
+ anchor, image, link, meta, canonical, alternate, redirect */
64176
+ referring_links_types?: {
64177
+ [key: string]: number;
64178
+ } | undefined;
64179
+ /** link attributes of the referring links
64180
+ indicates link attributes of the referring links and link count per each attribute */
64181
+ referring_links_attributes?: {
64182
+ [key: string]: number;
64183
+ } | undefined;
64184
+ /** types of referring platforms
64185
+ indicates referring platform types and and link count per each platform */
64186
+ referring_links_platform_types?: {
64187
+ [key: string]: number;
64188
+ } | undefined;
64189
+ /** semantic locations of the referring links
64190
+ indicates semantic elements in HTML where the referring links are located and link count per each semantic location
64191
+ you can get the full list of semantic elements here
64192
+ examples:
64193
+ article, section, footer */
64194
+ referring_links_semantic_locations?: {
64195
+ [key: string]: number;
64196
+ } | undefined;
64197
+ /** ISO country codes of the referring links
64198
+ indicates ISO country codes of the domains where the referring links are located and the link count per each country */
64199
+ referring_links_countries?: {
64200
+ [key: string]: number;
64201
+ } | undefined;
64202
+ [key: string]: any;
64203
+ }
64204
+ export declare class BacklinksBulkPagesSummaryLiveResultInfo implements IBacklinksBulkPagesSummaryLiveResultInfo {
64205
+ /** total number of relevant items in the database */
64206
+ total_count?: number | undefined;
64207
+ /** number of items in the results array */
64208
+ items_count?: number | undefined;
64209
+ /** items array */
64210
+ items?: (BacklinksBulkPagesSummaryLiveItem | undefined)[] | undefined;
64211
+ [key: string]: any;
64212
+ constructor(data?: IBacklinksBulkPagesSummaryLiveResultInfo);
64213
+ init(_data?: any): void;
64214
+ static fromJS(data: any): BacklinksBulkPagesSummaryLiveResultInfo;
64215
+ toJSON(data?: any): any;
64216
+ }
64217
+ export interface IBacklinksBulkPagesSummaryLiveResultInfo {
64218
+ /** total number of relevant items in the database */
64219
+ total_count?: number | undefined;
64220
+ /** number of items in the results array */
64221
+ items_count?: number | undefined;
64222
+ /** items array */
64223
+ items?: (BacklinksBulkPagesSummaryLiveItem | undefined)[] | undefined;
64224
+ [key: string]: any;
64225
+ }
64226
+ export declare class BacklinksBulkPagesSummaryLiveTaskInfo extends BaseResponseTaskInfo implements IBacklinksBulkPagesSummaryLiveTaskInfo {
64227
+ /** array of results */
64228
+ result?: (BacklinksBulkPagesSummaryLiveResultInfo | undefined)[] | undefined;
64229
+ [key: string]: any;
64230
+ constructor(data?: IBacklinksBulkPagesSummaryLiveTaskInfo);
64231
+ init(_data?: any): void;
64232
+ static fromJS(data: any): BacklinksBulkPagesSummaryLiveTaskInfo;
64233
+ toJSON(data?: any): any;
64234
+ }
64235
+ export interface IBacklinksBulkPagesSummaryLiveTaskInfo extends IBaseResponseTaskInfo {
64236
+ /** array of results */
64237
+ result?: (BacklinksBulkPagesSummaryLiveResultInfo | undefined)[] | undefined;
64238
+ [key: string]: any;
64239
+ }
64240
+ export declare class BacklinksBulkPagesSummaryLiveResponseInfo extends BaseResponseInfo implements IBacklinksBulkPagesSummaryLiveResponseInfo {
64241
+ /** array of tasks */
64242
+ tasks?: (BacklinksBulkPagesSummaryLiveTaskInfo | undefined)[] | undefined;
64243
+ [key: string]: any;
64244
+ constructor(data?: IBacklinksBulkPagesSummaryLiveResponseInfo);
64245
+ init(_data?: any): void;
64246
+ static fromJS(data: any): BacklinksBulkPagesSummaryLiveResponseInfo;
64247
+ toJSON(data?: any): any;
64248
+ }
64249
+ export interface IBacklinksBulkPagesSummaryLiveResponseInfo extends IBaseResponseInfo {
64250
+ /** array of tasks */
64251
+ tasks?: (BacklinksBulkPagesSummaryLiveTaskInfo | undefined)[] | undefined;
64252
+ [key: string]: any;
64253
+ }
63682
64254
  export declare class OnPageIdListRequestInfo implements IOnPageIdListRequestInfo {
63683
64255
  /** start time for filtering results
63684
64256
  required field
@@ -66015,118 +66587,6 @@ the amount of time a browser needs to complete downloading a resource */
66015
66587
  fetch_end?: number | undefined;
66016
66588
  [key: string]: any;
66017
66589
  }
66018
- export declare class ScriptResourceElementItem extends BaseOnPageResourceItemInfo implements IScriptResourceElementItem {
66019
- /** resource properties
66020
- the value depends on the resource_type
66021
- note that if you do not indicate a url when setting a task, resource’s meta is returned based on the data from the page where our crawler first saw the resource;
66022
- to obtain resource’s meta from a particular url, specify that URL when setting a task */
66023
- meta?: ResourceMetaInfo | undefined;
66024
- /** status code of the page where a given resource is located */
66025
- status_code?: number | undefined;
66026
- /** location header
66027
- indicates the URL to redirect a page to */
66028
- location?: string | undefined;
66029
- /** resource URL */
66030
- url?: string | undefined;
66031
- /** resource size
66032
- indicates the size of a given resource measured in bytes */
66033
- size?: number | undefined;
66034
- /** resource size after encoding
66035
- indicates the size of the encoded resource measured in bytes */
66036
- encoded_size?: number | undefined;
66037
- /** compressed resource size
66038
- indicates the compressed size of a given resource in bytes */
66039
- total_transfer_size?: number | undefined;
66040
- /** date and time when a resource was fetched
66041
- in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”
66042
- example:
66043
- 2021-02-17 13:54:15 +00:00 */
66044
- fetch_time?: string | undefined;
66045
- /** resource fething time range */
66046
- fetch_timing?: FetchTiming | undefined;
66047
- /** instructions for caching */
66048
- cache_control?: CacheControl | undefined;
66049
- /** resource check-ups
66050
- contents of the array depend on the resource_type */
66051
- checks?: {
66052
- [key: string]: boolean;
66053
- } | undefined;
66054
- /** resource errors and warnings */
66055
- resource_errors?: OnPageResourceIssueInfo | undefined;
66056
- /** type of encoding */
66057
- content_encoding?: string | undefined;
66058
- /** types of media used to display a resource */
66059
- media_type?: string | undefined;
66060
- /** indicates the expected type of resource
66061
- for example, if "resource_type": "broken", accept_type will indicate the type of the broken resource
66062
- possible values:
66063
- any, none, image, sitemap, robots, script, stylesheet, redirect, html, text, other, font */
66064
- accept_type?: string | undefined;
66065
- /** server version */
66066
- server?: string | undefined;
66067
- /** contains data on changes related to the resource
66068
- if there is no data, the value will be null */
66069
- last_modified?: LastModified | undefined;
66070
- [key: string]: any;
66071
- constructor(data?: IScriptResourceElementItem);
66072
- init(_data?: any): void;
66073
- static fromJS(data: any): ScriptResourceElementItem;
66074
- toJSON(data?: any): any;
66075
- }
66076
- export interface IScriptResourceElementItem extends IBaseOnPageResourceItemInfo {
66077
- /** resource properties
66078
- the value depends on the resource_type
66079
- note that if you do not indicate a url when setting a task, resource’s meta is returned based on the data from the page where our crawler first saw the resource;
66080
- to obtain resource’s meta from a particular url, specify that URL when setting a task */
66081
- meta?: ResourceMetaInfo | undefined;
66082
- /** status code of the page where a given resource is located */
66083
- status_code?: number | undefined;
66084
- /** location header
66085
- indicates the URL to redirect a page to */
66086
- location?: string | undefined;
66087
- /** resource URL */
66088
- url?: string | undefined;
66089
- /** resource size
66090
- indicates the size of a given resource measured in bytes */
66091
- size?: number | undefined;
66092
- /** resource size after encoding
66093
- indicates the size of the encoded resource measured in bytes */
66094
- encoded_size?: number | undefined;
66095
- /** compressed resource size
66096
- indicates the compressed size of a given resource in bytes */
66097
- total_transfer_size?: number | undefined;
66098
- /** date and time when a resource was fetched
66099
- in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”
66100
- example:
66101
- 2021-02-17 13:54:15 +00:00 */
66102
- fetch_time?: string | undefined;
66103
- /** resource fething time range */
66104
- fetch_timing?: FetchTiming | undefined;
66105
- /** instructions for caching */
66106
- cache_control?: CacheControl | undefined;
66107
- /** resource check-ups
66108
- contents of the array depend on the resource_type */
66109
- checks?: {
66110
- [key: string]: boolean;
66111
- } | undefined;
66112
- /** resource errors and warnings */
66113
- resource_errors?: OnPageResourceIssueInfo | undefined;
66114
- /** type of encoding */
66115
- content_encoding?: string | undefined;
66116
- /** types of media used to display a resource */
66117
- media_type?: string | undefined;
66118
- /** indicates the expected type of resource
66119
- for example, if "resource_type": "broken", accept_type will indicate the type of the broken resource
66120
- possible values:
66121
- any, none, image, sitemap, robots, script, stylesheet, redirect, html, text, other, font */
66122
- accept_type?: string | undefined;
66123
- /** server version */
66124
- server?: string | undefined;
66125
- /** contains data on changes related to the resource
66126
- if there is no data, the value will be null */
66127
- last_modified?: LastModified | undefined;
66128
- [key: string]: any;
66129
- }
66130
66590
  export declare class StylesheetResourceElementItem extends BaseOnPageResourceItemInfo implements IStylesheetResourceElementItem {
66131
66591
  /** resource properties
66132
66592
  the value depends on the resource_type
@@ -66309,6 +66769,118 @@ export interface IOnPageResourcesTaskInfo extends IBaseResponseTaskInfo {
66309
66769
  result?: (OnPageResourcesResultInfo | undefined)[] | undefined;
66310
66770
  [key: string]: any;
66311
66771
  }
66772
+ export declare class ScriptResourceElementItem extends BaseOnPageResourceItemInfo implements IScriptResourceElementItem {
66773
+ /** resource properties
66774
+ the value depends on the resource_type
66775
+ note that if you do not indicate a url when setting a task, resource’s meta is returned based on the data from the page where our crawler first saw the resource;
66776
+ to obtain resource’s meta from a particular url, specify that URL when setting a task */
66777
+ meta?: ResourceMetaInfo | undefined;
66778
+ /** status code of the page where a given resource is located */
66779
+ status_code?: number | undefined;
66780
+ /** location header
66781
+ indicates the URL to redirect a page to */
66782
+ location?: string | undefined;
66783
+ /** resource URL */
66784
+ url?: string | undefined;
66785
+ /** resource size
66786
+ indicates the size of a given resource measured in bytes */
66787
+ size?: number | undefined;
66788
+ /** resource size after encoding
66789
+ indicates the size of the encoded resource measured in bytes */
66790
+ encoded_size?: number | undefined;
66791
+ /** compressed resource size
66792
+ indicates the compressed size of a given resource in bytes */
66793
+ total_transfer_size?: number | undefined;
66794
+ /** date and time when a resource was fetched
66795
+ in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”
66796
+ example:
66797
+ 2021-02-17 13:54:15 +00:00 */
66798
+ fetch_time?: string | undefined;
66799
+ /** resource fething time range */
66800
+ fetch_timing?: FetchTiming | undefined;
66801
+ /** instructions for caching */
66802
+ cache_control?: CacheControl | undefined;
66803
+ /** resource check-ups
66804
+ contents of the array depend on the resource_type */
66805
+ checks?: {
66806
+ [key: string]: boolean;
66807
+ } | undefined;
66808
+ /** type of encoding */
66809
+ content_encoding?: string | undefined;
66810
+ /** types of media used to display a resource */
66811
+ media_type?: string | undefined;
66812
+ /** indicates the expected type of resource
66813
+ for example, if "resource_type": "broken", accept_type will indicate the type of the broken resource
66814
+ possible values:
66815
+ any, none, image, sitemap, robots, script, stylesheet, redirect, html, text, other, font */
66816
+ accept_type?: string | undefined;
66817
+ /** server version */
66818
+ server?: string | undefined;
66819
+ /** contains data on changes related to the resource
66820
+ if there is no data, the value will be null */
66821
+ last_modified?: LastModified | undefined;
66822
+ /** resource errors and warnings */
66823
+ resource_errors?: OnPageResourceIssueInfo | undefined;
66824
+ [key: string]: any;
66825
+ constructor(data?: IScriptResourceElementItem);
66826
+ init(_data?: any): void;
66827
+ static fromJS(data: any): ScriptResourceElementItem;
66828
+ toJSON(data?: any): any;
66829
+ }
66830
+ export interface IScriptResourceElementItem extends IBaseOnPageResourceItemInfo {
66831
+ /** resource properties
66832
+ the value depends on the resource_type
66833
+ note that if you do not indicate a url when setting a task, resource’s meta is returned based on the data from the page where our crawler first saw the resource;
66834
+ to obtain resource’s meta from a particular url, specify that URL when setting a task */
66835
+ meta?: ResourceMetaInfo | undefined;
66836
+ /** status code of the page where a given resource is located */
66837
+ status_code?: number | undefined;
66838
+ /** location header
66839
+ indicates the URL to redirect a page to */
66840
+ location?: string | undefined;
66841
+ /** resource URL */
66842
+ url?: string | undefined;
66843
+ /** resource size
66844
+ indicates the size of a given resource measured in bytes */
66845
+ size?: number | undefined;
66846
+ /** resource size after encoding
66847
+ indicates the size of the encoded resource measured in bytes */
66848
+ encoded_size?: number | undefined;
66849
+ /** compressed resource size
66850
+ indicates the compressed size of a given resource in bytes */
66851
+ total_transfer_size?: number | undefined;
66852
+ /** date and time when a resource was fetched
66853
+ in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”
66854
+ example:
66855
+ 2021-02-17 13:54:15 +00:00 */
66856
+ fetch_time?: string | undefined;
66857
+ /** resource fething time range */
66858
+ fetch_timing?: FetchTiming | undefined;
66859
+ /** instructions for caching */
66860
+ cache_control?: CacheControl | undefined;
66861
+ /** resource check-ups
66862
+ contents of the array depend on the resource_type */
66863
+ checks?: {
66864
+ [key: string]: boolean;
66865
+ } | undefined;
66866
+ /** type of encoding */
66867
+ content_encoding?: string | undefined;
66868
+ /** types of media used to display a resource */
66869
+ media_type?: string | undefined;
66870
+ /** indicates the expected type of resource
66871
+ for example, if "resource_type": "broken", accept_type will indicate the type of the broken resource
66872
+ possible values:
66873
+ any, none, image, sitemap, robots, script, stylesheet, redirect, html, text, other, font */
66874
+ accept_type?: string | undefined;
66875
+ /** server version */
66876
+ server?: string | undefined;
66877
+ /** contains data on changes related to the resource
66878
+ if there is no data, the value will be null */
66879
+ last_modified?: LastModified | undefined;
66880
+ /** resource errors and warnings */
66881
+ resource_errors?: OnPageResourceIssueInfo | undefined;
66882
+ [key: string]: any;
66883
+ }
66312
66884
  export declare class ImageResourceElementItem extends BaseOnPageResourceItemInfo implements IImageResourceElementItem {
66313
66885
  /** resource properties
66314
66886
  the value depends on the resource_type
@@ -67075,52 +67647,6 @@ status code of the page to which the link is pointing */
67075
67647
  page_to_status_code?: number | undefined;
67076
67648
  [key: string]: any;
67077
67649
  }
67078
- export declare class OnPageLinksResultInfo implements IOnPageLinksResultInfo {
67079
- /** status of the crawling session
67080
- possible values: in_progress, finished */
67081
- crawl_progress?: string | undefined;
67082
- /** details of the crawling session */
67083
- crawl_status?: CrawlStatusInfo | undefined;
67084
- /** total number of relevant items in the database */
67085
- total_items_count?: number | undefined;
67086
- /** number of items in the results array */
67087
- items_count?: number | undefined;
67088
- /** items array */
67089
- items?: (BaseOnPageLinkItemInfo | undefined)[] | undefined;
67090
- [key: string]: any;
67091
- constructor(data?: IOnPageLinksResultInfo);
67092
- init(_data?: any): void;
67093
- static fromJS(data: any): OnPageLinksResultInfo;
67094
- toJSON(data?: any): any;
67095
- }
67096
- export interface IOnPageLinksResultInfo {
67097
- /** status of the crawling session
67098
- possible values: in_progress, finished */
67099
- crawl_progress?: string | undefined;
67100
- /** details of the crawling session */
67101
- crawl_status?: CrawlStatusInfo | undefined;
67102
- /** total number of relevant items in the database */
67103
- total_items_count?: number | undefined;
67104
- /** number of items in the results array */
67105
- items_count?: number | undefined;
67106
- /** items array */
67107
- items?: (BaseOnPageLinkItemInfo | undefined)[] | undefined;
67108
- [key: string]: any;
67109
- }
67110
- export declare class OnPageLinksTaskInfo extends BaseResponseTaskInfo implements IOnPageLinksTaskInfo {
67111
- /** array of results */
67112
- result?: (OnPageLinksResultInfo | undefined)[] | undefined;
67113
- [key: string]: any;
67114
- constructor(data?: IOnPageLinksTaskInfo);
67115
- init(_data?: any): void;
67116
- static fromJS(data: any): OnPageLinksTaskInfo;
67117
- toJSON(data?: any): any;
67118
- }
67119
- export interface IOnPageLinksTaskInfo extends IBaseResponseTaskInfo {
67120
- /** array of results */
67121
- result?: (OnPageLinksResultInfo | undefined)[] | undefined;
67122
- [key: string]: any;
67123
- }
67124
67650
  export declare class ImageLinkElementItem extends BaseOnPageLinkItemInfo implements IImageLinkElementItem {
67125
67651
  /** referring domain
67126
67652
  the link was found on this domain */
@@ -67227,6 +67753,52 @@ status code of the page to which the link is pointing */
67227
67753
  page_to_status_code?: number | undefined;
67228
67754
  [key: string]: any;
67229
67755
  }
67756
+ export declare class OnPageLinksResultInfo implements IOnPageLinksResultInfo {
67757
+ /** status of the crawling session
67758
+ possible values: in_progress, finished */
67759
+ crawl_progress?: string | undefined;
67760
+ /** details of the crawling session */
67761
+ crawl_status?: CrawlStatusInfo | undefined;
67762
+ /** total number of relevant items in the database */
67763
+ total_items_count?: number | undefined;
67764
+ /** number of items in the results array */
67765
+ items_count?: number | undefined;
67766
+ /** items array */
67767
+ items?: (BaseOnPageLinkItemInfo | undefined)[] | undefined;
67768
+ [key: string]: any;
67769
+ constructor(data?: IOnPageLinksResultInfo);
67770
+ init(_data?: any): void;
67771
+ static fromJS(data: any): OnPageLinksResultInfo;
67772
+ toJSON(data?: any): any;
67773
+ }
67774
+ export interface IOnPageLinksResultInfo {
67775
+ /** status of the crawling session
67776
+ possible values: in_progress, finished */
67777
+ crawl_progress?: string | undefined;
67778
+ /** details of the crawling session */
67779
+ crawl_status?: CrawlStatusInfo | undefined;
67780
+ /** total number of relevant items in the database */
67781
+ total_items_count?: number | undefined;
67782
+ /** number of items in the results array */
67783
+ items_count?: number | undefined;
67784
+ /** items array */
67785
+ items?: (BaseOnPageLinkItemInfo | undefined)[] | undefined;
67786
+ [key: string]: any;
67787
+ }
67788
+ export declare class OnPageLinksTaskInfo extends BaseResponseTaskInfo implements IOnPageLinksTaskInfo {
67789
+ /** array of results */
67790
+ result?: (OnPageLinksResultInfo | undefined)[] | undefined;
67791
+ [key: string]: any;
67792
+ constructor(data?: IOnPageLinksTaskInfo);
67793
+ init(_data?: any): void;
67794
+ static fromJS(data: any): OnPageLinksTaskInfo;
67795
+ toJSON(data?: any): any;
67796
+ }
67797
+ export interface IOnPageLinksTaskInfo extends IBaseResponseTaskInfo {
67798
+ /** array of results */
67799
+ result?: (OnPageLinksResultInfo | undefined)[] | undefined;
67800
+ [key: string]: any;
67801
+ }
67230
67802
  export declare class AlternateLinkElementItem extends BaseOnPageLinkItemInfo implements IAlternateLinkElementItem {
67231
67803
  /** referring domain
67232
67804
  the link was found on this domain */
@@ -69196,10 +69768,10 @@ export interface IOnPageContentParsingLiveResponseInfo extends IBaseResponseInfo
69196
69768
  export declare class OnPageInstantPagesRequestInfo implements IOnPageInstantPagesRequestInfo {
69197
69769
  /** target page url
69198
69770
  required field
69199
- absolute URL of the target page
69200
- Note: results will be returned for the specified URL only
69201
- Note: to prevent denial-of-service events, tasks that contain a duplicate crawl host will be returned with a 40501 error;
69202
- to prevent this error from occuring, avoid setting tasks with the same domain if at least one of your previous tasks with this domain (including a page URL on the domain) is still in a crawling queue */
69771
+ absolute URL of the target page;
69772
+ Note #1: results will be returned for the specified URL only;
69773
+ Note #2: to prevent denial-of-service events, tasks that contain a duplicate crawl host will be returned with a 40501 error;
69774
+ to prevent this error from occurring, avoid setting tasks with the same domain if at least one of your previous tasks with this domain (including a page URL on the domain) is still in a crawling queue */
69203
69775
  url?: string;
69204
69776
  /** custom user agent
69205
69777
  optional field
@@ -69322,10 +69894,10 @@ Note: only integer threshold values can be modified; */
69322
69894
  export interface IOnPageInstantPagesRequestInfo {
69323
69895
  /** target page url
69324
69896
  required field
69325
- absolute URL of the target page
69326
- Note: results will be returned for the specified URL only
69327
- Note: to prevent denial-of-service events, tasks that contain a duplicate crawl host will be returned with a 40501 error;
69328
- to prevent this error from occuring, avoid setting tasks with the same domain if at least one of your previous tasks with this domain (including a page URL on the domain) is still in a crawling queue */
69897
+ absolute URL of the target page;
69898
+ Note #1: results will be returned for the specified URL only;
69899
+ Note #2: to prevent denial-of-service events, tasks that contain a duplicate crawl host will be returned with a 40501 error;
69900
+ to prevent this error from occurring, avoid setting tasks with the same domain if at least one of your previous tasks with this domain (including a page URL on the domain) is still in a crawling queue */
69329
69901
  url?: string;
69330
69902
  /** custom user agent
69331
69903
  optional field
@@ -70503,7 +71075,7 @@ default value: as_is */
70503
71075
  /** the maximum number of returned citations
70504
71076
  optional field
70505
71077
  default value: 100
70506
- maximum value: 20000 */
71078
+ maximum value: 1000 */
70507
71079
  limit?: number | undefined;
70508
71080
  /** array of results filtering parameters
70509
71081
  optional field
@@ -70603,7 +71175,7 @@ default value: as_is */
70603
71175
  /** the maximum number of returned citations
70604
71176
  optional field
70605
71177
  default value: 100
70606
- maximum value: 20000 */
71178
+ maximum value: 1000 */
70607
71179
  limit?: number | undefined;
70608
71180
  /** array of results filtering parameters
70609
71181
  optional field
@@ -74373,46 +74945,6 @@ export interface IMerchantGoogleProductsTasksReadyResponseInfo extends IBaseResp
74373
74945
  tasks?: (MerchantGoogleProductsTasksReadyTaskInfo | undefined)[] | undefined;
74374
74946
  [key: string]: any;
74375
74947
  }
74376
- export declare class RatingElement implements IRatingElement {
74377
- /** type of element */
74378
- type?: string | undefined;
74379
- /** the alignment of the element in Google Shopping SERP
74380
- possible values:
74381
- left, right */
74382
- position?: string | undefined;
74383
- /** the type of rating
74384
- here you can find the following elements: Max5, Percents, CustomMax */
74385
- rating_type?: string | undefined;
74386
- /** value of the rating */
74387
- value?: string | undefined;
74388
- /** the amount of feedback */
74389
- votes_count?: number | undefined;
74390
- /** the maximum value for a rating_type */
74391
- rating_max?: number | undefined;
74392
- [key: string]: any;
74393
- constructor(data?: IRatingElement);
74394
- init(_data?: any): void;
74395
- static fromJS(data: any): RatingElement;
74396
- toJSON(data?: any): any;
74397
- }
74398
- export interface IRatingElement {
74399
- /** type of element */
74400
- type?: string | undefined;
74401
- /** the alignment of the element in Google Shopping SERP
74402
- possible values:
74403
- left, right */
74404
- position?: string | undefined;
74405
- /** the type of rating
74406
- here you can find the following elements: Max5, Percents, CustomMax */
74407
- rating_type?: string | undefined;
74408
- /** value of the rating */
74409
- value?: string | undefined;
74410
- /** the amount of feedback */
74411
- votes_count?: number | undefined;
74412
- /** the maximum value for a rating_type */
74413
- rating_max?: number | undefined;
74414
- [key: string]: any;
74415
- }
74416
74948
  export declare class DeliveryInfo implements IDeliveryInfo {
74417
74949
  /** delivery information
74418
74950
  message accompanying the delivery information as posted by the seller */
@@ -82753,7 +83285,8 @@ required field if you don’t specify location_name or location_code
82753
83285
  if you use this field, you don’t need to specify location_name or location_code
82754
83286
  location_coordinate parameter should be specified in the “latitude,longitude,radius” format
82755
83287
  the maximum number of decimal digits for “latitude” and “longitude”: 7
82756
- the minimum value for “radius”: 199.9
83288
+ the minimum value for “radius”: 199.9 (mm)
83289
+ the maximum value for “radius”: 199999 (mm)
82757
83290
  example:
82758
83291
  53.476225,-2.243572,200 */
82759
83292
  location_coordinate?: string | undefined;
@@ -82847,7 +83380,8 @@ required field if you don’t specify location_name or location_code
82847
83380
  if you use this field, you don’t need to specify location_name or location_code
82848
83381
  location_coordinate parameter should be specified in the “latitude,longitude,radius” format
82849
83382
  the maximum number of decimal digits for “latitude” and “longitude”: 7
82850
- the minimum value for “radius”: 199.9
83383
+ the minimum value for “radius”: 199.9 (mm)
83384
+ the maximum value for “radius”: 199999 (mm)
82851
83385
  example:
82852
83386
  53.476225,-2.243572,200 */
82853
83387
  location_coordinate?: string | undefined;
@@ -94026,6 +94560,7 @@ export declare class AppendixBacklinksLimitsRatesDataInfo implements IAppendixBa
94026
94560
  timeseries_summary?: AppendixFunctionInfo | undefined;
94027
94561
  timeseries_new_lost_summary?: AppendixFunctionInfo | undefined;
94028
94562
  competitors?: AppendixFunctionInfo | undefined;
94563
+ bulk_pages_summary?: AppendixFunctionInfo | undefined;
94029
94564
  [key: string]: any;
94030
94565
  constructor(data?: IAppendixBacklinksLimitsRatesDataInfo);
94031
94566
  init(_data?: any): void;
@@ -94053,6 +94588,7 @@ export interface IAppendixBacklinksLimitsRatesDataInfo {
94053
94588
  timeseries_summary?: AppendixFunctionInfo | undefined;
94054
94589
  timeseries_new_lost_summary?: AppendixFunctionInfo | undefined;
94055
94590
  competitors?: AppendixFunctionInfo | undefined;
94591
+ bulk_pages_summary?: AppendixFunctionInfo | undefined;
94056
94592
  [key: string]: any;
94057
94593
  }
94058
94594
  export declare class AppendixAppDataLimitsRatesDataInfo implements IAppendixAppDataLimitsRatesDataInfo {
@@ -94855,8 +95391,8 @@ export interface IAppendixMerchantPriceData {
94855
95391
  }
94856
95392
  export declare class AppendixSerpPriceDataInfo implements IAppendixSerpPriceDataInfo {
94857
95393
  advanced?: AppendixTaskKeywordsDataPriceDataInfo | undefined;
94858
- regular?: AppendixTaskKeywordsDataPriceDataInfo | undefined;
94859
95394
  html?: AppendixTaskKeywordsDataPriceDataInfo | undefined;
95395
+ regular?: AppendixTaskKeywordsDataPriceDataInfo | undefined;
94860
95396
  [key: string]: any;
94861
95397
  constructor(data?: IAppendixSerpPriceDataInfo);
94862
95398
  init(_data?: any): void;
@@ -94865,8 +95401,8 @@ export declare class AppendixSerpPriceDataInfo implements IAppendixSerpPriceData
94865
95401
  }
94866
95402
  export interface IAppendixSerpPriceDataInfo {
94867
95403
  advanced?: AppendixTaskKeywordsDataPriceDataInfo | undefined;
94868
- regular?: AppendixTaskKeywordsDataPriceDataInfo | undefined;
94869
95404
  html?: AppendixTaskKeywordsDataPriceDataInfo | undefined;
95405
+ regular?: AppendixTaskKeywordsDataPriceDataInfo | undefined;
94870
95406
  [key: string]: any;
94871
95407
  }
94872
95408
  export declare class AppendixSerpPriceData implements IAppendixSerpPriceData {
@@ -94945,6 +95481,7 @@ export declare class AppendixBacklinksPriceData implements IAppendixBacklinksPri
94945
95481
  bulk_backlinks?: AppendixKeywordBingKeywordsDataPriceDataInfo | undefined;
94946
95482
  bulk_new_lost_backlinks?: AppendixKeywordBingKeywordsDataPriceDataInfo | undefined;
94947
95483
  bulk_new_lost_referring_domains?: AppendixKeywordBingKeywordsDataPriceDataInfo | undefined;
95484
+ bulk_pages_summary?: AppendixKeywordBingKeywordsDataPriceDataInfo | undefined;
94948
95485
  bulk_ranks?: AppendixKeywordBingKeywordsDataPriceDataInfo | undefined;
94949
95486
  bulk_referring_domains?: AppendixKeywordBingKeywordsDataPriceDataInfo | undefined;
94950
95487
  competitors?: AppendixKeywordBingKeywordsDataPriceDataInfo | undefined;
@@ -94972,6 +95509,7 @@ export interface IAppendixBacklinksPriceData {
94972
95509
  bulk_backlinks?: AppendixKeywordBingKeywordsDataPriceDataInfo | undefined;
94973
95510
  bulk_new_lost_backlinks?: AppendixKeywordBingKeywordsDataPriceDataInfo | undefined;
94974
95511
  bulk_new_lost_referring_domains?: AppendixKeywordBingKeywordsDataPriceDataInfo | undefined;
95512
+ bulk_pages_summary?: AppendixKeywordBingKeywordsDataPriceDataInfo | undefined;
94975
95513
  bulk_ranks?: AppendixKeywordBingKeywordsDataPriceDataInfo | undefined;
94976
95514
  bulk_referring_domains?: AppendixKeywordBingKeywordsDataPriceDataInfo | undefined;
94977
95515
  competitors?: AppendixKeywordBingKeywordsDataPriceDataInfo | undefined;
@@ -95100,8 +95638,8 @@ export declare class AppendixBusinessDataPriceData implements IAppendixBusinessD
95100
95638
  google?: AppendixGoogleBusinessDataPriceData | undefined;
95101
95639
  languages?: AppendixTaskKeywordsDataPriceDataInfo | undefined;
95102
95640
  locations?: AppendixTaskKeywordsDataPriceDataInfo | undefined;
95103
- trustpilot?: AppendixTrBusinessDataPriceDataInfo | undefined;
95104
95641
  tripadvisor?: AppendixTrBusinessDataPriceDataInfo | undefined;
95642
+ trustpilot?: AppendixTrBusinessDataPriceDataInfo | undefined;
95105
95643
  yelp?: AppendixTrBusinessDataPriceDataInfo | undefined;
95106
95644
  [key: string]: any;
95107
95645
  constructor(data?: IAppendixBusinessDataPriceData);
@@ -95116,8 +95654,8 @@ export interface IAppendixBusinessDataPriceData {
95116
95654
  google?: AppendixGoogleBusinessDataPriceData | undefined;
95117
95655
  languages?: AppendixTaskKeywordsDataPriceDataInfo | undefined;
95118
95656
  locations?: AppendixTaskKeywordsDataPriceDataInfo | undefined;
95119
- trustpilot?: AppendixTrBusinessDataPriceDataInfo | undefined;
95120
95657
  tripadvisor?: AppendixTrBusinessDataPriceDataInfo | undefined;
95658
+ trustpilot?: AppendixTrBusinessDataPriceDataInfo | undefined;
95121
95659
  yelp?: AppendixTrBusinessDataPriceDataInfo | undefined;
95122
95660
  [key: string]: any;
95123
95661
  }