dataforseo-client 1.0.11 → 1.0.13
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.
- package/main.d.ts +828 -360
- package/main.js +839 -413
- package/main.js.map +1 -1
- package/main.ts +1562 -694
- 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;
|
|
@@ -13837,7 +13883,8 @@ top_stories, news_search */
|
|
|
13837
13883
|
se_results_count?: number | undefined;
|
|
13838
13884
|
/** the number of results returned in the items array */
|
|
13839
13885
|
items_count?: number | undefined;
|
|
13840
|
-
/**
|
|
13886
|
+
/** additional items present in the element
|
|
13887
|
+
if there are none, equals null */
|
|
13841
13888
|
items?: (BaseSerpElementItem | undefined)[] | undefined;
|
|
13842
13889
|
[key: string]: any;
|
|
13843
13890
|
constructor(data?: ISerpGoogleNewsLiveAdvancedResultInfo);
|
|
@@ -13877,7 +13924,8 @@ top_stories, news_search */
|
|
|
13877
13924
|
se_results_count?: number | undefined;
|
|
13878
13925
|
/** the number of results returned in the items array */
|
|
13879
13926
|
items_count?: number | undefined;
|
|
13880
|
-
/**
|
|
13927
|
+
/** additional items present in the element
|
|
13928
|
+
if there are none, equals null */
|
|
13881
13929
|
items?: (BaseSerpElementItem | undefined)[] | undefined;
|
|
13882
13930
|
[key: string]: any;
|
|
13883
13931
|
}
|
|
@@ -24109,8 +24157,7 @@ featured_snippet, images, local_pack, hotels_pack, organic, paid, people_also_as
|
|
|
24109
24157
|
se_results_count?: number | undefined;
|
|
24110
24158
|
/** the number of results returned in the items array */
|
|
24111
24159
|
items_count?: number | undefined;
|
|
24112
|
-
/**
|
|
24113
|
-
if there are none, equals null */
|
|
24160
|
+
/** items featured in the faq_box */
|
|
24114
24161
|
items?: (BaseSerpElementItem | undefined)[] | undefined;
|
|
24115
24162
|
[key: string]: any;
|
|
24116
24163
|
constructor(data?: ISerpYahooOrganicLiveAdvancedResultInfo);
|
|
@@ -24150,8 +24197,7 @@ featured_snippet, images, local_pack, hotels_pack, organic, paid, people_also_as
|
|
|
24150
24197
|
se_results_count?: number | undefined;
|
|
24151
24198
|
/** the number of results returned in the items array */
|
|
24152
24199
|
items_count?: number | undefined;
|
|
24153
|
-
/**
|
|
24154
|
-
if there are none, equals null */
|
|
24200
|
+
/** items featured in the faq_box */
|
|
24155
24201
|
items?: (BaseSerpElementItem | undefined)[] | undefined;
|
|
24156
24202
|
[key: string]: any;
|
|
24157
24203
|
}
|
|
@@ -34421,7 +34467,7 @@ the popularity rate based on reviews and displayed in SERP */
|
|
|
34421
34467
|
/** sitelinks
|
|
34422
34468
|
the links shown below some of Google’s search results
|
|
34423
34469
|
if there are none, equals null */
|
|
34424
|
-
links?:
|
|
34470
|
+
links?: (AdLinkElement | undefined)[] | undefined;
|
|
34425
34471
|
/** contains information from the ‘About this result’ panel
|
|
34426
34472
|
‘About this result’ panel provides additional context about why Google returned this result for the given query;
|
|
34427
34473
|
this feature appears after clicking on the three dots next to most results */
|
|
@@ -34507,7 +34553,7 @@ the popularity rate based on reviews and displayed in SERP */
|
|
|
34507
34553
|
/** sitelinks
|
|
34508
34554
|
the links shown below some of Google’s search results
|
|
34509
34555
|
if there are none, equals null */
|
|
34510
|
-
links?:
|
|
34556
|
+
links?: (AdLinkElement | undefined)[] | undefined;
|
|
34511
34557
|
/** contains information from the ‘About this result’ panel
|
|
34512
34558
|
‘About this result’ panel provides additional context about why Google returned this result for the given query;
|
|
34513
34559
|
this feature appears after clicking on the three dots next to most results */
|
|
@@ -34639,6 +34685,140 @@ export interface IDataforseoLabsGoogleRankedKeywordsLiveItem {
|
|
|
34639
34685
|
ranked_serp_element?: RankedSerpElement | undefined;
|
|
34640
34686
|
[key: string]: any;
|
|
34641
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
|
+
}
|
|
34642
34822
|
export declare class DataforseoLabsGoogleRankedKeywordsLiveResultInfo implements IDataforseoLabsGoogleRankedKeywordsLiveResultInfo {
|
|
34643
34823
|
/** search engine type */
|
|
34644
34824
|
se_type?: string | undefined;
|
|
@@ -38227,140 +38407,6 @@ kc:/shopping/gpc:organic-offers */
|
|
|
38227
38407
|
items?: (KnowledgeGraphShoppingElement | undefined)[] | undefined;
|
|
38228
38408
|
[key: string]: any;
|
|
38229
38409
|
}
|
|
38230
|
-
export declare class PaidDataforseoLabsSerpElementItem extends BaseDataforseoLabsSerpElementItem implements IPaidDataforseoLabsSerpElementItem {
|
|
38231
|
-
/** position within a group of elements with identical type values
|
|
38232
|
-
positions of elements with different type values are omitted from rank_group */
|
|
38233
|
-
rank_group?: number | undefined;
|
|
38234
|
-
/** absolute rank in SERP
|
|
38235
|
-
absolute position among all the elements in SERP */
|
|
38236
|
-
rank_absolute?: number | undefined;
|
|
38237
|
-
/** the alignment of the element in SERP
|
|
38238
|
-
can take the following values:
|
|
38239
|
-
left, right */
|
|
38240
|
-
position?: string | undefined;
|
|
38241
|
-
/** the XPath of the element */
|
|
38242
|
-
xpath?: string | undefined;
|
|
38243
|
-
/** title of the result in SERP */
|
|
38244
|
-
title?: string | undefined;
|
|
38245
|
-
/** domain where a link points */
|
|
38246
|
-
domain?: string | undefined;
|
|
38247
|
-
/** description of the results element in SERP */
|
|
38248
|
-
description?: string | undefined;
|
|
38249
|
-
/** breadcrumb of the Ad element in SERP */
|
|
38250
|
-
breadcrumb?: string | undefined;
|
|
38251
|
-
/** relevant URL of the Ad element in SERP */
|
|
38252
|
-
url?: string | undefined;
|
|
38253
|
-
/** words highlighted in bold within the results description */
|
|
38254
|
-
highlighted?: (string | undefined)[] | undefined;
|
|
38255
|
-
/** additional information about the result */
|
|
38256
|
-
extra?: {
|
|
38257
|
-
[key: string]: string;
|
|
38258
|
-
} | undefined;
|
|
38259
|
-
/** extended description
|
|
38260
|
-
if there is none, equals null */
|
|
38261
|
-
description_rows?: (string | undefined)[] | undefined;
|
|
38262
|
-
/** link of the element */
|
|
38263
|
-
links?: (AdLinkElement | undefined)[] | undefined;
|
|
38264
|
-
/** primary domain name in SERP */
|
|
38265
|
-
main_domain?: string | undefined;
|
|
38266
|
-
/** URL in SERP that does not specify the HTTPs protocol and domain name */
|
|
38267
|
-
relative_url?: string | undefined;
|
|
38268
|
-
/** estimated traffic volume
|
|
38269
|
-
estimated organic monthly traffic to the domain
|
|
38270
|
-
calculated as the product of CTR (click-through-rate) and search volume values of the returned keyword
|
|
38271
|
-
learn more about how the metric is calculated in this help center article */
|
|
38272
|
-
etv?: number | undefined;
|
|
38273
|
-
/** estimated traffic volume based on impressions
|
|
38274
|
-
estimated organic monthly traffic to the domain
|
|
38275
|
-
calculated as the product of CTR (click-through-rate) and impressions values of the returned keyword
|
|
38276
|
-
learn more about how the metric is calculated in this help center article */
|
|
38277
|
-
impressions_etv?: number | undefined;
|
|
38278
|
-
/** estimated cost of converting organic search traffic into paid
|
|
38279
|
-
represents the estimated monthly cost of running ads for the returned keyword
|
|
38280
|
-
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
|
|
38281
|
-
learn more about how the metric is calculated in this help center article */
|
|
38282
|
-
estimated_paid_traffic_cost?: number | undefined;
|
|
38283
|
-
/** changes in rankings
|
|
38284
|
-
ranking changes of the SERP element compared to the preceding month;
|
|
38285
|
-
Note: the changes are calculated even if the preceding month is not included in a POST request */
|
|
38286
|
-
rank_changes?: RankChanges | undefined;
|
|
38287
|
-
/** search engine type */
|
|
38288
|
-
se_type?: string | undefined;
|
|
38289
|
-
/** backlinks information for the target website */
|
|
38290
|
-
backlinks_info?: BacklinksInfo | undefined;
|
|
38291
|
-
/** page and domain rank information */
|
|
38292
|
-
rank_info?: RankInfo | undefined;
|
|
38293
|
-
[key: string]: any;
|
|
38294
|
-
constructor(data?: IPaidDataforseoLabsSerpElementItem);
|
|
38295
|
-
init(_data?: any): void;
|
|
38296
|
-
static fromJS(data: any): PaidDataforseoLabsSerpElementItem;
|
|
38297
|
-
toJSON(data?: any): any;
|
|
38298
|
-
}
|
|
38299
|
-
export interface IPaidDataforseoLabsSerpElementItem extends IBaseDataforseoLabsSerpElementItem {
|
|
38300
|
-
/** position within a group of elements with identical type values
|
|
38301
|
-
positions of elements with different type values are omitted from rank_group */
|
|
38302
|
-
rank_group?: number | undefined;
|
|
38303
|
-
/** absolute rank in SERP
|
|
38304
|
-
absolute position among all the elements in SERP */
|
|
38305
|
-
rank_absolute?: number | undefined;
|
|
38306
|
-
/** the alignment of the element in SERP
|
|
38307
|
-
can take the following values:
|
|
38308
|
-
left, right */
|
|
38309
|
-
position?: string | undefined;
|
|
38310
|
-
/** the XPath of the element */
|
|
38311
|
-
xpath?: string | undefined;
|
|
38312
|
-
/** title of the result in SERP */
|
|
38313
|
-
title?: string | undefined;
|
|
38314
|
-
/** domain where a link points */
|
|
38315
|
-
domain?: string | undefined;
|
|
38316
|
-
/** description of the results element in SERP */
|
|
38317
|
-
description?: string | undefined;
|
|
38318
|
-
/** breadcrumb of the Ad element in SERP */
|
|
38319
|
-
breadcrumb?: string | undefined;
|
|
38320
|
-
/** relevant URL of the Ad element in SERP */
|
|
38321
|
-
url?: string | undefined;
|
|
38322
|
-
/** words highlighted in bold within the results description */
|
|
38323
|
-
highlighted?: (string | undefined)[] | undefined;
|
|
38324
|
-
/** additional information about the result */
|
|
38325
|
-
extra?: {
|
|
38326
|
-
[key: string]: string;
|
|
38327
|
-
} | undefined;
|
|
38328
|
-
/** extended description
|
|
38329
|
-
if there is none, equals null */
|
|
38330
|
-
description_rows?: (string | undefined)[] | undefined;
|
|
38331
|
-
/** link of the element */
|
|
38332
|
-
links?: (AdLinkElement | undefined)[] | undefined;
|
|
38333
|
-
/** primary domain name in SERP */
|
|
38334
|
-
main_domain?: string | undefined;
|
|
38335
|
-
/** URL in SERP that does not specify the HTTPs protocol and domain name */
|
|
38336
|
-
relative_url?: string | undefined;
|
|
38337
|
-
/** estimated traffic volume
|
|
38338
|
-
estimated organic monthly traffic to the domain
|
|
38339
|
-
calculated as the product of CTR (click-through-rate) and search volume values of the returned keyword
|
|
38340
|
-
learn more about how the metric is calculated in this help center article */
|
|
38341
|
-
etv?: number | undefined;
|
|
38342
|
-
/** estimated traffic volume based on impressions
|
|
38343
|
-
estimated organic monthly traffic to the domain
|
|
38344
|
-
calculated as the product of CTR (click-through-rate) and impressions values of the returned keyword
|
|
38345
|
-
learn more about how the metric is calculated in this help center article */
|
|
38346
|
-
impressions_etv?: number | undefined;
|
|
38347
|
-
/** estimated cost of converting organic search traffic into paid
|
|
38348
|
-
represents the estimated monthly cost of running ads for the returned keyword
|
|
38349
|
-
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
|
|
38350
|
-
learn more about how the metric is calculated in this help center article */
|
|
38351
|
-
estimated_paid_traffic_cost?: number | undefined;
|
|
38352
|
-
/** changes in rankings
|
|
38353
|
-
ranking changes of the SERP element compared to the preceding month;
|
|
38354
|
-
Note: the changes are calculated even if the preceding month is not included in a POST request */
|
|
38355
|
-
rank_changes?: RankChanges | undefined;
|
|
38356
|
-
/** search engine type */
|
|
38357
|
-
se_type?: string | undefined;
|
|
38358
|
-
/** backlinks information for the target website */
|
|
38359
|
-
backlinks_info?: BacklinksInfo | undefined;
|
|
38360
|
-
/** page and domain rank information */
|
|
38361
|
-
rank_info?: RankInfo | undefined;
|
|
38362
|
-
[key: string]: any;
|
|
38363
|
-
}
|
|
38364
38410
|
export declare class GoogleReviewsDataforseoLabsSerpElementItem extends BaseDataforseoLabsSerpElementItem implements IGoogleReviewsDataforseoLabsSerpElementItem {
|
|
38365
38411
|
/** position within a group of elements with identical type values
|
|
38366
38412
|
positions of elements with different type values are omitted from rank_group */
|
|
@@ -57590,8 +57636,6 @@ indicates ISO country codes of the domains where the referring links are located
|
|
|
57590
57636
|
} | undefined;
|
|
57591
57637
|
/** number of referring pages pointing at least one nofollow link to the target */
|
|
57592
57638
|
referring_pages_nofollow?: number | undefined;
|
|
57593
|
-
/** number of nofollow backlinks pointing to the target */
|
|
57594
|
-
backlinks_nofollow?: number | undefined;
|
|
57595
57639
|
[key: string]: any;
|
|
57596
57640
|
constructor(data?: IBacklinksSummaryLiveResultInfo);
|
|
57597
57641
|
init(_data?: any): void;
|
|
@@ -57695,8 +57739,6 @@ indicates ISO country codes of the domains where the referring links are located
|
|
|
57695
57739
|
} | undefined;
|
|
57696
57740
|
/** number of referring pages pointing at least one nofollow link to the target */
|
|
57697
57741
|
referring_pages_nofollow?: number | undefined;
|
|
57698
|
-
/** number of nofollow backlinks pointing to the target */
|
|
57699
|
-
backlinks_nofollow?: number | undefined;
|
|
57700
57742
|
[key: string]: any;
|
|
57701
57743
|
}
|
|
57702
57744
|
export declare class BacklinksSummaryLiveTaskInfo extends BaseResponseTaskInfo implements IBacklinksSummaryLiveTaskInfo {
|
|
@@ -62463,6 +62505,11 @@ for example, if you specify:
|
|
|
62463
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
|
|
62464
62506
|
if there is no data for a certain day/week/month/year, we will return 0 */
|
|
62465
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;
|
|
62466
62513
|
/** user-defined task identifier
|
|
62467
62514
|
optional field
|
|
62468
62515
|
the character limit is 255
|
|
@@ -62513,6 +62560,11 @@ for example, if you specify:
|
|
|
62513
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
|
|
62514
62561
|
if there is no data for a certain day/week/month/year, we will return 0 */
|
|
62515
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;
|
|
62516
62568
|
/** user-defined task identifier
|
|
62517
62569
|
optional field
|
|
62518
62570
|
the character limit is 255
|
|
@@ -62709,6 +62761,11 @@ for example, if you specify:
|
|
|
62709
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
|
|
62710
62762
|
if there is no data for a certain day/week/month/year, we will return 0 */
|
|
62711
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;
|
|
62712
62769
|
/** user-defined task identifier
|
|
62713
62770
|
optional field
|
|
62714
62771
|
the character limit is 255
|
|
@@ -62761,6 +62818,11 @@ for example, if you specify:
|
|
|
62761
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
|
|
62762
62819
|
if there is no data for a certain day/week/month/year, we will return 0 */
|
|
62763
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;
|
|
62764
62826
|
/** user-defined task identifier
|
|
62765
62827
|
optional field
|
|
62766
62828
|
the character limit is 255
|
|
@@ -63749,6 +63811,446 @@ export interface IBacklinksBulkNewLostReferringDomainsLiveResponseInfo extends I
|
|
|
63749
63811
|
tasks?: (BacklinksBulkNewLostReferringDomainsLiveTaskInfo | undefined)[] | undefined;
|
|
63750
63812
|
[key: string]: any;
|
|
63751
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
|
+
}
|
|
63752
64254
|
export declare class OnPageIdListRequestInfo implements IOnPageIdListRequestInfo {
|
|
63753
64255
|
/** start time for filtering results
|
|
63754
64256
|
required field
|
|
@@ -66221,118 +66723,6 @@ the amount of time the browser needs to complete downloading a resource */
|
|
|
66221
66723
|
is_render_blocking?: boolean | undefined;
|
|
66222
66724
|
[key: string]: any;
|
|
66223
66725
|
}
|
|
66224
|
-
export declare class ScriptResourceElementItem extends BaseOnPageResourceItemInfo implements IScriptResourceElementItem {
|
|
66225
|
-
/** resource properties
|
|
66226
|
-
the value depends on the resource_type
|
|
66227
|
-
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;
|
|
66228
|
-
to obtain resource’s meta from a particular url, specify that URL when setting a task */
|
|
66229
|
-
meta?: ResourceMetaInfo | undefined;
|
|
66230
|
-
/** status code of the page where a given resource is located */
|
|
66231
|
-
status_code?: number | undefined;
|
|
66232
|
-
/** location header
|
|
66233
|
-
indicates the URL to redirect a page to */
|
|
66234
|
-
location?: string | undefined;
|
|
66235
|
-
/** resource URL */
|
|
66236
|
-
url?: string | undefined;
|
|
66237
|
-
/** resource size
|
|
66238
|
-
indicates the size of a given resource measured in bytes */
|
|
66239
|
-
size?: number | undefined;
|
|
66240
|
-
/** resource size after encoding
|
|
66241
|
-
indicates the size of the encoded resource measured in bytes */
|
|
66242
|
-
encoded_size?: number | undefined;
|
|
66243
|
-
/** compressed resource size
|
|
66244
|
-
indicates the compressed size of a given resource in bytes */
|
|
66245
|
-
total_transfer_size?: number | undefined;
|
|
66246
|
-
/** date and time when a resource was fetched
|
|
66247
|
-
in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”
|
|
66248
|
-
example:
|
|
66249
|
-
2021-02-17 13:54:15 +00:00 */
|
|
66250
|
-
fetch_time?: string | undefined;
|
|
66251
|
-
/** resource fething time range */
|
|
66252
|
-
fetch_timing?: FetchTiming | undefined;
|
|
66253
|
-
/** instructions for caching */
|
|
66254
|
-
cache_control?: CacheControl | undefined;
|
|
66255
|
-
/** resource check-ups
|
|
66256
|
-
contents of the array depend on the resource_type */
|
|
66257
|
-
checks?: {
|
|
66258
|
-
[key: string]: boolean;
|
|
66259
|
-
} | undefined;
|
|
66260
|
-
/** resource errors and warnings */
|
|
66261
|
-
resource_errors?: OnPageResourceIssueInfo | undefined;
|
|
66262
|
-
/** type of encoding */
|
|
66263
|
-
content_encoding?: string | undefined;
|
|
66264
|
-
/** types of media used to display a resource */
|
|
66265
|
-
media_type?: string | undefined;
|
|
66266
|
-
/** indicates the expected type of resource
|
|
66267
|
-
for example, if "resource_type": "broken", accept_type will indicate the type of the broken resource
|
|
66268
|
-
possible values:
|
|
66269
|
-
any, none, image, sitemap, robots, script, stylesheet, redirect, html, text, other, font */
|
|
66270
|
-
accept_type?: string | undefined;
|
|
66271
|
-
/** server version */
|
|
66272
|
-
server?: string | undefined;
|
|
66273
|
-
/** contains data on changes related to the resource
|
|
66274
|
-
if there is no data, the value will be null */
|
|
66275
|
-
last_modified?: LastModified | undefined;
|
|
66276
|
-
[key: string]: any;
|
|
66277
|
-
constructor(data?: IScriptResourceElementItem);
|
|
66278
|
-
init(_data?: any): void;
|
|
66279
|
-
static fromJS(data: any): ScriptResourceElementItem;
|
|
66280
|
-
toJSON(data?: any): any;
|
|
66281
|
-
}
|
|
66282
|
-
export interface IScriptResourceElementItem extends IBaseOnPageResourceItemInfo {
|
|
66283
|
-
/** resource properties
|
|
66284
|
-
the value depends on the resource_type
|
|
66285
|
-
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;
|
|
66286
|
-
to obtain resource’s meta from a particular url, specify that URL when setting a task */
|
|
66287
|
-
meta?: ResourceMetaInfo | undefined;
|
|
66288
|
-
/** status code of the page where a given resource is located */
|
|
66289
|
-
status_code?: number | undefined;
|
|
66290
|
-
/** location header
|
|
66291
|
-
indicates the URL to redirect a page to */
|
|
66292
|
-
location?: string | undefined;
|
|
66293
|
-
/** resource URL */
|
|
66294
|
-
url?: string | undefined;
|
|
66295
|
-
/** resource size
|
|
66296
|
-
indicates the size of a given resource measured in bytes */
|
|
66297
|
-
size?: number | undefined;
|
|
66298
|
-
/** resource size after encoding
|
|
66299
|
-
indicates the size of the encoded resource measured in bytes */
|
|
66300
|
-
encoded_size?: number | undefined;
|
|
66301
|
-
/** compressed resource size
|
|
66302
|
-
indicates the compressed size of a given resource in bytes */
|
|
66303
|
-
total_transfer_size?: number | undefined;
|
|
66304
|
-
/** date and time when a resource was fetched
|
|
66305
|
-
in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”
|
|
66306
|
-
example:
|
|
66307
|
-
2021-02-17 13:54:15 +00:00 */
|
|
66308
|
-
fetch_time?: string | undefined;
|
|
66309
|
-
/** resource fething time range */
|
|
66310
|
-
fetch_timing?: FetchTiming | undefined;
|
|
66311
|
-
/** instructions for caching */
|
|
66312
|
-
cache_control?: CacheControl | undefined;
|
|
66313
|
-
/** resource check-ups
|
|
66314
|
-
contents of the array depend on the resource_type */
|
|
66315
|
-
checks?: {
|
|
66316
|
-
[key: string]: boolean;
|
|
66317
|
-
} | undefined;
|
|
66318
|
-
/** resource errors and warnings */
|
|
66319
|
-
resource_errors?: OnPageResourceIssueInfo | undefined;
|
|
66320
|
-
/** type of encoding */
|
|
66321
|
-
content_encoding?: string | undefined;
|
|
66322
|
-
/** types of media used to display a resource */
|
|
66323
|
-
media_type?: string | undefined;
|
|
66324
|
-
/** indicates the expected type of resource
|
|
66325
|
-
for example, if "resource_type": "broken", accept_type will indicate the type of the broken resource
|
|
66326
|
-
possible values:
|
|
66327
|
-
any, none, image, sitemap, robots, script, stylesheet, redirect, html, text, other, font */
|
|
66328
|
-
accept_type?: string | undefined;
|
|
66329
|
-
/** server version */
|
|
66330
|
-
server?: string | undefined;
|
|
66331
|
-
/** contains data on changes related to the resource
|
|
66332
|
-
if there is no data, the value will be null */
|
|
66333
|
-
last_modified?: LastModified | undefined;
|
|
66334
|
-
[key: string]: any;
|
|
66335
|
-
}
|
|
66336
66726
|
export declare class OnPageResourcesResultInfo implements IOnPageResourcesResultInfo {
|
|
66337
66727
|
/** status of the crawling session
|
|
66338
66728
|
possible values: in_progress, finished */
|
|
@@ -66379,6 +66769,118 @@ export interface IOnPageResourcesTaskInfo extends IBaseResponseTaskInfo {
|
|
|
66379
66769
|
result?: (OnPageResourcesResultInfo | undefined)[] | undefined;
|
|
66380
66770
|
[key: string]: any;
|
|
66381
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
|
+
}
|
|
66382
66884
|
export declare class ImageResourceElementItem extends BaseOnPageResourceItemInfo implements IImageResourceElementItem {
|
|
66383
66885
|
/** resource properties
|
|
66384
66886
|
the value depends on the resource_type
|
|
@@ -67145,52 +67647,6 @@ status code of the page to which the link is pointing */
|
|
|
67145
67647
|
page_to_status_code?: number | undefined;
|
|
67146
67648
|
[key: string]: any;
|
|
67147
67649
|
}
|
|
67148
|
-
export declare class OnPageLinksResultInfo implements IOnPageLinksResultInfo {
|
|
67149
|
-
/** status of the crawling session
|
|
67150
|
-
possible values: in_progress, finished */
|
|
67151
|
-
crawl_progress?: string | undefined;
|
|
67152
|
-
/** details of the crawling session */
|
|
67153
|
-
crawl_status?: CrawlStatusInfo | undefined;
|
|
67154
|
-
/** total number of relevant items in the database */
|
|
67155
|
-
total_items_count?: number | undefined;
|
|
67156
|
-
/** number of items in the results array */
|
|
67157
|
-
items_count?: number | undefined;
|
|
67158
|
-
/** items array */
|
|
67159
|
-
items?: (BaseOnPageLinkItemInfo | undefined)[] | undefined;
|
|
67160
|
-
[key: string]: any;
|
|
67161
|
-
constructor(data?: IOnPageLinksResultInfo);
|
|
67162
|
-
init(_data?: any): void;
|
|
67163
|
-
static fromJS(data: any): OnPageLinksResultInfo;
|
|
67164
|
-
toJSON(data?: any): any;
|
|
67165
|
-
}
|
|
67166
|
-
export interface IOnPageLinksResultInfo {
|
|
67167
|
-
/** status of the crawling session
|
|
67168
|
-
possible values: in_progress, finished */
|
|
67169
|
-
crawl_progress?: string | undefined;
|
|
67170
|
-
/** details of the crawling session */
|
|
67171
|
-
crawl_status?: CrawlStatusInfo | undefined;
|
|
67172
|
-
/** total number of relevant items in the database */
|
|
67173
|
-
total_items_count?: number | undefined;
|
|
67174
|
-
/** number of items in the results array */
|
|
67175
|
-
items_count?: number | undefined;
|
|
67176
|
-
/** items array */
|
|
67177
|
-
items?: (BaseOnPageLinkItemInfo | undefined)[] | undefined;
|
|
67178
|
-
[key: string]: any;
|
|
67179
|
-
}
|
|
67180
|
-
export declare class OnPageLinksTaskInfo extends BaseResponseTaskInfo implements IOnPageLinksTaskInfo {
|
|
67181
|
-
/** array of results */
|
|
67182
|
-
result?: (OnPageLinksResultInfo | undefined)[] | undefined;
|
|
67183
|
-
[key: string]: any;
|
|
67184
|
-
constructor(data?: IOnPageLinksTaskInfo);
|
|
67185
|
-
init(_data?: any): void;
|
|
67186
|
-
static fromJS(data: any): OnPageLinksTaskInfo;
|
|
67187
|
-
toJSON(data?: any): any;
|
|
67188
|
-
}
|
|
67189
|
-
export interface IOnPageLinksTaskInfo extends IBaseResponseTaskInfo {
|
|
67190
|
-
/** array of results */
|
|
67191
|
-
result?: (OnPageLinksResultInfo | undefined)[] | undefined;
|
|
67192
|
-
[key: string]: any;
|
|
67193
|
-
}
|
|
67194
67650
|
export declare class ImageLinkElementItem extends BaseOnPageLinkItemInfo implements IImageLinkElementItem {
|
|
67195
67651
|
/** referring domain
|
|
67196
67652
|
the link was found on this domain */
|
|
@@ -67297,6 +67753,52 @@ status code of the page to which the link is pointing */
|
|
|
67297
67753
|
page_to_status_code?: number | undefined;
|
|
67298
67754
|
[key: string]: any;
|
|
67299
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
|
+
}
|
|
67300
67802
|
export declare class AlternateLinkElementItem extends BaseOnPageLinkItemInfo implements IAlternateLinkElementItem {
|
|
67301
67803
|
/** referring domain
|
|
67302
67804
|
the link was found on this domain */
|
|
@@ -69266,10 +69768,10 @@ export interface IOnPageContentParsingLiveResponseInfo extends IBaseResponseInfo
|
|
|
69266
69768
|
export declare class OnPageInstantPagesRequestInfo implements IOnPageInstantPagesRequestInfo {
|
|
69267
69769
|
/** target page url
|
|
69268
69770
|
required field
|
|
69269
|
-
absolute URL of the target page
|
|
69270
|
-
Note: results will be returned for the specified URL only
|
|
69271
|
-
Note: to prevent denial-of-service events, tasks that contain a duplicate crawl host will be returned with a 40501 error;
|
|
69272
|
-
to prevent this error from
|
|
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 */
|
|
69273
69775
|
url?: string;
|
|
69274
69776
|
/** custom user agent
|
|
69275
69777
|
optional field
|
|
@@ -69392,10 +69894,10 @@ Note: only integer threshold values can be modified; */
|
|
|
69392
69894
|
export interface IOnPageInstantPagesRequestInfo {
|
|
69393
69895
|
/** target page url
|
|
69394
69896
|
required field
|
|
69395
|
-
absolute URL of the target page
|
|
69396
|
-
Note: results will be returned for the specified URL only
|
|
69397
|
-
Note: to prevent denial-of-service events, tasks that contain a duplicate crawl host will be returned with a 40501 error;
|
|
69398
|
-
to prevent this error from
|
|
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 */
|
|
69399
69901
|
url?: string;
|
|
69400
69902
|
/** custom user agent
|
|
69401
69903
|
optional field
|
|
@@ -70573,7 +71075,7 @@ default value: as_is */
|
|
|
70573
71075
|
/** the maximum number of returned citations
|
|
70574
71076
|
optional field
|
|
70575
71077
|
default value: 100
|
|
70576
|
-
maximum value:
|
|
71078
|
+
maximum value: 1000 */
|
|
70577
71079
|
limit?: number | undefined;
|
|
70578
71080
|
/** array of results filtering parameters
|
|
70579
71081
|
optional field
|
|
@@ -70673,7 +71175,7 @@ default value: as_is */
|
|
|
70673
71175
|
/** the maximum number of returned citations
|
|
70674
71176
|
optional field
|
|
70675
71177
|
default value: 100
|
|
70676
|
-
maximum value:
|
|
71178
|
+
maximum value: 1000 */
|
|
70677
71179
|
limit?: number | undefined;
|
|
70678
71180
|
/** array of results filtering parameters
|
|
70679
71181
|
optional field
|
|
@@ -74443,46 +74945,6 @@ export interface IMerchantGoogleProductsTasksReadyResponseInfo extends IBaseResp
|
|
|
74443
74945
|
tasks?: (MerchantGoogleProductsTasksReadyTaskInfo | undefined)[] | undefined;
|
|
74444
74946
|
[key: string]: any;
|
|
74445
74947
|
}
|
|
74446
|
-
export declare class RatingElement implements IRatingElement {
|
|
74447
|
-
/** type of element */
|
|
74448
|
-
type?: string | undefined;
|
|
74449
|
-
/** the alignment of the element in Google Shopping SERP
|
|
74450
|
-
possible values:
|
|
74451
|
-
left, right */
|
|
74452
|
-
position?: string | undefined;
|
|
74453
|
-
/** the type of rating
|
|
74454
|
-
here you can find the following elements: Max5, Percents, CustomMax */
|
|
74455
|
-
rating_type?: string | undefined;
|
|
74456
|
-
/** value of the rating */
|
|
74457
|
-
value?: string | undefined;
|
|
74458
|
-
/** the amount of feedback */
|
|
74459
|
-
votes_count?: number | undefined;
|
|
74460
|
-
/** the maximum value for a rating_type */
|
|
74461
|
-
rating_max?: number | undefined;
|
|
74462
|
-
[key: string]: any;
|
|
74463
|
-
constructor(data?: IRatingElement);
|
|
74464
|
-
init(_data?: any): void;
|
|
74465
|
-
static fromJS(data: any): RatingElement;
|
|
74466
|
-
toJSON(data?: any): any;
|
|
74467
|
-
}
|
|
74468
|
-
export interface IRatingElement {
|
|
74469
|
-
/** type of element */
|
|
74470
|
-
type?: string | undefined;
|
|
74471
|
-
/** the alignment of the element in Google Shopping SERP
|
|
74472
|
-
possible values:
|
|
74473
|
-
left, right */
|
|
74474
|
-
position?: string | undefined;
|
|
74475
|
-
/** the type of rating
|
|
74476
|
-
here you can find the following elements: Max5, Percents, CustomMax */
|
|
74477
|
-
rating_type?: string | undefined;
|
|
74478
|
-
/** value of the rating */
|
|
74479
|
-
value?: string | undefined;
|
|
74480
|
-
/** the amount of feedback */
|
|
74481
|
-
votes_count?: number | undefined;
|
|
74482
|
-
/** the maximum value for a rating_type */
|
|
74483
|
-
rating_max?: number | undefined;
|
|
74484
|
-
[key: string]: any;
|
|
74485
|
-
}
|
|
74486
74948
|
export declare class DeliveryInfo implements IDeliveryInfo {
|
|
74487
74949
|
/** delivery information
|
|
74488
74950
|
message accompanying the delivery information as posted by the seller */
|
|
@@ -82823,7 +83285,8 @@ required field if you don’t specify location_name or location_code
|
|
|
82823
83285
|
if you use this field, you don’t need to specify location_name or location_code
|
|
82824
83286
|
location_coordinate parameter should be specified in the “latitude,longitude,radius” format
|
|
82825
83287
|
the maximum number of decimal digits for “latitude” and “longitude”: 7
|
|
82826
|
-
the minimum value for “radius”: 199.9
|
|
83288
|
+
the minimum value for “radius”: 199.9 (mm)
|
|
83289
|
+
the maximum value for “radius”: 199999 (mm)
|
|
82827
83290
|
example:
|
|
82828
83291
|
53.476225,-2.243572,200 */
|
|
82829
83292
|
location_coordinate?: string | undefined;
|
|
@@ -82917,7 +83380,8 @@ required field if you don’t specify location_name or location_code
|
|
|
82917
83380
|
if you use this field, you don’t need to specify location_name or location_code
|
|
82918
83381
|
location_coordinate parameter should be specified in the “latitude,longitude,radius” format
|
|
82919
83382
|
the maximum number of decimal digits for “latitude” and “longitude”: 7
|
|
82920
|
-
the minimum value for “radius”: 199.9
|
|
83383
|
+
the minimum value for “radius”: 199.9 (mm)
|
|
83384
|
+
the maximum value for “radius”: 199999 (mm)
|
|
82921
83385
|
example:
|
|
82922
83386
|
53.476225,-2.243572,200 */
|
|
82923
83387
|
location_coordinate?: string | undefined;
|
|
@@ -94096,6 +94560,7 @@ export declare class AppendixBacklinksLimitsRatesDataInfo implements IAppendixBa
|
|
|
94096
94560
|
timeseries_summary?: AppendixFunctionInfo | undefined;
|
|
94097
94561
|
timeseries_new_lost_summary?: AppendixFunctionInfo | undefined;
|
|
94098
94562
|
competitors?: AppendixFunctionInfo | undefined;
|
|
94563
|
+
bulk_pages_summary?: AppendixFunctionInfo | undefined;
|
|
94099
94564
|
[key: string]: any;
|
|
94100
94565
|
constructor(data?: IAppendixBacklinksLimitsRatesDataInfo);
|
|
94101
94566
|
init(_data?: any): void;
|
|
@@ -94123,6 +94588,7 @@ export interface IAppendixBacklinksLimitsRatesDataInfo {
|
|
|
94123
94588
|
timeseries_summary?: AppendixFunctionInfo | undefined;
|
|
94124
94589
|
timeseries_new_lost_summary?: AppendixFunctionInfo | undefined;
|
|
94125
94590
|
competitors?: AppendixFunctionInfo | undefined;
|
|
94591
|
+
bulk_pages_summary?: AppendixFunctionInfo | undefined;
|
|
94126
94592
|
[key: string]: any;
|
|
94127
94593
|
}
|
|
94128
94594
|
export declare class AppendixAppDataLimitsRatesDataInfo implements IAppendixAppDataLimitsRatesDataInfo {
|
|
@@ -94925,8 +95391,8 @@ export interface IAppendixMerchantPriceData {
|
|
|
94925
95391
|
}
|
|
94926
95392
|
export declare class AppendixSerpPriceDataInfo implements IAppendixSerpPriceDataInfo {
|
|
94927
95393
|
advanced?: AppendixTaskKeywordsDataPriceDataInfo | undefined;
|
|
94928
|
-
regular?: AppendixTaskKeywordsDataPriceDataInfo | undefined;
|
|
94929
95394
|
html?: AppendixTaskKeywordsDataPriceDataInfo | undefined;
|
|
95395
|
+
regular?: AppendixTaskKeywordsDataPriceDataInfo | undefined;
|
|
94930
95396
|
[key: string]: any;
|
|
94931
95397
|
constructor(data?: IAppendixSerpPriceDataInfo);
|
|
94932
95398
|
init(_data?: any): void;
|
|
@@ -94935,8 +95401,8 @@ export declare class AppendixSerpPriceDataInfo implements IAppendixSerpPriceData
|
|
|
94935
95401
|
}
|
|
94936
95402
|
export interface IAppendixSerpPriceDataInfo {
|
|
94937
95403
|
advanced?: AppendixTaskKeywordsDataPriceDataInfo | undefined;
|
|
94938
|
-
regular?: AppendixTaskKeywordsDataPriceDataInfo | undefined;
|
|
94939
95404
|
html?: AppendixTaskKeywordsDataPriceDataInfo | undefined;
|
|
95405
|
+
regular?: AppendixTaskKeywordsDataPriceDataInfo | undefined;
|
|
94940
95406
|
[key: string]: any;
|
|
94941
95407
|
}
|
|
94942
95408
|
export declare class AppendixSerpPriceData implements IAppendixSerpPriceData {
|
|
@@ -95015,6 +95481,7 @@ export declare class AppendixBacklinksPriceData implements IAppendixBacklinksPri
|
|
|
95015
95481
|
bulk_backlinks?: AppendixKeywordBingKeywordsDataPriceDataInfo | undefined;
|
|
95016
95482
|
bulk_new_lost_backlinks?: AppendixKeywordBingKeywordsDataPriceDataInfo | undefined;
|
|
95017
95483
|
bulk_new_lost_referring_domains?: AppendixKeywordBingKeywordsDataPriceDataInfo | undefined;
|
|
95484
|
+
bulk_pages_summary?: AppendixKeywordBingKeywordsDataPriceDataInfo | undefined;
|
|
95018
95485
|
bulk_ranks?: AppendixKeywordBingKeywordsDataPriceDataInfo | undefined;
|
|
95019
95486
|
bulk_referring_domains?: AppendixKeywordBingKeywordsDataPriceDataInfo | undefined;
|
|
95020
95487
|
competitors?: AppendixKeywordBingKeywordsDataPriceDataInfo | undefined;
|
|
@@ -95042,6 +95509,7 @@ export interface IAppendixBacklinksPriceData {
|
|
|
95042
95509
|
bulk_backlinks?: AppendixKeywordBingKeywordsDataPriceDataInfo | undefined;
|
|
95043
95510
|
bulk_new_lost_backlinks?: AppendixKeywordBingKeywordsDataPriceDataInfo | undefined;
|
|
95044
95511
|
bulk_new_lost_referring_domains?: AppendixKeywordBingKeywordsDataPriceDataInfo | undefined;
|
|
95512
|
+
bulk_pages_summary?: AppendixKeywordBingKeywordsDataPriceDataInfo | undefined;
|
|
95045
95513
|
bulk_ranks?: AppendixKeywordBingKeywordsDataPriceDataInfo | undefined;
|
|
95046
95514
|
bulk_referring_domains?: AppendixKeywordBingKeywordsDataPriceDataInfo | undefined;
|
|
95047
95515
|
competitors?: AppendixKeywordBingKeywordsDataPriceDataInfo | undefined;
|
|
@@ -95170,8 +95638,8 @@ export declare class AppendixBusinessDataPriceData implements IAppendixBusinessD
|
|
|
95170
95638
|
google?: AppendixGoogleBusinessDataPriceData | undefined;
|
|
95171
95639
|
languages?: AppendixTaskKeywordsDataPriceDataInfo | undefined;
|
|
95172
95640
|
locations?: AppendixTaskKeywordsDataPriceDataInfo | undefined;
|
|
95173
|
-
trustpilot?: AppendixTrBusinessDataPriceDataInfo | undefined;
|
|
95174
95641
|
tripadvisor?: AppendixTrBusinessDataPriceDataInfo | undefined;
|
|
95642
|
+
trustpilot?: AppendixTrBusinessDataPriceDataInfo | undefined;
|
|
95175
95643
|
yelp?: AppendixTrBusinessDataPriceDataInfo | undefined;
|
|
95176
95644
|
[key: string]: any;
|
|
95177
95645
|
constructor(data?: IAppendixBusinessDataPriceData);
|
|
@@ -95186,8 +95654,8 @@ export interface IAppendixBusinessDataPriceData {
|
|
|
95186
95654
|
google?: AppendixGoogleBusinessDataPriceData | undefined;
|
|
95187
95655
|
languages?: AppendixTaskKeywordsDataPriceDataInfo | undefined;
|
|
95188
95656
|
locations?: AppendixTaskKeywordsDataPriceDataInfo | undefined;
|
|
95189
|
-
trustpilot?: AppendixTrBusinessDataPriceDataInfo | undefined;
|
|
95190
95657
|
tripadvisor?: AppendixTrBusinessDataPriceDataInfo | undefined;
|
|
95658
|
+
trustpilot?: AppendixTrBusinessDataPriceDataInfo | undefined;
|
|
95191
95659
|
yelp?: AppendixTrBusinessDataPriceDataInfo | undefined;
|
|
95192
95660
|
[key: string]: any;
|
|
95193
95661
|
}
|